Merge pull request #2094 from plotly/master-2.5.1

Version 2.5.1

Author: T4rk1n

CHANGELOG.md

@@ -2,13 +2,26 @@
 All notable changes to `dash` will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
+## [2.5.1] - 2022-06-13
+
+### Fixed
+
+- [#2087](https://github.com/plotly/dash/pull/2087) Fix bug [#2086](https://github.com/plotly/dash/issues/2086) in which using id as a key within a component's id breaks the new callback context's `args_grouping` function.
+- [#2084](https://github.com/plotly/dash/pull/2084) In dash 2.5.0, a default viewport meta tag was added as recommended for mobile-optimized sites by [mdn](https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag)
+This feature can be disabled by providing an empty viewport meta tag.  e.g. `app = Dash(meta_tags=[{"name": "viewport"}])`
+- [#2090](https://github.com/plotly/dash/pull/2090), [#2092](https://github.com/plotly/dash/pull/2092).  Fixed bug where the `path` to the `pages_folder` was incorrect on Windows.
+
+### Removed
+
+- [#2087](https://github.com/plotly/dash/pull/2087) Removed the undocumented callback context `args_grouping_values` property which was incompatible with pattern-matching callbacks.
+
 ## [2.5.0] - 2022-06-07
 
 ### Added
 
 - [#1947](https://github.com/plotly/dash/pull/1947)  Added `pages` - a better way to build multi-page apps. For more information see the [forum post.](https://community.plotly.com/t/introducing-dash-pages-a-dash-2-x-feature-preview/57775)
 - [#1965](https://github.com/plotly/dash/pull/1965) Add component as props.
-- [#2049](https://github.com/plotly/dash/pull/2043) Added `wait_for_class_to_equal` and `wait_for_contains_class` methods to `dash.testing`
+- [#2049](https://github.com/plotly/dash/pull/2049) Added `wait_for_class_to_equal` and `wait_for_contains_class` methods to `dash.testing`
 
 ### Changed
 

dash/_callback_context.py

@@ -1,11 +1,10 @@
 import functools
 import warnings
 import json
-from copy import deepcopy
 import flask
 
 from . import exceptions
-from ._utils import stringify_id, AttributeDict
+from ._utils import AttributeDict
 
 
 def has_context(func):
@@ -147,59 +146,7 @@ def display(btn1, btn2):
                return "No clicks yet"
 
         """
-        triggered = getattr(flask.g, "triggered_inputs", [])
-        triggered = [item["prop_id"] for item in triggered]
-        grouping = getattr(flask.g, "args_grouping", {})
-
-        def update_args_grouping(g):
-            if isinstance(g, dict) and "id" in g:
-                str_id = stringify_id(g["id"])
-                prop_id = f"{str_id}.{g['property']}"
-
-                new_values = {
-                    "value": g.get("value"),
-                    "str_id": str_id,
-                    "triggered": prop_id in triggered,
-                    "id": AttributeDict(g["id"])
-                    if isinstance(g["id"], dict)
-                    else g["id"],
-                }
-                g.update(new_values)
-
-        def recursive_update(g):
-            if isinstance(g, (tuple, list)):
-                for i in g:
-                    update_args_grouping(i)
-                    recursive_update(i)
-            if isinstance(g, dict):
-                for i in g.values():
-                    update_args_grouping(i)
-                    recursive_update(i)
-
-        recursive_update(grouping)
-
-        return grouping
-
-    # todo not sure whether we need this, but it removes a level of nesting so
-    #  you don't need to use `.value` to get the value.
-    @property
-    @has_context
-    def args_grouping_values(self):
-        grouping = getattr(flask.g, "args_grouping", {})
-        grouping = deepcopy(grouping)
-
-        def recursive_update(g):
-            if isinstance(g, (tuple, list)):
-                for i in g:
-                    recursive_update(i)
-            if isinstance(g, dict):
-                for k, v in g.items():
-                    if isinstance(v, dict) and "id" in v:
-                        g[k] = v["value"]
-                    recursive_update(v)
-
-        recursive_update(grouping)
-        return grouping
+        return getattr(flask.g, "args_grouping", [])
 
     @property
     @has_context

dash/_grouping.py

@@ -14,7 +14,7 @@
 
 """
 from dash.exceptions import InvalidCallbackReturnValue
-from ._utils import AttributeDict
+from ._utils import AttributeDict, stringify_id
 
 
 def flatten_grouping(grouping, schema=None):
@@ -222,3 +222,17 @@ def validate_grouping(grouping, schema, full_schema=None, path=()):
             )
     else:
         pass
+
+
+def update_args_group(g, triggered):
+    if isinstance(g, dict):
+        str_id = stringify_id(g["id"])
+        prop_id = f"{str_id}.{g['property']}"
+
+        new_values = {
+            "value": g.get("value"),
+            "str_id": str_id,
+            "triggered": prop_id in triggered,
+            "id": AttributeDict(g["id"]) if isinstance(g["id"], dict) else g["id"],
+        }
+        g.update(new_values)

dash/_pages.py

@@ -61,7 +61,7 @@ def _module_name_to_page_name(filename):
 def _infer_path(filename, template):
     if template is None:
         if CONFIG.pages_folder:
-            pages_folder = CONFIG.pages_folder.split("/")[-1]
+            pages_folder = CONFIG.pages_folder.replace("\\", "/").split("/")[-1]
             path = (
                 filename.replace("_", "-")
                 .replace(".", "/")

dash/dash.py

@@ -61,11 +61,7 @@
 from . import _watch
 from . import _get_app
 
-from ._grouping import (
-    flatten_grouping,
-    map_grouping,
-    grouping_len,
-)
+from ._grouping import flatten_grouping, map_grouping, grouping_len, update_args_group
 
 from . import _pages
 from ._pages import (
@@ -843,7 +839,7 @@ def _generate_meta_html(self):
             x.get("http-equiv", "") == "X-UA-Compatible" for x in meta_tags
         )
         has_charset = any("charset" in x for x in meta_tags)
-        has_viewport = any("viewport" in x for x in meta_tags)
+        has_viewport = any(x.get("name") == "viewport" for x in meta_tags)
 
         tags = []
         if not has_ie_compat:
@@ -1431,6 +1427,14 @@ def dispatch(self):
             inputs_state = inputs + state
             inputs_state = convert_to_AttributeDict(inputs_state)
 
+            # update args_grouping attributes
+            for g in inputs_state:
+                # check for pattern matching: list of inputs or state
+                if isinstance(g, list):
+                    for pattern_match_g in g:
+                        update_args_group(pattern_match_g, changed_props)
+                update_args_group(g, changed_props)
+
             args_grouping = map_grouping(
                 lambda ind: inputs_state[ind], inputs_state_indices
             )
@@ -2171,7 +2175,9 @@ def _import_layouts_from_pages(self):
                         continue
 
                 page_filename = os.path.join(root, file).replace("\\", "/")
-                _, _, page_filename = page_filename.partition(walk_dir + "/")
+                _, _, page_filename = page_filename.partition(
+                    walk_dir.replace("\\", "/") + "/"
+                )
                 page_filename = page_filename.replace(".py", "").replace("/", ".")
 
                 pages_folder = (

dash/version.py

@@ -1 +1 @@
-__version__ = "2.5.0"
+__version__ = "2.5.1"

tests/assets/grouping_app.py

@@ -39,7 +39,7 @@ def grouping_app():
         ),
         dict(
             items=dict(
-                all=State({"item": ALL}, "children"),
+                all=State({"id": ALL}, "children"),
                 new=State("new-item", "value"),
             ),
             triggers=[Input("add", "n_clicks"), Input("new-item", "n_submit")],
@@ -64,11 +64,11 @@ def edit_list(items, triggers):
             html.Div(
                 [
                     dcc.Checklist(
-                        id={"item": i, "action": "done"},
+                        id={"id": i, "property": "done"},
                         options=[{"label": "", "value": "done"}],
                         style={"display": "inline"},
                     ),
-                    html.Div(text, id={"item": i}, style=style_todo),
+                    html.Div(text, id={"id": i}, style=style_todo),
                 ],
                 style={"clear": "both"},
             )

tests/integration/callbacks/test_wildcards.py

@@ -421,10 +421,10 @@ def assert_callback_context(items_text):
             items=dict(
                 all=[
                     {
-                        "id": {"item": i},
+                        "id": {"id": i},
                         "property": "children",
                         "value": text,
-                        "str_id": stringify_id({"item": i}),
+                        "str_id": stringify_id({"id": i}),
                         "triggered": False,
                     }
                     for i, text in enumerate(items_text[:-1])

tests/integration/test_integration.py

@@ -16,7 +16,7 @@
 from dash.testing.wait import until
 
 
-def test_inin004_wildcard_data_attributes(dash_duo):
+def test_inin003_wildcard_data_attributes(dash_duo):
     app = Dash()
     test_time = datetime.datetime(2012, 1, 10, 2, 3)
     test_date = datetime.date(test_time.year, test_time.month, test_time.day)
@@ -48,7 +48,7 @@ def test_inin004_wildcard_data_attributes(dash_duo):
     assert dash_duo.get_logs() == []
 
 
-def test_inin005_no_props_component(dash_duo):
+def test_inin004_no_props_component(dash_duo):
     app = Dash()
     app.layout = html.Div(
         [
@@ -71,7 +71,7 @@ def test_inin005_no_props_component(dash_duo):
     assert re.sub("\\s+", " ", inner) == expected
 
 
-def test_inin006_flow_component(dash_duo):
+def test_inin005_flow_component(dash_duo):
     app = Dash()
 
     app.layout = html.Div(
@@ -109,7 +109,7 @@ def display_output(react_value, flow_value):
     dash_duo.percy_snapshot(name="flowtype")
 
 
-def test_inin007_meta_tags(dash_duo):
+def test_inin006_meta_tags(dash_duo):
     metas = [
         {"name": "description", "content": "my dash app"},
         {"name": "custom", "content": "customized"},
@@ -133,6 +133,25 @@ def test_inin007_meta_tags(dash_duo):
         assert meta_tag.get_attribute("content") == meta_info["content"]
 
 
+def test_inin007_change_viewport_meta_tag(dash_duo):
+    """
+    As of dash 2.5 the default viewport meta tag is:
+        [{"name": "viewport", "content": "width=device-width, initial-scale=1"}]
+    Test verifies that this feature can be disabled by using an empty viewport tag.
+    """
+
+    app = Dash(meta_tags=[{"name": "viewport"}])
+
+    app.layout = html.Div(id="content")
+
+    dash_duo.start_server(app)
+
+    viewport_meta = dash_duo.find_elements('meta[name="viewport"]')
+
+    assert len(viewport_meta) == 1, "Should have 1 viewport meta tags"
+    assert viewport_meta[0].get_attribute("content") == ""
+
+
 def test_inin008_index_customization(dash_duo):
     app = Dash()