Merge branch 'plotly:master' into reno

Author: tschm

src/py/CHANGELOG.txt

@@ -1,3 +1,6 @@
+Unreleased
+- Add warning if using incompatible Plotly version
+
 v1.0.0rc15
 - BUG: Add regex sanitization for auto-filename generation
 - Further santiize title to filename conversion

src/py/kaleido/_utils.py

@@ -1,6 +1,13 @@
 import asyncio
 import traceback
+import warnings
 from functools import partial
+from importlib.metadata import PackageNotFoundError, version
+
+import logistro
+from packaging.version import Version
+
+_logger = logistro.getLogger(__name__)
 
 
 async def to_thread(func, *args, **kwargs):
@@ -9,6 +16,41 @@ async def to_thread(func, *args, **kwargs):
     await _loop.run_in_executor(None, fn)
 
 
+def warn_incompatible_plotly():
+    """
+    Check if installed Plotly version (if any) is compatible with this Kaleido version.
+
+    If not, display a warning.
+    """
+    try:
+        min_compatible_plotly_version = Version("6.1.1")
+        installed_plotly_version = Version(version("plotly"))
+        installed_kaleido_version = Version(version("kaleido"))
+        if installed_plotly_version < min_compatible_plotly_version:
+            warnings.warn(
+                "\n\n"
+                f"Warning: You have Plotly version {installed_plotly_version}, "
+                "which is not compatible with this version of "
+                f"Kaleido ({installed_kaleido_version}).\n\n"
+                "This means that static image generation (e.g. `fig.write_image()`) "
+                "will not work.\n\n"
+                f"Please upgrade Plotly to version {min_compatible_plotly_version} "
+                "or greater, or downgrade Kaleido to version 0.2.1."
+                "\n",
+                UserWarning,
+                stacklevel=3,
+            )
+    except PackageNotFoundError:
+        # If Plotly is not installed, there's nothing to worry about
+        pass
+    # ruff: noqa: BLE001
+    except Exception as e:
+        # If another error occurs, log it but do not raise
+        # Since this compatibility check is just a convenience,
+        # we don't want to block the whole library if there's an issue
+        _logger.info("Error while checking Plotly version.", exc_info=e)
+
+
 class ErrorEntry:
     """A simple object to record errors and context."""
 

src/py/kaleido/kaleido.py

@@ -16,10 +16,14 @@
 from ._fig_tools import _is_figurish, build_fig_spec
 from ._kaleido_tab import _KaleidoTab
 from ._page_generator import PageGenerator
-from ._utils import ErrorEntry
+from ._utils import ErrorEntry, warn_incompatible_plotly
 
 _logger = logistro.getLogger(__name__)
 
+# Show a warning if the installed Plotly version
+# is incompatible with this version of Kaleido
+warn_incompatible_plotly()
+
 
 def _make_printer(name):
     """Create event printer for generic events. Helper function."""

src/py/pyproject.toml

@@ -29,6 +29,7 @@ dependencies = [
   "choreographer>=1.0.5",
   "logistro>=1.0.8",
   "orjson>=3.10.15",
+  "packaging",
 ]
 
 [project.urls]