tesorotools-python 0.1.1__py3-none-any.whl → 0.1.2__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

@@ -20,6 +20,9 @@ Each class follows the same shape:
   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
 :mod:`tesorotools.artists._common`.
@@ -42,6 +45,7 @@ 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
@@ -67,4 +71,5 @@ __all__ = [
     "VectorPlot",
     "Waterfall",
     "plotly_unsupported",
+    "share_y_axes",
 ]

tesorotools/artists/_common.py

@@ -23,6 +23,7 @@ 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
 
@@ -1299,6 +1300,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,
@@ -1339,6 +1360,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.
 
@@ -1365,7 +1387,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:
@@ -1437,7 +1460,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/line_plot.py

@@ -11,6 +11,7 @@ from __future__ import annotations
 
 import datetime
 import locale
+from collections.abc import Sequence
 from pathlib import Path
 from typing import Any, ClassVar, Self
 
@@ -30,6 +31,7 @@ from tesorotools.artists._common import (
     adjust_figure_for_plot_size,
     annotate_last_values,
     apply_date_axis,
+    check_y_limits,
     compact_date_axis,
     compact_figure_kwargs,
     compact_font_pt,
@@ -160,6 +162,15 @@ class LinePlot:
       **height** (keeping the width) so the plot area is not
       squashed by a large legend or rotated date labels. Skipped
       when ``plot_size`` is set (that already fixes the axes size).
+    * ``y_limits`` -- fix the y-axis to ``(bottom, top)`` on both
+      backends. The range is strict: the baseline, the reference
+      lines and the end-of-series labels no longer widen it.
+    * ``y_group`` -- name of a group of charts that must share the
+      same y scale (e.g. US and European equities, both base 100,
+      in two separate charts). It does nothing on its own:
+      :func:`tesorotools.artists.share_y_axes` measures every chart
+      of each group and sets the union of their ranges as their
+      ``y_limits``. Mutually exclusive with ``y_limits``.
 
     Render lifecycle: ``build()`` returns ``(Figure, Axes)``
     in memory; ``save(fig)`` persists to ``out_path``;
@@ -223,9 +234,16 @@ class LinePlot:
         ref_lines: list[dict[str, Any]] | None = None,
         show_means: bool = False,
         means_window: tuple[Any, Any] | None = None,
+        y_limits: Sequence[float] | None = None,
+        y_group: str | None = None,
     ) -> None:
         if out_path.suffix != ".png":
             raise ValueError(f"out_path must be .png: {out_path}")
+        if y_limits is not None and y_group is not None:
+            raise ValueError(
+                "y_limits and y_group are mutually exclusive: a group "
+                "computes its shared y_limits (see share_y_axes)"
+            )
         if base_100 and base_0:
             raise ValueError(
                 "base_100 and base_0 are mutually exclusive: a series is "
@@ -269,6 +287,8 @@ class LinePlot:
         self.ref_lines = ref_lines or []
         self.show_means = show_means
         self.means_window = means_window
+        self.y_limits = check_y_limits(y_limits)
+        self.y_group = y_group
 
     @property
     def _pin_start_date(self) -> bool:
@@ -324,7 +344,8 @@ class LinePlot:
         ``axis_decimals``, ``axis_units``, ``annotate_units``,
         ``date_density``, ``date_rotation``, ``date_show_start``,
         ``adapt_height``,
-        ``ref_lines``, ``show_means``, ``means_window``.
+        ``ref_lines``, ``show_means``, ``means_window``,
+        ``y_limits``, ``y_group``.
 
         Example
         -------
@@ -462,6 +483,11 @@ class LinePlot:
             # data point. annotate_last_values reopens room on the right.
             ax.margins(x=0)
 
+        # a fixed (or group-shared) y range goes in BEFORE the annotations:
+        # they pack their labels at the final scale.
+        if self.y_limits is not None:
+            ax.set_ylim(*self.y_limits)
+
         if self.vlines:
             draw_vlines(ax, self.vlines)
 
@@ -494,6 +520,7 @@ class LinePlot:
                 headroom_pad_pt=(
                     compact_headroom_pad_pt() if self.compact else 0.0
                 ),
+                grow_top=self.y_limits is None,
             )
 
         style_spines(
@@ -536,6 +563,10 @@ class LinePlot:
             )
             lo, hi = ax.get_ylim()
             ax.set_ylim(min(ref_line["y"], lo), max(ref_line["y"], hi))
+        if self.y_limits is not None:
+            # the baseline and the reference lines widen the range to show
+            # themselves; a fixed range wins over them.
+            ax.set_ylim(*self.y_limits)
 
         # per-series historical mean as a dotted same-colour line (the old
         # `medias=True`): the mean is taken over means_window (or the whole

tesorotools/artists/plotly_backend.py

@@ -302,6 +302,9 @@ def line_plot_to_figure(chart: LinePlot) -> go.Figure:
     # toggles (mirrors the matplotlib artist).
     if chart.fmt.units and chart.axis_units:
         fig.update_yaxes(ticksuffix=chart.fmt.units)
+    # fixed or group-shared y range (see share_y_axes)
+    if chart.y_limits is not None:
+        fig.update_yaxes(range=list(chart.y_limits))
     _legend_side(fig, chart.legend)
     return fig
 

tesorotools/artists/sharing.py

@@ -0,0 +1,59 @@
+"""One y scale shared by several separate charts.
+
+Two charts that are read side by side (US and European equities, both
+base 100) mislead when each picks its own y range: the same move looks
+bigger in the flatter one.  Charts that declare the same ``y_group``
+are measured together here and all get the union of their ranges as a
+fixed ``y_limits``, which both backends honour (``build()`` for the PNG,
+``to_plotly()`` for the interactive figure).
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from typing import Any
+
+import matplotlib.pyplot as plt
+
+__all__ = ["share_y_axes"]
+
+
+def share_y_axes(charts: Iterable[Any]) -> dict[str, tuple[float, float]]:
+    """Give every chart of each ``y_group`` the same ``y_limits``.
+
+    *charts* is any iterable of artists, typically the values of the
+    mapping loaded from a charts YAML; the ones without a ``y_group``
+    (or with ``None``) are left untouched.  Each grouped chart is built
+    once with its own natural range (the one it would draw alone,
+    including the room its end-of-series labels open), and the group
+    gets the lowest bottom and the highest top among its members.  Call
+    it before ``plot()`` / ``to_plotly()``; calling it again measures
+    afresh, so it is safe after the data change.
+
+    Returns the shared ``(bottom, top)`` per group name.
+    """
+    groups: dict[str, list[Any]] = {}
+    for chart in charts:
+        group: Any = getattr(chart, "y_group", None)
+        if group is not None:
+            groups.setdefault(str(group), []).append(chart)
+
+    shared: dict[str, tuple[float, float]] = {}
+    for name, members in groups.items():
+        bottoms: list[float] = []
+        tops: list[float] = []
+        for chart in members:
+            # measure the chart's own range, not one shared earlier
+            chart.y_limits = None
+            fig, ax = chart.build()
+            try:
+                bottom, top = ax.get_ylim()
+            finally:
+                plt.close(fig)
+            bottoms.append(float(bottom))
+            tops.append(float(top))
+        limits = (min(bottoms), max(tops))
+        for chart in members:
+            chart.y_limits = limits
+        shared[name] = limits
+    return shared

{tesorotools_python-0.1.1.dist-info → tesorotools_python-0.1.2.dist-info}/METADATA

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

{tesorotools_python-0.1.1.dist-info → tesorotools_python-0.1.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-tesorotools/__init__.py,sha256=YQGi1L0Uo1B1ZFmjXFRSUFZI4kx7jeLFpdoi5GbRkJM,5296
+tesorotools/__init__.py,sha256=BV31YV_qabD4vdXzoKb89MxXO386YE0xFjXqpDZSXaE,5334
 tesorotools/_build_context.py,sha256=MH2AKjkwuubN__sBQoXbfTD1bh5RE6w9l5yUFxkJxy8,1982
 tesorotools/_registry.py,sha256=ZJOr7jACxykvzoepebZDiJdTcR37Q3X-DQ07lm9ZYB0,7975
 tesorotools/driver.py,sha256=qEVhLYanbG7VXe3WrCCD0RJV_0X4xzhalrfABPB1gSI,5016
@@ -7,16 +7,17 @@ tesorotools/orchestration.py,sha256=24C-LTM4uy7eckjXBjJbC2t92fg6yffl5H-E9Gm2W9M,
 tesorotools/palette.py,sha256=fkf1_AxweRzviwKLb5zSZnWwP_Cr4zEYoqJ4jqIfBoE,1944
 tesorotools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tesorotools/scaffold.py,sha256=6mYNxLm_1CbEMjcYZ77m_2H1eTotbpatFJqhgyote0s,4578
-tesorotools/artists/__init__.py,sha256=1HJcBKpSbG_NQEf1Knna7-Bqj0Q0Rvr780HrKxESVhE,2326
-tesorotools/artists/_common.py,sha256=xeUq9UUQ6rogaYRiNnFhCATIY9gI28ICn7LydwCet4k,58394
+tesorotools/artists/__init__.py,sha256=-w2IzVdT7iatJien_5JU9fHepx2kTcYcYgrjQXWZYRI,2492
+tesorotools/artists/_common.py,sha256=k59YvyxIlTSEUPU6-koGksOdEKvDcwjhsdPV0LxRCLo,59272
 tesorotools/artists/bar_line.py,sha256=4urcPuHEfohl4WI3pkb2I__1WZ2W73lDiGoqlwFA27w,14477
 tesorotools/artists/barh_plot.py,sha256=n8DjIX1APCVS7HW4zzfh6ehggdgBqb6sezQHov1k7us,37520
 tesorotools/artists/box_plot.py,sha256=KPQjbY2H5JWJWF_icApqpvE1f6sE4e56neIS_dRL6w8,20373
 tesorotools/artists/compact.py,sha256=e_0tqkRSIgyiyMSwirJzj2TYSKojMxUHzug5tE_7toc,3003
 tesorotools/artists/intraday_plot.py,sha256=TO-lKwwbIPxx4T-ObYHNuGGR3F_-GZ6XQGwrYU6tyL8,13259
-tesorotools/artists/line_plot.py,sha256=rUe_naP8prLU8hoLM51AFcFoA_X1s8LwV28KRpSdkiE,29622
+tesorotools/artists/line_plot.py,sha256=yqg7dHzzV_xfiwiWIlvNN6DVXQ9wjRBdOsiJYvG0iJY,31157
 tesorotools/artists/matrix.py,sha256=cOpj9ZO5RR0-RlIP55UmD70i-738ck8wZIqRiDO22Hw,11785
-tesorotools/artists/plotly_backend.py,sha256=cACSkk6-SlURsPF_nWfxAHGaNKsYfUVS8CPijLKjBAw,36924
+tesorotools/artists/plotly_backend.py,sha256=yaRnZayxgTbNVuiJW1p5l10mo5UFMTslA_QK-nBkZsM,37067
+tesorotools/artists/sharing.py,sha256=Tg4AYtv0ileKQmzBSgmT1GzxA97tdU8ji_arE0oGEZ4,2236
 tesorotools/artists/shock_plot.py,sha256=Vx9RRvRaJZIXh8G7oJSRRc1XtPgGkqA6xaVk4h4oJuE,13435
 tesorotools/artists/stacked.py,sha256=MyItTb8NMOpR6jDclqjmofhAB-L9mD1vnzGQjXUTFBc,17439
 tesorotools/artists/type_curve.py,sha256=0j1LjfS4Zdz4_W7qp-nY8VP0H-fENV5adUg4syAOvig,12570
@@ -129,7 +130,7 @@ tesorotools/web/templates/src/$package/main.py.tmpl,sha256=GXG3AA87WOjk5nTKA5Ywm
 tesorotools/web/templates/src/$package/sections.py.tmpl,sha256=4MNZ85AW5ERG1SrkVAXIwdmAMeQEBARCYdAMqUr37mg,2084
 tesorotools/web/templates/tests/__init__.py.tmpl,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tesorotools/web/templates/tests/test_app.py.tmpl,sha256=ZGfV5GPN6WsS3a2gCNLPWejkHTX2H_N9XpurIADuUxI,615
-tesorotools_python-0.1.1.dist-info/METADATA,sha256=HjCChGIyERohQDx-XrWope2gl9EJeC6CkQ5Ceb4-OLM,993
-tesorotools_python-0.1.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-tesorotools_python-0.1.1.dist-info/entry_points.txt,sha256=PuNrObu4SVvajBHTASuWZPqwSsV7tPHwFJBzYk2nY5o,108
-tesorotools_python-0.1.1.dist-info/RECORD,,
+tesorotools_python-0.1.2.dist-info/METADATA,sha256=ARJoWsUX5H4GXfcoU7EH_sVTr5aUusS-9OpkhfTVm-A,993
+tesorotools_python-0.1.2.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+tesorotools_python-0.1.2.dist-info/entry_points.txt,sha256=PuNrObu4SVvajBHTASuWZPqwSsV7tPHwFJBzYk2nY5o,108
+tesorotools_python-0.1.2.dist-info/RECORD,,