tesorotools-python 0.0.56__tar.gz → 0.1.1__tar.gz

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tesorotools-python
-Version: 0.0.56
+Version: 0.1.1
 Requires-Python: >=3.13
 Requires-Dist: babel>=2.17
 Requires-Dist: matplotlib>=3.10
@@ -25,3 +25,6 @@ Provides-Extra: interactive-plots
 Requires-Dist: plotly>=5.0; extra == 'interactive-plots'
 Provides-Extra: lseg
 Requires-Dist: lseg-data>=2.1; extra == 'lseg'
+Provides-Extra: web
+Requires-Dist: plotly>=5.24; extra == 'web'
+Requires-Dist: streamlit>=1.62; extra == 'web'

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/pyproject.toml

@@ -31,6 +31,13 @@ fred = ["requests>=2.31"]
 imf = ["requests>=2.31", "truststore>=0.10"]
 lseg = ["lseg-data>=2.1"]
 interactive_plots = ["plotly>=5.0"]
+# Streamlit dashboards scaffolding (tesorotools.web). The CSS targets
+# Streamlit's DOM (data-testid), so keep the floor at a tested version.
+web = ["streamlit>=1.62", "plotly>=5.24"]
+
+[project.scripts]
+tesorotools-web = "tesorotools.web.cli:main"
+tesorotools-latex = "tesorotools.latex.cli:main"
 
 [dependency-groups]
 dev = [

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/__init__.py

@@ -12,9 +12,13 @@ Each class follows the same shape:
   ``data_path`` (``.feather`` on disk), never both.
 * ``from_yaml(loader, node)`` -- builds the same instance
   from a ``!{name}`` YAML tag.
-* ``plot()`` -- renders the chart and writes the PNG; some
-  classes also expose ``build()`` / ``save()`` for
-  fine-grained control.
+* ``build()`` -- renders the chart in memory and returns
+  ``(Figure, Axes)``; ``save(fig, path=..., dpi=...)``
+  writes it; ``plot()`` does both and closes the figure.
+  Every artist exposes the three (see :class:`Artist`).
+* ``to_plotly()`` -- the same chart as an interactive
+  Plotly figure (all but ``IntradayPlot``);
+  :func:`plotly_unsupported` lists the keys it drops.
 
 Shared layout, annotation and styling helpers (plus the
 ``Format`` and ``Legend`` config holders) live in
@@ -25,7 +29,13 @@ live under :mod:`tesorotools.render`; this package is
 strictly image output.
 """
 
-from tesorotools.artists._common import Artist, Format, Legend
+from tesorotools.artists._common import (
+    Artist,
+    FigureLifecycle,
+    Format,
+    Legend,
+    plotly_unsupported,
+)
 from tesorotools.artists.bar_line import BarLinePlot
 from tesorotools.artists.barh_plot import GroupedBarChart, HorizontalBarChart
 from tesorotools.artists.box_plot import BoxPlot
@@ -42,6 +52,7 @@ __all__ = [
     "Artist",
     "BarLinePlot",
     "BoxPlot",
+    "FigureLifecycle",
     "Format",
     "GroupedBarChart",
     "HorizontalBarChart",
@@ -55,4 +66,5 @@ __all__ = [
     "TypeCurve",
     "VectorPlot",
     "Waterfall",
+    "plotly_unsupported",
 ]

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/_common.py

@@ -29,7 +29,11 @@ from typing import Any, Literal, Protocol, Self, cast, runtime_checkable
 import matplotlib.pyplot as plt
 import pandas as pd
 from matplotlib.axes import Axes
-from matplotlib.dates import AutoDateLocator, ConciseDateFormatter
+from matplotlib.dates import (
+    AutoDateLocator,
+    ConciseDateFormatter,
+    YearLocator,
+)
 from matplotlib.dates import (
     date2num,  # type: ignore[reportUnknownVariableType]
 )
@@ -126,6 +130,70 @@ def dynamic_dpi(fig: Figure) -> int:
     return int(round(min(max_dpi, max(min_dpi, target_px / long_in))))
 
 
+def plotly_unsupported(artist: object) -> frozenset[str]:
+    """Configuration keys *artist* accepts but ``to_plotly()`` drops.
+
+    *artist* is an artist class or instance.  The keys change the PNG
+    but not the interactive figure; nested ones are dotted
+    (``"legend.ncol"``, ``"fmt.signed"``).  A UI built on top can tell
+    the user why moving such a control leaves the figure as it is.
+    Needs no ``plotly``: it reads the class attribute
+    ``PLOTLY_UNSUPPORTED``, which the test suite checks against real
+    renders.
+    """
+    cls = artist if isinstance(artist, type) else type(artist)
+    if not hasattr(cls, "to_plotly"):
+        raise TypeError(f"{cls.__name__} has no to_plotly()")
+    declared: frozenset[str] | None = getattr(cls, "PLOTLY_UNSUPPORTED", None)
+    if declared is None:
+        raise TypeError(f"{cls.__name__} does not declare PLOTLY_UNSUPPORTED")
+    return frozenset(declared)
+
+
+class FigureLifecycle:
+    """``save()`` and ``plot()`` on top of a subclass's ``build()``.
+
+    Gives an artist the same three-step life cycle as the rest:
+    ``build()`` returns the figure in memory, ``save()`` writes it
+    and ``plot()`` does both and closes the figure.  A subclass only
+    implements ``build()``.
+    """
+
+    out_path: Path
+
+    def build(self) -> tuple[Figure, Axes]:
+        raise NotImplementedError
+
+    def save(
+        self,
+        fig: Figure,
+        *,
+        path: Path | None = None,
+        dpi: int | None = None,
+    ) -> Path:
+        """Persist *fig* as a PNG and return the path written.
+
+        Defaults to ``self.out_path``; pass ``path`` to redirect.
+        ``dpi`` overrides the save resolution; when omitted it is
+        derived from the figure size via :func:`dynamic_dpi`.
+        """
+        target: Path = path if path is not None else self.out_path
+        save_dpi: int = dpi if dpi is not None else dynamic_dpi(fig)
+        fig.savefig(  # type: ignore[reportUnknownMemberType]
+            target, dpi=save_dpi
+        )
+        return target
+
+    def plot(self) -> Axes:
+        """Build the chart, persist it to ``self.out_path`` and close it."""
+        fig, ax = self.build()
+        try:
+            self.save(fig)
+        finally:
+            plt.close(fig)
+        return ax
+
+
 # ----------------------------------------------------------------------
 # Structural contract for image artists
 # ----------------------------------------------------------------------
@@ -137,13 +205,21 @@ class Artist(Protocol):
 
     The built-in artists and any third-party artist
     registered via :func:`tesorotools.register_artist`
-    expose the same three-piece surface:
+    expose the same surface:
 
     * ``out_path: Path`` -- the ``.png`` destination.
     * ``from_yaml(loader, node) -> Self`` -- the YAML
       constructor bound to the ``!{name}`` tag.
-    * ``plot() -> Axes`` -- render the chart, persist it
-      to ``out_path``, and return the axes for inspection.
+    * ``build() -> (Figure, Axes)`` -- render the chart in
+      memory, without touching the disk.
+    * ``save(fig, *, path=None, dpi=None) -> Path`` -- write
+      a built figure (to ``out_path`` unless ``path`` says
+      otherwise).
+    * ``plot() -> Axes`` -- ``build()`` + ``save()``, close
+      the figure and return the axes for inspection.
+
+    :class:`FigureLifecycle` provides ``save()`` and ``plot()``
+    for an artist that only implements ``build()``.
 
     The Protocol is ``runtime_checkable`` so consumers can
     use ``isinstance(obj, Artist)`` to validate a candidate
@@ -156,6 +232,16 @@ class Artist(Protocol):
     @classmethod
     def from_yaml(cls, loader: Any, node: MappingNode) -> Self: ...
 
+    def build(self) -> tuple[Figure, Axes]: ...
+
+    def save(
+        self,
+        fig: Figure,
+        *,
+        path: Path | None = None,
+        dpi: int | None = None,
+    ) -> Path: ...
+
     def plot(self) -> Axes: ...
 
 
@@ -580,6 +666,12 @@ def date_span_ticks(
     10 % of the span is dropped so the two labels do not collide.  Without
     it the plain in-span candidates are returned (falling back to the two
     endpoints when the locator offers nothing inside).
+
+    When the locator steps by several years, the pinned grid is anchored to
+    the **start year** instead of to multiples of the step: a 2-year step
+    over 2023-2027 gives 2023, 2025, 2027 rather than the pinned 2023 plus
+    the calendar 2024, 2026, whose uneven gaps (and missing odd years) read
+    as if the axis skipped a year.
     """
     lo: float = float(cast(Any, date2num(data_min)))
     hi: float = float(cast(Any, date2num(data_max)))
@@ -589,6 +681,18 @@ def date_span_ticks(
     )
     if not pin_start:
         return [t for t in candidates if lo <= t <= hi] or [lo, hi]
+    chosen: Any = locator.get_locator(  # type: ignore[reportUnknownMemberType]
+        data_min, data_max
+    )
+    if isinstance(chosen, YearLocator):
+        step = int(cast(Any, chosen.base).step)
+        if step > 1:
+            first_year: int = num2date(lo).year
+            last_year: int = num2date(hi).year
+            candidates = [
+                float(cast(Any, date2num(pd.Timestamp(year=y, month=1, day=1))))
+                for y in range(first_year, last_year + 1, step)
+            ]
     min_gap: float = (hi - lo) * 0.10
     interior: list[float] = [
         t for t in candidates if lo < t <= hi and t - lo >= min_gap

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/bar_line.py

@@ -28,7 +28,7 @@ from __future__ import annotations
 
 import locale
 from pathlib import Path
-from typing import Any, Self
+from typing import Any, ClassVar, Self
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -89,6 +89,23 @@ class BarLinePlot:
       (``None`` labels every slot).
     """
 
+    #: Keys that change the PNG but never the ``to_plotly()`` figure
+    #: (see :func:`plotly_unsupported`); checked against real renders
+    #: by ``tests/test_plotly_support.py``.
+    PLOTLY_UNSUPPORTED: ClassVar[frozenset[str]] = frozenset(
+        {
+            "bar_width",
+            "compact",
+            "figsize",
+            "fmt.decimals",
+            "font_pt",
+            "legend.ncol",
+            "max_xticks",
+            "plot_size",
+            "x_rotation",
+        }
+    )
+
     def __init__(
         self,
         out_path: Path,

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/barh_plot.py

@@ -18,7 +18,7 @@ from __future__ import annotations
 
 from enum import Enum
 from pathlib import Path
-from typing import Any, Self
+from typing import Any, ClassVar, Self
 
 import matplotlib.patheffects as pe
 import matplotlib.pyplot as plt
@@ -32,6 +32,7 @@ from matplotlib.ticker import FuncFormatter
 from yaml.nodes import MappingNode
 
 from tesorotools.artists._common import (
+    FigureLifecycle,
     AX_CONFIG,
     Format,
     Legend,
@@ -39,7 +40,6 @@ from tesorotools.artists._common import (
     compact_barh_figsize,
     compact_figure_kwargs,
     compact_font_pt,
-    dynamic_dpi,
     legend_layout,
     place_legend,
     resolve_data,
@@ -447,7 +447,7 @@ def _place_in_or_out_labels(
     return outside
 
 
-class HorizontalBarChart:
+class HorizontalBarChart(FigureLifecycle):
     """Horizontal bar chart artist.
 
     Parameters
@@ -507,6 +507,19 @@ class HorizontalBarChart:
         outside; pragmatic but mixes the two looks).
     """
 
+    #: Keys that change the PNG but never the ``to_plotly()`` figure
+    #: (see :func:`plotly_unsupported`); checked against real renders
+    #: by ``tests/test_plotly_support.py``.
+    PLOTLY_UNSUPPORTED: ClassVar[frozenset[str]] = frozenset(
+        {
+            "color_value_labels",
+            "compact",
+            "figsize",
+            "font_pt",
+            "value_label_position",
+        }
+    )
+
     def __init__(
         self,
         out_path: Path,
@@ -641,7 +654,11 @@ class HorizontalBarChart:
             frame = frame.sort_values(by=_Col.VALUE.value)
         return frame
 
-    def plot(self) -> Axes:
+    def build(self) -> tuple[Figure, Axes]:
+        """Render the chart in memory; :meth:`save` writes it.
+
+        :meth:`plot` (from :class:`FigureLifecycle`) does both.
+        """
         """Render the chart and persist it to ``self.out_path``."""
         frame = self._build_frame()
 
@@ -689,14 +706,10 @@ class HorizontalBarChart:
                 axis="both", labelsize=font_pt
             )
 
-        fig.savefig(  # type: ignore[reportUnknownMemberType]
-            self.out_path, dpi=dynamic_dpi(fig)
-        )
-        plt.close(fig)
-        return ax
+        return fig, ax
 
 
-class GroupedBarChart:
+class GroupedBarChart(FigureLifecycle):
     """Grouped (clustered) horizontal bar chart artist.
 
     Compares two or more series side-by-side within each
@@ -764,6 +777,23 @@ class GroupedBarChart:
         see :class:`HorizontalBarChart`.
     """
 
+    #: Keys that change the PNG but never the ``to_plotly()`` figure
+    #: (see :func:`plotly_unsupported`); checked against real renders
+    #: by ``tests/test_plotly_support.py``.
+    PLOTLY_UNSUPPORTED: ClassVar[frozenset[str]] = frozenset(
+        {
+            "annotate",
+            "color_value_labels",
+            "compact",
+            "figsize",
+            "font_pt",
+            "group_width",
+            "legend.ncol",
+            "plot_size",
+            "value_label_position",
+        }
+    )
+
     def __init__(
         self,
         out_path: Path,
@@ -867,7 +897,11 @@ class GroupedBarChart:
 
         return grouped_bar_to_figure(self)
 
-    def plot(self) -> Axes:
+    def build(self) -> tuple[Figure, Axes]:
+        """Render the chart in memory; :meth:`save` writes it.
+
+        :meth:`plot` (from :class:`FigureLifecycle`) does both.
+        """
         """Render the chart and persist it to ``self.out_path``."""
         cat_ids = list(self.categories.keys())
         ser_ids = list(self.series.keys())
@@ -941,8 +975,4 @@ class GroupedBarChart:
         if self.plot_size is not None and not self.compact:
             adjust_figure_for_plot_size(fig, ax, self.plot_size)
 
-        fig.savefig(  # type: ignore[reportUnknownMemberType]
-            self.out_path, dpi=dynamic_dpi(fig)
-        )
-        plt.close(fig)
-        return ax
+        return fig, ax

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/box_plot.py

@@ -32,7 +32,7 @@ The last-value marker is a circle by default and fully configurable
 from __future__ import annotations
 
 from pathlib import Path
-from typing import Any, Self
+from typing import Any, ClassVar, Self
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -129,6 +129,21 @@ class BoxPlot:
     * ``legend_labels`` -- override the four proxy labels.
     """
 
+    #: Keys that change the PNG but never the ``to_plotly()`` figure
+    #: (see :func:`plotly_unsupported`); checked against real renders
+    #: by ``tests/test_plotly_support.py``.
+    PLOTLY_UNSUPPORTED: ClassVar[frozenset[str]] = frozenset(
+        {
+            "compact",
+            "figsize",
+            "fmt.decimals",
+            "font_pt",
+            "legend.ncol",
+            "plot_size",
+            "x_rotation",
+        }
+    )
+
     def __init__(
         self,
         out_path: Path,

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/line_plot.py

@@ -12,7 +12,7 @@ from __future__ import annotations
 import datetime
 import locale
 from pathlib import Path
-from typing import Any, Self
+from typing import Any, ClassVar, Self
 
 import matplotlib.pyplot as plt
 import pandas as pd
@@ -166,6 +166,28 @@ class LinePlot:
     ``plot()`` is the thin convenience that does both.
     """
 
+    #: Keys that change the PNG but never the ``to_plotly()`` figure
+    #: (see :func:`plotly_unsupported`); checked against real renders
+    #: by ``tests/test_plotly_support.py``.
+    PLOTLY_UNSUPPORTED: ClassVar[frozenset[str]] = frozenset(
+        {
+            "adapt_height",
+            "axis_decimals",
+            "compact",
+            "date_density",
+            "date_rotation",
+            "date_show_start",
+            "figsize",
+            "font_pt",
+            "legend.ncol",
+            "means_window",
+            "plot_size",
+            "ref_lines",
+            "show_means",
+            "vlines",
+        }
+    )
+
     def __init__(
         self,
         out_path: Path,

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/matrix.py

@@ -27,7 +27,7 @@ Styling constants come from ``PLOT_CONFIG['matrix']``.
 from __future__ import annotations
 
 from pathlib import Path
-from typing import Any, Self
+from typing import Any, ClassVar, Self
 
 import matplotlib as mpl
 import matplotlib.pyplot as plt
@@ -40,9 +40,9 @@ from matplotlib.patches import Rectangle
 from yaml.nodes import MappingNode
 
 from tesorotools.artists._common import (
+    FigureLifecycle,
     FIG_CONFIG,
     Format,
-    dynamic_dpi,
     resolve_data,
 )
 from tesorotools.utils.matplotlib import PLOT_CONFIG, format_annotation
@@ -66,7 +66,7 @@ def _text_color(rgba: tuple[float, float, float, float]) -> str:
     return MATRIX_CONFIG["dark_text"]
 
 
-class MatrixChart:
+class MatrixChart(FigureLifecycle):
     """Annotated heatmap-table artist (any ``n_rows x n_cols``).
 
     Parameters
@@ -102,6 +102,16 @@ class MatrixChart:
         cells read as tiles.
     """
 
+    #: Keys that change the PNG but never the ``to_plotly()`` figure
+    #: (see :func:`plotly_unsupported`); checked against real renders
+    #: by ``tests/test_plotly_support.py``.
+    PLOTLY_UNSUPPORTED: ClassVar[frozenset[str]] = frozenset(
+        {
+            "cmap",
+            "figsize",
+        }
+    )
+
     def __init__(
         self,
         out_path: Path,
@@ -199,7 +209,11 @@ class MatrixChart:
 
         return matrix_to_figure(self)
 
-    def plot(self) -> Axes:
+    def build(self) -> tuple[Figure, Axes]:
+        """Render the chart in memory; :meth:`save` writes it.
+
+        :meth:`plot` (from :class:`FigureLifecycle`) does both.
+        """
         """Render the chart and persist it to ``self.out_path``."""
         row_ids = list(self.rows)
         col_ids = list(self.cols)
@@ -260,11 +274,7 @@ class MatrixChart:
                     )
 
         self._style_axes(ax, row_ids, col_ids)
-        fig.savefig(  # type: ignore[reportUnknownMemberType]
-            self.out_path, dpi=dynamic_dpi(fig)
-        )
-        plt.close(fig)
-        return ax
+        return fig, ax
 
     def _annotate_cell(
         self,

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/plotly_backend.py

@@ -35,9 +35,11 @@ backends, per the dual-backend research):
   ``adapt_height``) do nothing here.
 * Beyond those, a few per-artist knobs have no stable Plotly equivalent
   and a few others are simply not translated yet.  Both kinds are
-  accepted in silence, so which is which is written down parameter by
-  parameter in ``docs/plotly-backend.md`` (audited for ``LinePlot``).
-  Keep that table in sync when adding or translating a parameter.
+  accepted in silence; each artist lists them in ``PLOTLY_UNSUPPORTED``
+  (read with :func:`tesorotools.artists.plotly_unsupported`), which
+  ``tests/test_plotly_support.py`` checks against real renders.  When
+  translating a key, drop it from there and from the table in
+  ``docs/plotly-backend.md``.
 """
 
 from __future__ import annotations

{tesorotools_python-0.0.56 → tesorotools_python-0.1.1}/src/tesorotools/artists/shock_plot.py

@@ -30,7 +30,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Self, cast
+from typing import Any, ClassVar, Self, cast
 
 import matplotlib.pyplot as plt
 import pandas as pd
@@ -124,6 +124,18 @@ class ShockChart:
       value instead of each window's own anchor; must be a shock label.
     """
 
+    #: Keys that change the PNG but never the ``to_plotly()`` figure
+    #: (see :func:`plotly_unsupported`); checked against real renders
+    #: by ``tests/test_plotly_support.py``.
+    PLOTLY_UNSUPPORTED: ClassVar[frozenset[str]] = frozenset(
+        {
+            "compact",
+            "figsize",
+            "fmt.decimals",
+            "legend.ncol",
+        }
+    )
+
     def __init__(
         self,
         out_path: Path,