Linting

vizro-core/examples/visual-vocabulary/custom_charts.py

@@ -143,14 +143,26 @@ def categorical_column(data_frame: pd.DataFrame, x: str, y: str):
     fig.update_xaxes(type="category")
     return fig
 
+
 def offset_signal(signal: float, marker_offset: float):
-    """Offsets the signal value by the marker_offset, reducing for positive signal values 
-        and increasing for negative values. Used to reduce the length of lines on lollipop charts
-        to end just under the dot """
+    """Offsets a signal value by marker_offset.
+
+    Reduces for positive signal values and increasing for negative values. Used to reduce the length of
+    lines on lollipop charts to end just before the dot.
+
+    Args:
+        signal (float): the value to be updated.
+        marker_offset (float): the offset to be added/subtracted.
+
+    Returns:
+        float: the updated value.
+
+    """
     if abs(signal) <= marker_offset:
         return 0
     return signal - marker_offset if signal > 0 else signal + marker_offset
 
+
 @capture("graph")
 def lollipop(data_frame: pd.DataFrame, x: str, y: str, y_offset: float):
     """Creates a lollipop chart using Plotly.
@@ -171,18 +183,17 @@ def lollipop(data_frame: pd.DataFrame, x: str, y: str, y_offset: float):
 
     shapes = []
     for i, row in data_frame.iterrows():
-        shapes.append(dict(
-            type='line',
-            xref='x',
-            yref='y',
-            x0=row[x],
-            y0=0,
-            x1=row[x],
-            y1=offset_signal(row[y], y_offset),
-            line=dict(
-                color='grey',
-                width=2
-            )
-        ))
+        shapes.append(
+            {
+                "type": "line",
+                "xref": "x",
+                "yref": "y",
+                "x0": row[x],
+                "y0": 0,
+                "x1": row[x],
+                "y1": offset_signal(row[y], y_offset),
+                "line": {"color": "grey", "width": 2},
+            }
+        )
     fig = data.update_layout(shapes=shapes)
     return fig

vizro-core/examples/visual-vocabulary/pages/_factories.py

@@ -111,6 +111,7 @@ def column_and_line_factory(group: str):
         ],
     )
 
+
 def lollipop_factory(group: str):
     """Reusable function to create the page content for the lollipop chart with a unique ID."""
     return vm.Page(
@@ -123,25 +124,21 @@ def lollipop_factory(group: str):
                 text="""
                 #### What is a lollipop chart?
 
-                A lollipop chart is a type of chart that combines elements of a bar chart and a scatter plot. And a line extends from the 
-                x-axis to a dot, which marks the value for that category. This makes it easy to compare different categories visually.
+                A lollipop chart is a type of chart that combines elementsof a bar chart and a scatter plot.
+                A line extends from the x-axis to a dot, which marks the value for that category. This makes
+                it easy to compare different categories visually.
 
                  
 
                 #### When should I use it?
 
-                Use a lollipop chart when you want to highlight individual data points and make comparisons across categories. It’s 
-                particularly useful for displaying ranking or distribution data, and it can be more visually appealing and easier to 
-                read than traditional bar charts.
+                Use a lollipop chart when you want to highlight individual data points and make comparisons across
+                categories. It is particularly useful for displaying ranking or distribution data, and it can be more
+                visually appealing and easier to read than traditional bar charts.
         """
             ),
             vm.Graph(
-                figure=lollipop(
-                    gapminder.query("year == 2007 and gdpPercap > 36000"),
-                    'country',
-                    'gdpPercap', 
-                    5.0
-                )
+                figure=lollipop(gapminder.query("year == 2007 and gdpPercap > 36000"), "country", "gdpPercap", 5.0)
             ),
             make_code_clipboard_from_py_file("lollipop.py"),
         ],

vizro-core/examples/visual-vocabulary/pages/examples/lollipop.py

@@ -1,18 +1,29 @@
+import pandas as pd
 import vizro.models as vm
 import vizro.plotly.express as px
-import pandas as pd
-
-from vizro.models.types import capture
 from vizro import Vizro
+from vizro.models.types import capture
+
 
 def offset_signal(signal: float, marker_offset: float):
-    """Offsets the signal value by the marker_offset, reducing for positive signal values 
-        and increasing for negative values. Used to reduce the length of lines on lollipop charts
-        to end just under the dot """
+    """Offsets a signal value by marker_offset.
+
+    Reduces for positive signal values and increasing for negative values. Used to reduce the length of
+    lines on lollipop charts to end just before the dot.
+
+    Args:
+        signal (float): the value to be updated.
+        marker_offset (float): the offset to be added/subtracted.
+
+    Returns:
+        float: the updated value.
+
+    """
     if abs(signal) <= marker_offset:
         return 0
     return signal - marker_offset if signal > 0 else signal + marker_offset
 
+
 @capture("graph")
 def lollipop(data_frame: pd.DataFrame, x: str, y: str, y_offset: float):
     """Creates a lollipop chart using Plotly.
@@ -33,32 +44,30 @@ def lollipop(data_frame: pd.DataFrame, x: str, y: str, y_offset: float):
 
     shapes = []
     for i, row in data_frame.iterrows():
-        shapes.append(dict(
-            type='line',
-            xref='x',
-            yref='y',
-            x0=row[x],
-            y0=0,
-            x1=row[x],
-            y1=offset_signal(row[y], y_offset),
-            line=dict(
-                color='grey',
-                width=2
-            )
-        ))
+        shapes.append(
+            {
+                "type": "line",
+                "xref": "x",
+                "yref": "y",
+                "x0": row[x],
+                "y0": 0,
+                "x1": row[x],
+                "y1": offset_signal(row[y], y_offset),
+                "line": {"color": "grey", "width": 2},
+            }
+        )
     fig = data.update_layout(shapes=shapes)
     return fig
 
+
 gapminder = px.data.gapminder()
 df = gapminder.query("year == 2007 and gdpPercap > 36000")
 marker_offset = 5.0
 
 page = vm.Page(
     title="Lollipop",
-    components=[
-        vm.Graph(figure=lollipop(df, 'country', 'gdpPercap', marker_offset))
-    ],
+    components=[vm.Graph(figure=lollipop(df, "country", "gdpPercap", marker_offset))],
 )
 
 dashboard = vm.Dashboard(pages=[page])
-Vizro().build(dashboard).run()
+Vizro().build(dashboard).run()

vizro-core/examples/visual-vocabulary/pages/magnitude.py

@@ -3,8 +3,8 @@
 import vizro.models as vm
 import vizro.plotly.express as px
 
-from pages._pages_utils import PAGE_GRID, gapminder, iris, make_code_clipboard_from_py_file, tips
 from pages._factories import lollipop_factory
+from pages._pages_utils import PAGE_GRID, gapminder, iris, make_code_clipboard_from_py_file, tips
 
 bar = vm.Page(
     title="Bar",

vizro-core/examples/visual-vocabulary/pages/ranking.py

@@ -3,8 +3,8 @@
 import vizro.models as vm
 import vizro.plotly.express as px
 
-from pages._pages_utils import PAGE_GRID, gapminder, make_code_clipboard_from_py_file
 from pages._factories import lollipop_factory
+from pages._pages_utils import PAGE_GRID, gapminder, make_code_clipboard_from_py_file
 
 ordered_bar = vm.Page(
     title="Ordered bar",