Merge branch 'main' into axis-match-bug

Author: richmanpoorman

CHANGELOG.md

@@ -9,8 +9,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Change: change the keyword argument for the trace, so that when the graph is initialized, it uses the correct axis instead of the autogenerated one
 - Note: The program generates a unique axis label for each subgraph, and then overwrites the label (under this fix)
 
+### Added
+- Add optional `font` parameter for `make_subplots` [[#5393](https://github.com/plotly/plotly.py/pull/5393)]
+
 ### Fixed
 - Fix issue where user-specified `color_continuous_scale` was ignored when template had `autocolorscale=True` [[#5439](https://github.com/plotly/plotly.py/pull/5439)], with thanks to @antonymilne for the contribution!
+- Use presence of `COLAB_NOTEBOOK_ID` env var to enable Colab renderer instead of testing import of `google.colab` [[#5473](https://github.com/plotly/plotly.py/pull/5473)], with thanks to @kevineger for the contribution!
 - Update tests to be compatible with numpy 2.4 [[#5522](https://github.com/plotly/plotly.py/pull/5522)], with thanks to @thunze for the contribution!
 
 ### Updated

doc/python/templates.md

@@ -93,7 +93,7 @@ for template in ["plotly", "plotly_white", "plotly_dark", "ggplot2", "seaborn",
     fig.show()
 ```
 
-#### Specifying a default themes
+#### Specifying a default theme
 
 If a theme is not provided to a Plotly Express function or to a graph object figure, then the default theme is used. The default theme starts out as `"plotly"`, but it can be changed by setting the `plotly.io.templates.default` property to the name of a registered theme.
 
@@ -475,4 +475,4 @@ It may be useful to examine the contents and structure of the built-in templates
 import plotly.io as pio
 plotly_template = pio.templates["plotly"]
 plotly_template.layout
-```
+```

plotly/_subplots.py

@@ -74,6 +74,7 @@ def make_subplots(
     x_title=None,
     y_title=None,
     figure=None,
+    font=None,
     **kwargs,
 ):
     """
@@ -108,7 +109,7 @@ def make_subplots(
 
           - 'top-left': Subplots are numbered with (1, 1) in the top
                         left corner
-          - 'bottom-left': Subplots are numbererd with (1, 1) in the bottom
+          - 'bottom-left': Subplots are numbered with (1, 1) in the bottom
                            left corner
 
     print_grid: boolean (default True):
@@ -182,7 +183,7 @@ def make_subplots(
                 for this subplot to span.
             * l (float, default 0.0): padding left of cell
             * r (float, default 0.0): padding right of cell
-            * t (float, default 0.0): padding right of cell
+            * t (float, default 0.0): padding top of cell
             * b (float, default 0.0): padding bottom of cell
 
         - Note: Use 'horizontal_spacing' and 'vertical_spacing' to adjust
@@ -251,6 +252,9 @@ def make_subplots(
         layout of this figure and this figure will be returned. If the figure
         already contains axes, they will be overwritten.
 
+    font: dict (default None)
+        Font used by any title of the subplots.
+
     Examples
     --------
 
@@ -821,7 +825,7 @@ def _check_hv_spacing(dimsize, spacing, name, dimvarname, dimname):
 
     # Add subplot titles
     plot_title_annotations = _build_subplot_title_annotations(
-        subplot_titles, list_of_domains
+        subplot_titles, list_of_domains, font=font
     )
 
     layout["annotations"] = plot_title_annotations
@@ -842,7 +846,7 @@ def _check_hv_spacing(dimsize, spacing, name, dimvarname, dimname):
 
         # Add subplot titles
         column_title_annotations = _build_subplot_title_annotations(
-            column_titles, domains_list
+            column_titles, domains_list, font=font
         )
 
         layout["annotations"] += tuple(column_title_annotations)
@@ -856,7 +860,7 @@ def _check_hv_spacing(dimsize, spacing, name, dimvarname, dimname):
 
         # Add subplot titles
         column_title_annotations = _build_subplot_title_annotations(
-            row_titles, domains_list, title_edge="right"
+            row_titles, domains_list, title_edge="right", font=font
         )
 
         layout["annotations"] += tuple(column_title_annotations)
@@ -866,7 +870,7 @@ def _check_hv_spacing(dimsize, spacing, name, dimvarname, dimname):
 
         # Add subplot titles
         column_title_annotations = _build_subplot_title_annotations(
-            [x_title], domains_list, title_edge="bottom", offset=30
+            [x_title], domains_list, title_edge="bottom", offset=30, font=font
         )
 
         layout["annotations"] += tuple(column_title_annotations)
@@ -876,7 +880,7 @@ def _check_hv_spacing(dimsize, spacing, name, dimvarname, dimname):
 
         # Add subplot titles
         column_title_annotations = _build_subplot_title_annotations(
-            [y_title], domains_list, title_edge="left", offset=40
+            [y_title], domains_list, title_edge="left", offset=40, font=font
         )
 
         layout["annotations"] += tuple(column_title_annotations)
@@ -1266,7 +1270,7 @@ def _get_cartesian_label(x_or_y, r, c, cnt):
 
 
 def _build_subplot_title_annotations(
-    subplot_titles, list_of_domains, title_edge="top", offset=0
+    subplot_titles, list_of_domains, title_edge="top", offset=0, font=None
 ):
     # If shared_axes is False (default) use list_of_domains
     # This is used for insets and irregular layouts
@@ -1276,6 +1280,10 @@ def _build_subplot_title_annotations(
     subtitle_pos_x = []
     subtitle_pos_y = []
 
+    # If no font size is provided, use this fallback
+    if font is None:
+        font = dict(size=16)
+
     if title_edge == "top":
         text_angle = 0
         xanchor = "center"
@@ -1339,7 +1347,7 @@ def _build_subplot_title_annotations(
                 "yref": "paper",
                 "text": subplot_titles[index],
                 "showarrow": False,
-                "font": dict(size=16),
+                "font": font,
                 "xanchor": xanchor,
                 "yanchor": yanchor,
             }

plotly/io/_renderers.py

@@ -488,13 +488,10 @@ def show(fig, renderer=None, validate=True, **kwargs):
 elif ipython and ipython.get_ipython():
     # Try to detect environment so that we can enable a useful
     # default renderer
-    if not default_renderer:
-        try:
-            import google.colab  # noqa: F401
 
-            default_renderer = "colab"
-        except ImportError:
-            pass
+    # Check if we're running in a Colab web notebook
+    if not default_renderer and "COLAB_NOTEBOOK_ID" in os.environ:
+        default_renderer = "colab"
 
     # Check if we're running in a Kaggle notebook
     if not default_renderer and os.path.exists("/kaggle/input"):

pyproject.toml

@@ -120,6 +120,10 @@ include = [
     "js/install.json",  # used by Jupyter extension
 ]
 
+[tool.hatch.build.targets.wheel]
+# Prevent js/ directory from being installed as top-level package
+exclude = ["js"]
+
 [tool.hatch.build.targets.wheel.shared-data]
 # Specify files from this package which will be copied to the user's system on install
 # This is how the jupyterlab extension gets installed

tests/test_io/test_renderers.py

@@ -1,4 +1,5 @@
 import json
+import os
 import threading
 import time
 
@@ -418,3 +419,75 @@ def test_missing_webbrowser_methods(fig1):
     finally:
         # restore everything after this test
         webbrowser.get = removed_webbrowser_get_method
+
+
+def test_colab_renderer_when_env_var_is_set():
+    """
+    When COLAB_NOTEBOOK_ID is present the default renderer should be 'colab'.
+    """
+    import importlib
+    import plotly.io._renderers as _renderers_mod
+    from plotly import optional_imports
+
+    fake_ipython = MagicMock()
+    original_get_module = optional_imports.get_module
+
+    def patched_get_module(name, *args, **kwargs):
+        if name in ("IPython", "IPython.display"):
+            return fake_ipython
+        return original_get_module(name, *args, **kwargs)
+
+    original_default = pio.renderers.default
+    try:
+        with mock.patch.dict(os.environ, {"COLAB_NOTEBOOK_ID": "fake-id"}, clear=True):
+            with mock.patch.object(
+                optional_imports, "get_module", side_effect=patched_get_module
+            ):
+                importlib.reload(_renderers_mod)
+                assert _renderers_mod.renderers.default == "colab"
+    finally:
+        importlib.reload(_renderers_mod)
+        pio.renderers.default = original_default
+
+
+def test_colab_renderer_when_env_var_is_absent():
+    """
+    Without COLAB_NOTEBOOK_ID the default renderer must not be 'colab',
+    even when ``google.colab`` is importable.
+
+    Regression test for https://github.com/plotly/plotly.py/pull/5473.
+    """
+    import sys
+    import types
+    import importlib
+    import plotly.io._renderers as _renderers_mod
+    from plotly import optional_imports
+
+    fake_ipython = MagicMock()
+    original_get_module = optional_imports.get_module
+
+    def patched_get_module(name, *args, **kwargs):
+        if name in ("IPython", "IPython.display"):
+            return fake_ipython
+        return original_get_module(name, *args, **kwargs)
+
+    # Make google.colab importable so the old ``import google.colab``
+    # approach would have chosen the colab renderer here.
+    fake_google = types.ModuleType("google")
+    fake_google_colab = types.ModuleType("google.colab")
+
+    original_default = pio.renderers.default
+    try:
+        with mock.patch.dict(os.environ, {}, clear=True):
+            with mock.patch.dict(
+                sys.modules,
+                {"google": fake_google, "google.colab": fake_google_colab},
+            ):
+                with mock.patch.object(
+                    optional_imports, "get_module", side_effect=patched_get_module
+                ):
+                    importlib.reload(_renderers_mod)
+                    assert _renderers_mod.renderers.default != "colab"
+    finally:
+        importlib.reload(_renderers_mod)
+        pio.renderers.default = original_default