Andrew/test coverage

src/py/.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
       - id: add-trailing-comma
   - repo: https://github.com/astral-sh/ruff-pre-commit
     #  Ruff version.
-    rev: v0.8.2
+    rev: v0.12.10
     hooks:
       #  Run the linter.
       - id: ruff

src/py/kaleido/__init__.py

@@ -6,12 +6,24 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from choreographer.cli import get_chrome, get_chrome_sync
 
 from . import _sync_server
 from ._page_generator import PageGenerator
 from .kaleido import Kaleido
 
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterable, Iterable
+    from pathlib import Path
+    from typing import Any, TypeVar, Union
+
+    from ._fig_tools import Figurish, LayoutOpts
+
+    T = TypeVar("T")
+    AnyIterable = Union[AsyncIterable[T], Iterable[T]]
+
 __all__ = [
     "Kaleido",
     "PageGenerator",
@@ -30,7 +42,7 @@
 _global_server = _sync_server.GlobalKaleidoServer()
 
 
-def start_sync_server(*args, silence_warnings=False, **kwargs):
+def start_sync_server(*args: Any, silence_warnings: bool = False, **kwargs: Any):
     """
     Start a kaleido server which will process all sync generation requests.
 
@@ -50,7 +62,7 @@ def start_sync_server(*args, silence_warnings=False, **kwargs):
     _global_server.open(*args, silence_warnings=silence_warnings, **kwargs)
 
 
-def stop_sync_server(*, silence_warnings=False):
+def stop_sync_server(*, silence_warnings: bool = False):
     """
     Stop the kaleido server. It can be restarted. Warns if not started.
 
@@ -63,12 +75,12 @@ def stop_sync_server(*, silence_warnings=False):
 
 
 async def calc_fig(
-    fig,
-    path=None,
-    opts=None,
+    fig: Figurish,
+    path: str | None | Path = None,
+    opts: LayoutOpts | None = None,
     *,
-    topojson=None,
-    kopts=None,
+    topojson: str | None = None,
+    kopts: dict[str, Any] | None = None,
 ):
     """
     Return binary for plotly figure.
@@ -85,7 +97,7 @@ async def calc_fig(
 
     """
     kopts = kopts or {}
-    kopts["n"] = 1
+    kopts["n"] = 1  # should we force this?
     async with Kaleido(**kopts) as k:
         return await k.calc_fig(
             fig,
@@ -95,15 +107,14 @@ async def calc_fig(
         )
 
 
-async def write_fig(  # noqa: PLR0913 (too many args, complexity)
-    fig,
-    path=None,
-    opts=None,
+async def write_fig(
+    fig: Figurish,
+    path: str | None | Path = None,
+    opts: LayoutOpts | None = None,
     *,
-    topojson=None,
-    error_log=None,
-    profiler=None,
-    kopts=None,
+    topojson: str | None = None,
+    kopts: dict[str, Any] | None = None,
+    **kwargs,
 ):
     """
     Write a plotly figure(s) to a file.
@@ -123,17 +134,15 @@ async def write_fig(  # noqa: PLR0913 (too many args, complexity)
             path=path,
             opts=opts,
             topojson=topojson,
-            error_log=error_log,
-            profiler=profiler,
+            **kwargs,
         )
 
 
 async def write_fig_from_object(
-    generator,
+    generator: AnyIterable,  # this could be more specific with []
     *,
-    error_log=None,
-    profiler=None,
-    kopts=None,
+    kopts: dict[str, Any] | None = None,
+    **kwargs,
 ):
     """
     Write a plotly figure(s) to a file.
@@ -150,28 +159,27 @@ async def write_fig_from_object(
     async with Kaleido(**(kopts or {})) as k:
         await k.write_fig_from_object(
             generator,
-            error_log=error_log,
-            profiler=profiler,
+            **kwargs,
         )
 
 
-def calc_fig_sync(*args, **kwargs):
+def calc_fig_sync(*args: Any, **kwargs: Any):
     """Call `calc_fig` but blocking."""
     if _global_server.is_running():
         return _global_server.call_function("calc_fig", *args, **kwargs)
     else:
         return _sync_server.oneshot_async_run(calc_fig, args=args, kwargs=kwargs)
 
 
-def write_fig_sync(*args, **kwargs):
+def write_fig_sync(*args: Any, **kwargs: Any):
     """Call `write_fig` but blocking."""
     if _global_server.is_running():
         _global_server.call_function("write_fig", *args, **kwargs)
     else:
         _sync_server.oneshot_async_run(write_fig, args=args, kwargs=kwargs)
 
 
-def write_fig_from_object_sync(*args, **kwargs):
+def write_fig_from_object_sync(*args: Any, **kwargs: Any):
     """Call `write_fig_from_object` but blocking."""
     if _global_server.is_running():
         _global_server.call_function("write_fig_from_object", *args, **kwargs)

src/py/kaleido/_page_generator.py

@@ -2,6 +2,7 @@
 
 from pathlib import Path
 from urllib.parse import urlparse
+from urllib.request import url2pathname
 
 import logistro
 
@@ -16,12 +17,21 @@
 KJS_PATH = Path(__file__).resolve().parent / "vendor" / "kaleido_scopes.js"
 
 
-def _ensure_path(path: Path | str):
+def _ensure_path(path: Path | str | tuple[str | Path, str]) -> None:
+    if isinstance(path, tuple):
+        path = path[0]
     _logger.debug(f"Ensuring path {path!s}")
-    if urlparse(str(path)).scheme.startswith("http"):  # is url
+    parsed = urlparse(str(path))
+    _logger.debug(f"Parsed file path: {parsed}")
+    if parsed.scheme.startswith("http"):  # is url
         return
-    if not Path(path).exists():
-        raise FileNotFoundError(f"{path!s} does not exist.")
+    elif parsed.scheme.startswith("file"):
+        if (_p := Path(url2pathname(parsed.path))).exists():
+            return
+        _logger.error(f"File parsed to: {_p}")
+    elif Path(path).exists():
+        return
+    raise FileNotFoundError(f"{path!s} does not exist.")
 
 
 class PageGenerator:
@@ -54,7 +64,14 @@ class PageGenerator:
 """
     """The footer is the HTML that always goes on the bottom. Rarely needs changing."""
 
-    def __init__(self, *, plotly=None, mathjax=None, others=None, force_cdn=False):
+    def __init__(  # noqa: C901
+        self,
+        *,
+        plotly: None | Path | str | tuple[Path | str, str] = None,
+        mathjax: None | Path | str | bool | tuple[Path | str, str] = None,
+        others: None | list[Path | str | tuple[Path | str, str]] = None,
+        force_cdn: bool = False,
+    ):
         """
         Create a PageGenerator.
 
@@ -71,9 +88,9 @@ def __init__(self, *, plotly=None, mathjax=None, others=None, force_cdn=False):
         """
         self._scripts = []
         if mathjax is not False:
-            if not mathjax:
+            if mathjax is None or mathjax is True:
                 mathjax = DEFAULT_MATHJAX
-            else:
+            elif mathjax:
                 _ensure_path(mathjax)
             self._scripts.append(mathjax)
         if force_cdn:
@@ -101,7 +118,7 @@ def __init__(self, *, plotly=None, mathjax=None, others=None, force_cdn=False):
             except ImportError:
                 _logger.info("Plotly not installed. Using CDN.")
                 plotly = (DEFAULT_PLOTLY, "utf-8")
-        elif isinstance(plotly, str):
+        elif isinstance(plotly, (str, Path)):
             _ensure_path(plotly)
             plotly = (plotly, "utf-8")
         _logger.debug(f"Plotly script: {plotly}")
@@ -123,8 +140,8 @@ def generate_index(self, path=None):
         script_tag = '\n        <script src="%s"></script>'
         script_tag_charset = '\n        <script src="%s" charset="%s"></script>'
         for script in self._scripts:
-            if isinstance(script, str):
-                page += script_tag % script
+            if isinstance(script, (str, Path)):
+                page += script_tag % str(script)
             else:
                 page += script_tag_charset % script
         page += self.footer