tesorotools-python 0.1.2__tar.gz → 0.1.3__tar.gz

{tesorotools_python-0.1.2 → tesorotools_python-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tesorotools-python
-Version: 0.1.2
+Version: 0.1.3
 Requires-Python: >=3.13
 Requires-Dist: babel>=2.17
 Requires-Dist: matplotlib>=3.10

{tesorotools_python-0.1.2 → tesorotools_python-0.1.3}/src/tesorotools/artists/_common.py

@@ -1174,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.
 
@@ -1184,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)

{tesorotools_python-0.1.2 → tesorotools_python-0.1.3}/src/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
@@ -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,6 +91,21 @@ 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
@@ -102,6 +121,7 @@ class BarLinePlot:
             "legend.ncol",
             "max_xticks",
             "plot_size",
+            "secondary_fmt.decimals",
             "x_rotation",
         }
     )
@@ -130,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}")
@@ -139,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
@@ -157,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:
@@ -179,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
         -------
@@ -194,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
@@ -287,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))
@@ -299,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,
@@ -317,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,
@@ -336,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:
@@ -351,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,

{tesorotools_python-0.1.2 → tesorotools_python-0.1.3}/src/tesorotools/artists/plotly_backend.py

@@ -197,10 +197,11 @@ def _legend_side(fig: go.Figure, legend: Legend | None) -> None:
     )
 
 
-def _baseline(fig: go.Figure, reference: float) -> None:
-    """Draw the house baseline (axhline) at *reference*."""
+def _baseline(fig: go.Figure, reference: float, *, yref: str = "y") -> None:
+    """Draw the house baseline (axhline) at *reference* on axis *yref*."""
     fig.add_hline(
         y=reference,
+        yref=yref,
         line_color=AX_CONFIG["baseline"]["color"],
         line_width=AX_CONFIG["baseline"]["linewidth"],
     )
@@ -503,7 +504,8 @@ def bar_line_to_figure(chart: BarLinePlot) -> go.Figure:
     """Interactive ``Figure`` from a :class:`BarLinePlot`.
 
     Bars (grouped) and marked lines share one y-axis over a categorical
-    x-axis of the same date-formatted labels the matplotlib artist uses.
+    x-axis of the same date-formatted labels the matplotlib artist uses;
+    the ``secondary`` series go to an overlaid right-hand ``yaxis2``.
     """
     plot_data = chart._prepare_data()
     palette = _house_palette()
@@ -515,6 +517,9 @@ def bar_line_to_figure(chart: BarLinePlot) -> go.Figure:
     default_alpha = float(BAR_LINE_CONFIG["bar"].get("alpha", 0.9))
     line_cfg = BAR_LINE_CONFIG["line"]
 
+    def yaxis(col: str) -> str:
+        return "y2" if col in chart.secondary else "y"
+
     for j, (col, label) in enumerate(chart.bars.items()):
         style = chart.bar_styles.get(col, {})
         color = (
@@ -525,6 +530,7 @@ def bar_line_to_figure(chart: BarLinePlot) -> go.Figure:
                 x=x,
                 y=plot_data[col].fillna(0),
                 name=label,
+                yaxis=yaxis(col),
                 marker_color=_color(color, style.get("alpha", default_alpha)),
             )
         )
@@ -541,6 +547,7 @@ def bar_line_to_figure(chart: BarLinePlot) -> go.Figure:
                 y=plot_data[col],
                 mode="lines+markers",
                 name=label,
+                yaxis=yaxis(col),
                 line={
                     "color": _color(color),
                     "width": style.get(
@@ -552,10 +559,27 @@ def bar_line_to_figure(chart: BarLinePlot) -> go.Figure:
         )
 
     fig.update_layout(barmode="group")
+    if chart.ylabel:
+        fig.update_layout(yaxis_title_text=chart.ylabel)
+    if chart.secondary:
+        fig.update_layout(
+            yaxis_side="left",
+            yaxis2={
+                "overlaying": "y",
+                "side": "right",
+                "showgrid": False,
+                "ticksuffix": chart.secondary_fmt.units,
+                "title_text": chart.secondary_ylabel,
+            },
+        )
     if chart.baseline:
-        _baseline(fig, 0)
+        on_primary, on_secondary = chart._baseline_on()
+        if on_primary:
+            _baseline(fig, 0)
+        if on_secondary:
+            _baseline(fig, 0, yref="y2")
     if chart.fmt.units:
-        fig.update_yaxes(ticksuffix=chart.fmt.units)
+        fig.update_layout(yaxis_ticksuffix=chart.fmt.units)
     _legend_side(fig, chart.legend)
     return fig