tesorotools-python 0.1.0__py3-none-any.whl → 0.1.3__py3-none-any.whl

tesorotools/__init__.py

@@ -72,6 +72,7 @@ from tesorotools.artists import (
     TypeCurve,
     VectorPlot,
     Waterfall,
+    share_y_axes,
 )
 from tesorotools.orchestration import CompositeRegistry, iter_contexts
 from tesorotools.providers.base import (
@@ -177,6 +178,7 @@ __all__ = [
     "register_providers",
     "register_tag",
     "register_tags",
+    "share_y_axes",
 ]
 
 

tesorotools/artists/__init__.py

@@ -12,9 +12,16 @@ 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.
+
+:func:`share_y_axes` gives the charts that declare the same
+``y_group`` one common y scale.
 
 Shared layout, annotation and styling helpers (plus the
 ``Format`` and ``Legend`` config holders) live in
@@ -25,13 +32,20 @@ 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
 from tesorotools.artists.intraday_plot import IntradayPlot
 from tesorotools.artists.line_plot import LinePlot
 from tesorotools.artists.matrix import MatrixChart
+from tesorotools.artists.sharing import share_y_axes
 from tesorotools.artists.shock_plot import ShockChart
 from tesorotools.artists.stacked import StackedAreaPlot, StackedBarPlot
 from tesorotools.artists.type_curve import TypeCurve
@@ -42,6 +56,7 @@ __all__ = [
     "Artist",
     "BarLinePlot",
     "BoxPlot",
+    "FigureLifecycle",
     "Format",
     "GroupedBarChart",
     "HorizontalBarChart",
@@ -55,4 +70,6 @@ __all__ = [
     "TypeCurve",
     "VectorPlot",
     "Waterfall",
+    "plotly_unsupported",
+    "share_y_axes",
 ]

tesorotools/artists/_common.py

@@ -23,13 +23,18 @@ overrides only need to update ``plots.yaml``.
 
 from __future__ import annotations
 
+from collections.abc import Sequence
 from pathlib import Path
 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 +131,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 +206,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 +233,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 +667,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 +682,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
@@ -1069,6 +1174,7 @@ def place_legend(
     compact: bool,
     ncol: int | None = None,
     position: str = "auto",
+    entries: tuple[list[Any], list[str]] | None = None,
 ) -> MplLegend | None:
     """Place the figure legend, compact-aware, from the labelled artists.
 
@@ -1079,9 +1185,14 @@ def place_legend(
     ``rcParams`` metrics.  ``position`` (``"above"`` / ``"below"`` /
     ``"auto"``) chooses the side through :func:`resolve_legend_position`, so
     a compact chart can carry its legend under the plot instead of over it.
+    ``entries`` passes precomputed ``(handles, labels)`` instead of reading
+    them off *ax* -- for charts whose series span several axes (a
+    ``twinx`` secondary y-axis), in the order the legend should list them.
     Returns ``None`` (drawing nothing) when there are no labels.
     """
-    handles, labels = ax.get_legend_handles_labels()
+    handles, labels = (
+        entries if entries is not None else ax.get_legend_handles_labels()
+    )
     if not labels:
         return None
     side = resolve_legend_position(position, compact=compact)
@@ -1195,6 +1306,26 @@ def style_spines(
     )
 
 
+def check_y_limits(
+    limits: Sequence[float] | None,
+) -> tuple[float, float] | None:
+    """Validate a ``y_limits`` pair and return it as ``(bottom, top)``.
+
+    YAML hands the pair over as a list, so any two-item sequence is
+    accepted; ``None`` (no fixed range) passes through.  Raises
+    ``ValueError`` unless there are exactly two numbers with
+    ``bottom < top``.
+    """
+    if limits is None:
+        return None
+    if len(limits) != 2:
+        raise ValueError(f"y_limits must be (bottom, top): {limits!r}")
+    bottom, top = float(limits[0]), float(limits[1])
+    if not bottom < top:
+        raise ValueError(f"y_limits bottom must be below top: {limits!r}")
+    return bottom, top
+
+
 def style_baseline(
     ax: Axes,
     reference: float = 0,
@@ -1235,6 +1366,7 @@ def annotate_last_values(
     fontsize: float | None = None,
     right_pad_px: float = 10.0,
     headroom_pad_pt: float = 0.0,
+    grow_top: bool = True,
 ) -> None:
     """Label the last non-NaN value of each column on the right.
 
@@ -1261,7 +1393,8 @@ def annotate_last_values(
     y-limit, that limit grows enough to keep this many points
     free and the labels are re-packed at the new scale, so a
     tall stack never spills into a legend above the axes (nor
-    is clipped at the top).
+    is clipped at the top).  ``grow_top=False`` keeps the top
+    y-limit as it is (a fixed or shared y range must not move).
     """
     fig = ax.get_figure()
     if fig is None:
@@ -1333,7 +1466,7 @@ def annotate_last_values(
     pad_px = headroom_pad_pt * fig.dpi / 72.0
     top_axes_px: float = trans.transform((0, ymax))[1]  # type: ignore[reportUnknownArgumentType]
     needed_px = placements[-1] + text_height / 2 + pad_px
-    if needed_px > top_axes_px:
+    if grow_top and needed_px > top_axes_px:
         new_top: float = trans.inverted().transform(  # type: ignore[reportUnknownArgumentType]
             (0, needed_px)
         )[1]

tesorotools/artists/bar_line.py

@@ -1,10 +1,14 @@
 """Bar + line combo chart artist, registered as ``!bar_line``.
 
 Defines :class:`BarLinePlot`: one time-series chart that draws some
-series as **vertical bars** and others as **marked lines** on a single
-shared y-axis.  The canonical use is a secondary magnitude in bars (an
-earnings *surprise* in p.p.) under a primary series as the highlighted
-line (earnings *growth* in %), both read against the same 0 baseline.
+series as **vertical bars** and others as **marked lines**, by default
+on a single shared y-axis.  The canonical use is a secondary magnitude in
+bars (an earnings *surprise* in p.p.) under a primary series as the
+highlighted line (earnings *growth* in %), both read against the same 0
+baseline.  When the scales are too far apart to share an axis (an
+exchange rate around 1.2 against an R^2 between 0 and 1), ``secondary``
+moves any subset of the series, bars or lines, to a right-hand y-axis
+with its own scale, format and title.
 
 Unlike :class:`LinePlot`, the x-axis is **categorical**: one slot per
 observation (``np.arange``) with date-formatted tick labels, so the bars
@@ -28,7 +32,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
@@ -63,7 +67,7 @@ BAR_LINE_CONFIG: dict[str, Any] = PLOT_CONFIG["bar_line"]
 
 
 class BarLinePlot:
-    """Combo chart: vertical bars and marked lines on one shared axis.
+    """Combo chart: vertical bars and marked lines, optionally on two axes.
 
     Parameters mirror the other time-series artists where they overlap
     (``out_path``, ``data`` / ``data_path``, ``scale``, ``start_date`` /
@@ -87,8 +91,41 @@ class BarLinePlot:
       ``date_format`` is applied via ``strftime`` (lower-cased, e.g.
       ``"dic-21"``) to a DatetimeIndex; ``max_xticks`` thins the labels
       (``None`` labels every slot).
+    * ``secondary`` -- ids (from ``bars`` and/or ``lines``) drawn against a
+      second y-axis on the right, with its own scale.  Empty (the default)
+      keeps the single shared axis, ticked on the house side (right).  With
+      a secondary axis the primary one moves to the left, its grid is the
+      only one drawn, and the legend still lists every series in declared
+      order (bars, then lines).  It cannot hold every series: the primary
+      axis would be left empty.
+    * ``secondary_fmt`` -- tick format (``!format``) of the secondary axis;
+      defaults to ``fmt``.
+    * ``ylabel`` / ``secondary_ylabel`` -- y-axis titles (empty: none).
+      ``ylabel`` sits on the primary axis' tick side.
+
+    ``baseline`` draws the 0 line on every axis that holds bars (they grow
+    from it) or, with no bars at all, on the primary axis, so a lines-only
+    axis is never stretched down to 0.
     """
 
+    #: 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",
+            "secondary_fmt.decimals",
+            "x_rotation",
+        }
+    )
+
     def __init__(
         self,
         out_path: Path,
@@ -113,6 +150,10 @@ class BarLinePlot:
         max_xticks: int | None = None,
         compact: bool = False,
         font_pt: float | None = None,
+        secondary: list[str] | None = None,
+        secondary_fmt: Format | None = None,
+        ylabel: str = "",
+        secondary_ylabel: str = "",
     ) -> None:
         if out_path.suffix != ".png":
             raise ValueError(f"out_path must be .png: {out_path}")
@@ -122,6 +163,17 @@ class BarLinePlot:
             raise ValueError(
                 "BarLinePlot needs at least one series in `bars` or `lines`"
             )
+        self.secondary = list(secondary or [])
+        unknown = [c for c in self.secondary if c not in self.bars | self.lines]
+        if unknown:
+            raise ValueError(
+                f"`secondary` ids must be in `bars` or `lines`: {unknown}"
+            )
+        if set(self.secondary) >= {*self.bars, *self.lines}:
+            raise ValueError(
+                "`secondary` cannot hold every series: the primary axis "
+                "would be empty"
+            )
         self.out_path = out_path
         self.data = resolve_data(data, data_path)
         self.scale = scale
@@ -140,6 +192,9 @@ class BarLinePlot:
         self.max_xticks = max_xticks
         self.compact = compact
         self.font_pt = font_pt
+        self.secondary_fmt = secondary_fmt or self.fmt
+        self.ylabel = ylabel
+        self.secondary_ylabel = secondary_ylabel
 
     @classmethod
     def from_yaml(cls, loader: TemplateLoader, node: MappingNode) -> Self:
@@ -162,7 +217,8 @@ class BarLinePlot:
         ``fmt`` (``!format``), ``legend`` (``!legend``), ``figsize``,
         ``plot_size``, ``bar_styles`` / ``line_styles``, ``bar_width``,
         ``date_format``, ``x_rotation``, ``max_xticks``, ``compact``,
-        ``font_pt``.
+        ``font_pt``, ``secondary``, ``secondary_fmt`` (``!format``),
+        ``ylabel`` / ``secondary_ylabel``.
 
         Example
         -------
@@ -177,6 +233,26 @@ class BarLinePlot:
                 surprise: "Sorpresa (pp)"
               fmt: !format {decimals: 0}
               legend: !legend {}
+
+        With scales too far apart for one axis, send some series to the
+        right-hand axis:
+
+        .. code-block:: yaml
+
+            eurusd_fair_value: !bar_line
+              out_path: out/eurusd_fair_value.png
+              data_path: data/eurusd.feather
+              bars:
+                r2: "R^2"
+              lines:
+                eurusd: "EURUSD"
+                fair_value: "Modelo valor justo (60 días)"
+              secondary: [r2]
+              fmt: !format {decimals: 2}
+              secondary_fmt: !format {decimals: 1}
+              ylabel: "EURUSD"
+              secondary_ylabel: "Coeficiente de determinación (R^2)"
+              legend: !legend {}
         """
         cfg: dict[str, Any] = loader.construct_mapping(  # type: ignore[assignment]
             node, deep=True
@@ -270,9 +346,13 @@ class BarLinePlot:
             **compact_figure_kwargs(self.compact, self.figsize)
         )
         ax: Axes = fig.add_subplot()
+        ax2: Axes | None = ax.twinx() if self.secondary else None
+
+        def target(col: str) -> Axes:
+            return ax2 if ax2 is not None and col in self.secondary else ax
 
         # Bars first (behind the lines). Several bar series share each slot,
-        # dodged side by side; a single series is centred.
+        # dodged side by side (across both axes); a single one is centred.
         n_bars = len(self.bars)
         each = self.bar_width / n_bars if n_bars else self.bar_width
         default_alpha: float = float(BAR_LINE_CONFIG["bar"].get("alpha", 0.9))
@@ -282,7 +362,7 @@ class BarLinePlot:
             style.setdefault("alpha", default_alpha)
             offset = (j - (n_bars - 1) / 2) * each
             values = plot_data[col].fillna(0).to_numpy(dtype=np.float64)
-            ax.bar(  # type: ignore[reportUnknownMemberType]
+            target(col).bar(  # type: ignore[reportUnknownMemberType]
                 x + offset,
                 values,
                 width=each,
@@ -300,7 +380,7 @@ class BarLinePlot:
             style.setdefault("marker", line_cfg.get("marker", "o"))
             style.setdefault("linewidth", line_cfg.get("linewidth", 2))
             style.setdefault("markersize", line_cfg.get("markersize", 5))
-            ax.plot(  # type: ignore[reportUnknownMemberType]
+            target(col).plot(  # type: ignore[reportUnknownMemberType]
                 x,
                 plot_data[col].to_numpy(dtype=np.float64),
                 label=label,
@@ -319,14 +399,31 @@ class BarLinePlot:
         # style_spines enables the y grid only (axis="y"), which is what these
         # charts read against; the categorical x-axis stays gridless.
         if self.baseline:
-            style_baseline(ax, 0, **AX_CONFIG["baseline"])
-
+            on_primary, on_secondary = self._baseline_on()
+            for axis, on in ((ax, on_primary), (ax2, on_secondary)):
+                if on and axis is not None:
+                    style_baseline(axis, 0, **AX_CONFIG["baseline"])
+
+        side = "right"
+        if ax2 is not None:
+            side = "left"
+            ax.yaxis.tick_left()
+            self._style_secondary(ax, ax2, font_pt)
         if self.compact:
-            style_compact_axes(ax, font_pt, side="right")
+            style_compact_axes(ax, font_pt, side=side)
+        if self.ylabel:
+            ax.yaxis.set_label_position(side)  # type: ignore[reportArgumentType]
+            ax.set_ylabel(  # type: ignore[reportUnknownMemberType]
+                self.ylabel, fontsize=font_pt
+            )
 
         if self.legend is not None:
             place_legend(
-                fig, ax, compact=self.compact, **legend_layout(self.legend)
+                fig,
+                ax,
+                compact=self.compact,
+                entries=self._legend_entries(ax, ax2),
+                **legend_layout(self.legend),
             )
 
         if self.plot_size is not None and not self.compact:
@@ -334,6 +431,58 @@ class BarLinePlot:
 
         return fig, ax
 
+    def _baseline_on(self) -> tuple[bool, bool]:
+        """``(primary, secondary)``: the axes that get the 0 line.
+
+        Those holding bars (they grow from 0) or, with no bars at all, the
+        primary one.  Shared by :meth:`build` and :meth:`to_plotly`.
+        """
+        on_secondary = [c in self.secondary for c in self.bars]
+        secondary = any(on_secondary)
+        primary = not all(on_secondary) or not secondary
+        return primary, secondary
+
+    def _style_secondary(
+        self, ax: Axes, ax2: Axes, font_pt: float | None
+    ) -> None:
+        """Style the right-hand axis: own format, no grid, title, z-order.
+
+        The twin is drawn above the primary by default, which would hide
+        the primary series behind secondary bars; when the secondary holds
+        bars the primary is brought forward with a transparent background.
+        """
+        style_spines(
+            ax2,
+            decimals=self.secondary_fmt.decimals,
+            units=self.secondary_fmt.units,
+            **AX_CONFIG["spines"],
+        )
+        ax2.grid(False)  # type: ignore[reportUnknownMemberType]
+        if self.compact:
+            style_compact_axes(ax2, font_pt, side="right")
+        if self.secondary_ylabel:
+            ax2.set_ylabel(  # type: ignore[reportUnknownMemberType]
+                self.secondary_ylabel, fontsize=font_pt
+            )
+        if any(c in self.secondary for c in self.bars):
+            ax.set_zorder(ax2.get_zorder() + 1)
+            ax.patch.set_visible(False)
+
+    def _legend_entries(
+        self, ax: Axes, ax2: Axes | None
+    ) -> tuple[list[Any], list[str]]:
+        """Handles and labels of both axes, in declared order."""
+        handles, labels = ax.get_legend_handles_labels()
+        if ax2 is not None:
+            more_handles, more_labels = ax2.get_legend_handles_labels()
+            handles, labels = handles + more_handles, labels + more_labels
+        order = [*self.bars.values(), *self.lines.values()]
+        pairs = sorted(
+            zip(handles, labels, strict=True),
+            key=lambda pair: order.index(pair[1]),
+        )
+        return [h for h, _ in pairs], [label for _, label in pairs]
+
     def save(
         self,
         fig: Figure,