Apply ctx abbreviation consistently (#257)

vizro-core/changelog.d/20240109_140626_huong_li_nguyen_use_ctx_short.md

@@ -0,0 +1,48 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Highlights ✨
+
+- A bullet item for the Highlights ✨ category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category with a link to the relevant PR at the end of your entry, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1))
+
+-->

vizro-core/src/vizro/actions/_actions_utils.py

@@ -20,7 +20,7 @@
 
 
 class CallbackTriggerDict(TypedDict):
-    """Represent dash.callback_context.args_grouping item. Shortened as 'ctd' in the code.
+    """Represent dash.ctx.args_grouping item. Shortened as 'ctd' in the code.
 
     Args:
         id: The component ID. If it`s a pattern matching ID, it will be a dict.

vizro-core/tests/unit/vizro/actions/test_export_data_action.py

@@ -45,8 +45,8 @@ def managers_one_page_without_graphs_one_button():
 
 
 @pytest.fixture
-def callback_context_export_data(request):
-    """Mock dash.callback_context that represents filters and filter interactions applied."""
+def ctx_export_data(request):
+    """Mock dash.ctx that represents filters and filter interactions applied."""
     targets, pop_filter, continent_filter_interaction, country_table_filter_interaction = request.param
     args_grouping_filter_interaction = []
     if continent_filter_interaction:
@@ -97,7 +97,7 @@ def callback_context_export_data(request):
                 ),
             }
         )
-    mock_callback_context = {
+    mock_ctx = {
         "args_grouping": {
             "external": {
                 "filters": [
@@ -123,14 +123,14 @@ def callback_context_export_data(request):
         ],
     }
 
-    context_value.set(AttributeDict(**mock_callback_context))
+    context_value.set(AttributeDict(**mock_ctx))
     return context_value
 
 
 class TestExportData:
     @pytest.mark.usefixtures("managers_one_page_without_graphs_one_button")
-    @pytest.mark.parametrize("callback_context_export_data", [([[], None, None, None])], indirect=True)
-    def test_no_graphs_no_targets(self, callback_context_export_data):
+    @pytest.mark.parametrize("ctx_export_data", [([[], None, None, None])], indirect=True)
+    def test_no_graphs_no_targets(self, ctx_export_data):
         # Add action to relevant component
         model_manager["button"].actions = [vm.Action(id="test_action", function=export_data())]
 
@@ -141,10 +141,8 @@ def test_no_graphs_no_targets(self, callback_context_export_data):
         assert result == expected
 
     @pytest.mark.usefixtures("managers_one_page_two_graphs_one_button")
-    @pytest.mark.parametrize(
-        "callback_context_export_data", [([["scatter_chart", "box_chart"], None, None, None])], indirect=True
-    )
-    def test_graphs_no_targets(self, callback_context_export_data, gapminder_2007):
+    @pytest.mark.parametrize("ctx_export_data", [([["scatter_chart", "box_chart"], None, None, None])], indirect=True)
+    def test_graphs_no_targets(self, ctx_export_data, gapminder_2007):
         # Add action to relevant component
         model_manager["button"].actions = [vm.Action(id="test_action", function=export_data())]
 
@@ -169,14 +167,14 @@ def test_graphs_no_targets(self, callback_context_export_data, gapminder_2007):
 
     @pytest.mark.usefixtures("managers_one_page_two_graphs_one_button")
     @pytest.mark.parametrize(
-        "callback_context_export_data, targets",
+        "ctx_export_data, targets",
         [
             ([["scatter_chart", "box_chart"], None, None, None], None),
             ([["scatter_chart", "box_chart"], None, None, None], []),
         ],
-        indirect=["callback_context_export_data"],
+        indirect=["ctx_export_data"],
     )
-    def test_graphs_false_targets(self, callback_context_export_data, targets, gapminder_2007):
+    def test_graphs_false_targets(self, ctx_export_data, targets, gapminder_2007):
         # Add action to relevant component
         model_manager["button"].actions = [vm.Action(id="test_action", function=export_data(targets=targets))]
 
@@ -200,8 +198,8 @@ def test_graphs_false_targets(self, callback_context_export_data, targets, gapmi
         assert result == expected
 
     @pytest.mark.usefixtures("managers_one_page_two_graphs_one_button")
-    @pytest.mark.parametrize("callback_context_export_data", [(["scatter_chart"], None, None, None)], indirect=True)
-    def test_one_target(self, callback_context_export_data, gapminder_2007):
+    @pytest.mark.parametrize("ctx_export_data", [(["scatter_chart"], None, None, None)], indirect=True)
+    def test_one_target(self, ctx_export_data, gapminder_2007):
         # Add action to relevant component
         model_manager["button"].actions = [vm.Action(id="test_action", function=export_data(targets=["scatter_chart"]))]
 
@@ -219,10 +217,8 @@ def test_one_target(self, callback_context_export_data, gapminder_2007):
         assert result == expected
 
     @pytest.mark.usefixtures("managers_one_page_two_graphs_one_button")
-    @pytest.mark.parametrize(
-        "callback_context_export_data", [(["scatter_chart", "box_chart"], None, None, None)], indirect=True
-    )
-    def test_multiple_targets(self, callback_context_export_data, gapminder_2007):
+    @pytest.mark.parametrize("ctx_export_data", [(["scatter_chart", "box_chart"], None, None, None)], indirect=True)
+    def test_multiple_targets(self, ctx_export_data, gapminder_2007):
         # Add action to relevant component
         model_manager["button"].actions = [
             vm.Action(id="test_action", function=export_data(targets=["scatter_chart", "box_chart"]))
@@ -248,10 +244,10 @@ def test_multiple_targets(self, callback_context_export_data, gapminder_2007):
         assert result == expected
 
     @pytest.mark.usefixtures("managers_one_page_two_graphs_one_button")
-    @pytest.mark.parametrize("callback_context_export_data", [(["invalid_target_id"], None, None, None)], indirect=True)
+    @pytest.mark.parametrize("ctx_export_data", [(["invalid_target_id"], None, None, None)], indirect=True)
     def test_invalid_target(
         self,
-        callback_context_export_data,
+        ctx_export_data,
     ):
         # Add action to relevant component
         model_manager["button"].actions = [
@@ -264,7 +260,7 @@ def test_invalid_target(
 
     @pytest.mark.usefixtures("managers_one_page_two_graphs_one_button")
     @pytest.mark.parametrize(
-        "callback_context_export_data, target_scatter_filter_and_filter_interaction, target_box_filtered_pop",
+        "ctx_export_data, target_scatter_filter_and_filter_interaction, target_box_filtered_pop",
         [
             (
                 [["scatter_chart", "box_chart"], [10**6, 10**7], None, None],
@@ -282,7 +278,7 @@ def test_invalid_target(
     )
     def test_multiple_targets_with_filter_and_filter_interaction(
         self,
-        callback_context_export_data,
+        ctx_export_data,
         target_scatter_filter_and_filter_interaction,
         target_box_filtered_pop,
     ):
@@ -323,7 +319,7 @@ def test_multiple_targets_with_filter_and_filter_interaction(
 
     @pytest.mark.usefixtures("managers_one_page_two_graphs_one_table_one_button")
     @pytest.mark.parametrize(
-        "callback_context_export_data, target_scatter_filter_and_filter_interaction, target_box_filtered_pop",
+        "ctx_export_data, target_scatter_filter_and_filter_interaction, target_box_filtered_pop",
         [
             (
                 [["scatter_chart", "box_chart"], [10**6, 10**7], None, "Algeria"],
@@ -341,7 +337,7 @@ def test_multiple_targets_with_filter_and_filter_interaction(
     )
     def test_multiple_targets_with_filter_and_filter_interaction_and_table(
         self,
-        callback_context_export_data,
+        ctx_export_data,
         target_scatter_filter_and_filter_interaction,
         target_box_filtered_pop,
     ):

vizro-core/tests/unit/vizro/actions/test_filter_action.py

@@ -30,10 +30,10 @@ def target_box_filtered_continent_and_pop(request, gapminder_2007, box_params):
 
 
 @pytest.fixture
-def callback_context_filter_continent(request):
-    """Mock dash.callback_context that represents continent Filter value selection."""
+def ctx_filter_continent(request):
+    """Mock dash.ctx that represents continent Filter value selection."""
     continent = request.param
-    mock_callback_context = {
+    mock_ctx = {
         "args_grouping": {
             "external": {
                 "filter_interaction": [],
@@ -57,15 +57,15 @@ def callback_context_filter_continent(request):
             }
         }
     }
-    context_value.set(AttributeDict(**mock_callback_context))
+    context_value.set(AttributeDict(**mock_ctx))
     return context_value
 
 
 @pytest.fixture
-def callback_context_filter_continent_and_pop(request):
-    """Mock dash.callback_context that represents continent and pop Filter value selection."""
+def ctx_filter_continent_and_pop(request):
+    """Mock dash.ctx that represents continent and pop Filter value selection."""
     continent, pop = request.param
-    mock_callback_context = {
+    mock_ctx = {
         "args_grouping": {
             "external": {
                 "filter_interaction": [],
@@ -96,20 +96,20 @@ def callback_context_filter_continent_and_pop(request):
             }
         }
     }
-    context_value.set(AttributeDict(**mock_callback_context))
+    context_value.set(AttributeDict(**mock_ctx))
     return context_value
 
 
 @pytest.mark.usefixtures("managers_one_page_two_graphs_one_button")
 class TestFilter:
     @pytest.mark.parametrize(
-        "callback_context_filter_continent,target_scatter_filtered_continent,target_box_filtered_continent",
+        "ctx_filter_continent,target_scatter_filtered_continent,target_box_filtered_continent",
         [(["Africa"], ["Africa"], ["Africa"]), (["Africa", "Europe"], ["Africa", "Europe"], ["Africa", "Europe"])],
         indirect=True,
     )
     def test_one_filter_no_targets(
         self,
-        callback_context_filter_continent,
+        ctx_filter_continent,
         target_scatter_filtered_continent,
         target_box_filtered_continent,
     ):
@@ -130,13 +130,13 @@ def test_one_filter_no_targets(
         assert result == expected
 
     @pytest.mark.parametrize(
-        "callback_context_filter_continent,target_scatter_filtered_continent",
+        "ctx_filter_continent,target_scatter_filtered_continent",
         [(["Africa"], ["Africa"]), (["Africa", "Europe"], ["Africa", "Europe"])],
         indirect=True,
     )
     def test_one_filter_one_target(
         self,
-        callback_context_filter_continent,
+        ctx_filter_continent,
         target_scatter_filtered_continent,
     ):
         # Creating and adding a Filter object to the existing Page
@@ -157,13 +157,13 @@ def test_one_filter_one_target(
         assert result == expected
 
     @pytest.mark.parametrize(
-        "callback_context_filter_continent,target_scatter_filtered_continent,target_box_filtered_continent",
+        "ctx_filter_continent,target_scatter_filtered_continent,target_box_filtered_continent",
         [(["Africa"], ["Africa"], ["Africa"]), (["Africa", "Europe"], ["Africa", "Europe"], ["Africa", "Europe"])],
         indirect=True,
     )
     def test_one_filter_multiple_targets(
         self,
-        callback_context_filter_continent,
+        ctx_filter_continent,
         target_scatter_filtered_continent,
         target_box_filtered_continent,
     ):
@@ -189,7 +189,7 @@ def test_one_filter_multiple_targets(
         assert result == expected
 
     @pytest.mark.parametrize(
-        "callback_context_filter_continent_and_pop,target_scatter_filtered_continent_and_pop,target_box_filtered_continent_and_pop",
+        "ctx_filter_continent_and_pop,target_scatter_filtered_continent_and_pop,target_box_filtered_continent_and_pop",
         [
             ([["Africa"], [10**6, 10**7]], [["Africa"], [10**6, 10**7]], [["Africa"], [10**6, 10**7]]),
             (
@@ -202,7 +202,7 @@ def test_one_filter_multiple_targets(
     )
     def test_multiple_filters_no_targets(
         self,
-        callback_context_filter_continent_and_pop,
+        ctx_filter_continent_and_pop,
         target_scatter_filtered_continent_and_pop,
         target_box_filtered_continent_and_pop,
     ):
@@ -227,7 +227,7 @@ def test_multiple_filters_no_targets(
         assert result == expected
 
     @pytest.mark.parametrize(
-        "callback_context_filter_continent_and_pop,target_scatter_filtered_continent_and_pop",
+        "ctx_filter_continent_and_pop,target_scatter_filtered_continent_and_pop",
         [
             ([["Africa"], [10**6, 10**7]], [["Africa"], [10**6, 10**7]]),
             ([["Africa", "Europe"], [10**6, 10**7]], [["Africa", "Europe"], [10**6, 10**7]]),
@@ -236,7 +236,7 @@ def test_multiple_filters_no_targets(
     )
     def test_multiple_filters_one_target(
         self,
-        callback_context_filter_continent_and_pop,
+        ctx_filter_continent_and_pop,
         target_scatter_filtered_continent_and_pop,
     ):
         # Creating and adding a Filter objects to the existing Page
@@ -262,7 +262,7 @@ def test_multiple_filters_one_target(
         assert result == expected
 
     @pytest.mark.parametrize(
-        "callback_context_filter_continent_and_pop,target_scatter_filtered_continent_and_pop,target_box_filtered_continent_and_pop",
+        "ctx_filter_continent_and_pop,target_scatter_filtered_continent_and_pop,target_box_filtered_continent_and_pop",
         [
             ([["Africa"], [10**6, 10**7]], [["Africa"], [10**6, 10**7]], [["Africa"], [10**6, 10**7]]),
             (
@@ -275,7 +275,7 @@ def test_multiple_filters_one_target(
     )
     def test_multiple_filters_multiple_targets(
         self,
-        callback_context_filter_continent_and_pop,
+        ctx_filter_continent_and_pop,
         target_scatter_filtered_continent_and_pop,
         target_box_filtered_continent_and_pop,
     ):