feat(data frame styles): Allow style "location" to not be required (posit-dev#1548)

Author: schloerke

.github/py-shiny/setup/action.yaml

@@ -21,6 +21,11 @@ runs:
         shell: bash
         run: python -m pip install --upgrade pip
 
+      - name: Pip list
+        shell: bash
+        run: |
+          pip list
+
       - name: Install dependencies
         shell: bash
         run: |
@@ -31,3 +36,14 @@ runs:
         shell: bash
         run: |
           make install
+
+      - name: Install backports.tarfile
+        if: ${{ startsWith(inputs.python-version, '3.8') }}
+        shell: bash
+        run: |
+          pip install backports.tarfile
+
+      - name: Pip list
+        shell: bash
+        run: |
+          pip list

shiny/api-examples/data_frame_styles/app-core.py

@@ -4,7 +4,6 @@
 
 green_styles = [
     {
-        "location": "body",
         "rows": [2, 4],
         "cols": [2, 4],
         "style": {
@@ -28,7 +27,6 @@
 
 hi_styles = [
     {
-        "location": "body",
         # No `rows` or `cols` means apply to all cells
         "class": "posit-bg",
         "style": {
@@ -37,7 +35,6 @@
         },
     },
     {
-        "location": "body",
         "rows": [3],
         "cols": [2],
         "class": "posit-blue-bg",
@@ -47,12 +44,10 @@
         },
     },
     {
-        "location": "body",
         "cols": [1, 3, 5],
         "class": "posit-blue-bg",
     },
     {
-        "location": "body",
         "cols": [7],
         "rows": [0, 1, 2, 3, 5],
         "class": "posit-orange-bg",

shiny/api-examples/data_frame_styles/app-express.py

@@ -4,7 +4,6 @@
 
 green_styles = [
     {
-        "location": "body",
         "rows": [2, 4],
         "cols": [2, 4],
         "style": {
@@ -59,7 +58,6 @@ def my_df():
 
 hi_styles = [
     {
-        "location": "body",
         # No `rows` or `cols` means apply to all cells
         "class": "posit-bg",
         "style": {
@@ -68,7 +66,6 @@ def my_df():
         },
     },
     {
-        "location": "body",
         "rows": [3],
         "cols": [2],
         "class": "posit-blue-bg",
@@ -78,12 +75,10 @@ def my_df():
         },
     },
     {
-        "location": "body",
         "cols": [1, 3, 5],
         "class": "posit-blue-bg",
     },
     {
-        "location": "body",
         "cols": [7],
         "rows": [0, 1, 2, 3, 5],
         "class": "posit-orange-bg",

shiny/render/_data_frame_utils/_datagridtable.py

@@ -84,7 +84,7 @@ class DataGrid(AbstractTabularData, Generic[DataFrameLikeT]):
         `styles=None`, no styling will be applied.
 
         Style info object key/value description:
-        * `location`: This value is required and currently only supports `"body"`.
+        * `location`: This value `"body"` and is not required.
         * `rows`: The row numbers to which the style should be applied. If `None`, the
             style will be applied to all rows.
         * `cols`: The column numbers to which the style should be applied. If `None`,
@@ -243,7 +243,7 @@ class DataTable(AbstractTabularData, Generic[DataFrameLikeT]):
         `styles=None`, no styling will be applied.
 
         Style info object key/value description:
-        * `location`: This value is required and currently only supports `"body"`.
+        * `location`: This value `"body"` and is not required.
         * `rows`: The row numbers to which the style should be applied. If `None`, the
             style will be applied to all rows.
         * `cols`: The column numbers to which the style should be applied. If `None`,

shiny/render/_data_frame_utils/_styles.py

@@ -19,8 +19,13 @@ def style_info_to_browser_style_info(
         raise TypeError("`StyleInfo` objects must be a dictionary. Received: ", info)
 
     location = info.get("location", None)
+    if location is None:
+        location = "body"
+
     if location != "body":
-        raise ValueError(f"Unsupported `StyleInfo` location: {location}")
+        raise ValueError(
+            f"`StyleInfo` `location` value must be 'body', not '{location}'"
+        )
 
     rows = style_info_rows(info, nrow=nrow)
     cols = style_info_cols(info, browser_column_names=browser_column_names)

shiny/render/_data_frame_utils/_types.py

@@ -208,7 +208,7 @@ class FrameDtypeCategories(TypedDict):
 StyleInfoBody = TypedDict(
     "StyleInfoBody",
     {
-        "location": Required[Literal["body"]],
+        "location": NotRequired[Literal["body"]],
         "rows": NotRequired[Union[int, ListOrTuple[int], ListOrTuple[bool], None]],
         "cols": NotRequired[
             Union[str, int, ListOrTuple[str], ListOrTuple[int], ListOrTuple[bool], None]

tests/playwright/shiny/components/data_frame/styles/app.py

@@ -51,17 +51,14 @@
 
 df_styles: list[render.StyleInfo] = [
     {
-        "location": "body",
         "style": {"color": "darkorange", "font-weight": "bold"},
     },
     {
-        "location": "body",
         "rows": None,
         "cols": None,
         "style": {"background-color": "lightblue"},
     },
     {
-        "location": "body",
         "rows": [1, 2],
         "cols": "Species",
         "style": {

tests/playwright/shiny/components/data_frame/styles/test_df_styles.py

@@ -22,7 +22,6 @@ def test_validate_column_labels(
 
     styles: list[dict[str, Jsonifiable]] = [
         {
-            "location": "body",
             "rows": [1, 2],
             "cols": [2],  # "Species",
             "style": {
@@ -32,19 +31,16 @@ def test_validate_column_labels(
             },
         },
         {
-            "location": "body",
             "rows": [2],
             "cols": [3],  # "Region",
             "style": {"background-color": "yellow"},
         },
         {
-            "location": "body",
             "rows": None,
             "cols": [4],  # "Island",
             "style": {"background-color": "red"},
         },
         {
-            "location": "body",
             "rows": [1],
             "cols": [4, 5],  # "Island", "Stage",
             "style": {"background-color": "green"},

tests/playwright/shiny/components/data_frame/styles_class/app.py

@@ -17,7 +17,6 @@
 
 df_styles: list[StyleInfo] = [
     {
-        "location": "body",
         "class": "everywhere",
     },
     {

tests/playwright/shiny/components/data_frame/styles_class/test_df_styles_class.py

@@ -16,12 +16,10 @@ def test_validate_column_labels(page: Page, local_app: ShinyAppProc) -> None:
 
     styles: list[dict[str, Jsonifiable]] = [
         {
-            "location": "body",
             "style": {"color": "darkorange", "font-weight": "bold"},
             "class": "everywhere",
         },
         {
-            "location": "body",
             "rows": [1, 2],
             "cols": [2],  # "Species",
             "class": "species",