Implement histogram trace type

.github/workflows/ci.yml

@@ -37,9 +37,9 @@ jobs:
       #  env:
       #    SKIP: "no-commit-to-branch"
       #  run: tox -e pre-commit-all
-      - name: Run type checks with mypy
+      - name: Run type checks
         shell: bash
-        run: tox -e mypy-safe
+        run: tox -e typing
 
   # Run test suits for all supported platforms and Python versions
   software-tests:

.pre-commit-config.yaml

@@ -100,19 +100,9 @@ repos:
         args: [ --no-build-isolation ]
         additional_dependencies: [setuptools-scm]
 
-  - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.19.1
-    hooks:
-      - id: blacken-docs
-
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.10.0
-    hooks:
-      - id: black-jupyter
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.8.1
     hooks:
+      - id: ruff-format
       - id: ruff
         args: [ --show-fixes, --exit-non-zero-on-fix ]
-        types_or: [ python, pyi, jupyter ]

MANIFEST.in

@@ -8,6 +8,7 @@ include *.md
 include *.toml
 include *.yml
 include *.yaml
+include *.json
 
 # Stubs
 recursive-include src py.typed *.pyi

cicd_utils/README.md

@@ -16,6 +16,7 @@ For this reason, the `cicd_utils` directory needs to be made explicitly discover
 Static analysis tools will also we need to be made aware of this package:
 
 - For mypy, we can add it to the `files` option in `mypy.ini` to help with import discovery.
+- For pyright, we can add it to the `extraPaths` option in `pyrightconfig.json`.
 - For ruff's _isort_-implementation, we also added it to the `known-first-party` list (see `ruff.toml`)
 
 ### The `cicd/scripts` directory

cicd_utils/cicd/compile_plotly_charts.py

@@ -5,6 +5,7 @@
 used in the docs. It saves the HTML and WebP artefacts to the
 `docs/_static/charts` directory.
 """
+
 from __future__ import annotations
 
 from copy import deepcopy
@@ -116,9 +117,9 @@ def _write_plotlyjs_bundle() -> None:
     bundle_path.write_text(plotlyjs, encoding="utf-8")
 
 
-def compile_plotly_charts() -> None:
-    # Setup logic ---
-    # _write_plotlyjs_bundle()
+def compile_plotly_charts(update_plotlyjs_bundle: bool = False) -> None:
+    if update_plotlyjs_bundle:
+        _write_plotlyjs_bundle()
 
     # Compile all charts ---
     if not PATH_STATIC_CHARTS.exists():

cicd_utils/cicd/scripts/extract_latest_release_notes.py

@@ -6,6 +6,7 @@
 - The output is written to the `LATEST_RELEASE_NOTES.md` file.
 - The body of this file is then used as the body of the GitHub release.
 """
+
 from __future__ import annotations
 
 from pathlib import Path

cicd_utils/ridgeplot_examples/__init__.py

@@ -24,6 +24,12 @@ def load_basic() -> go.Figure:
     return main()
 
 
+def load_basic_hist() -> go.Figure:
+    from ._basic_hist import main
+
+    return main()
+
+
 def load_lincoln_weather() -> go.Figure:
     from ._lincoln_weather import main
 
@@ -44,6 +50,7 @@ def load_probly() -> go.Figure:
 
 ALL_EXAMPLES: list[tuple[str, Callable[[], go.Figure]]] = [
     ("basic", load_basic),
+    ("basic_hist", load_basic_hist),
     ("lincoln_weather", load_lincoln_weather),
     ("lincoln_weather_red_blue", load_lincoln_weather_red_blue),
     ("probly", load_probly),

cicd_utils/ridgeplot_examples/_basic.py

@@ -12,9 +12,9 @@ def main() -> go.Figure:
     from ridgeplot import ridgeplot
 
     rng = np.random.default_rng(42)
-    my_samples = [rng.normal(n / 1.2, size=600) for n in range(7, 0, -1)]
+    my_samples = [rng.normal(n / 1.2, size=600) for n in range(6, 0, -1)]
     fig = ridgeplot(samples=my_samples)
-    fig.update_layout(height=400, width=800)
+    fig.update_layout(height=350, width=800)
 
     return fig
 

cicd_utils/ridgeplot_examples/_basic_hist.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    import plotly.graph_objects as go
+
+
+def main() -> go.Figure:
+    import numpy as np
+
+    from ridgeplot import ridgeplot
+
+    rng = np.random.default_rng(42)
+    my_samples = [rng.normal(n / 1.2, size=600) for n in range(7, 0, -1)]
+    fig = ridgeplot(samples=my_samples, nbins=20)
+    fig.update_layout(height=350, width=800)
+
+    return fig
+
+
+if __name__ == "__main__":
+    fig = main()
+    fig.show()

cicd_utils/ridgeplot_examples/_lincoln_weather.py

@@ -22,11 +22,11 @@ def main(
 
     df = load_lincoln_weather()
 
-    months = df.index.month_name().unique()  # type: ignore[attr-defined]
+    months = df.index.month_name().unique()  # pyright: ignore[reportAttributeAccessIssue]
     samples = [
         [
-            df[df.index.month_name() == month]["Min Temperature [F]"],  # type: ignore[attr-defined]
-            df[df.index.month_name() == month]["Max Temperature [F]"],  # type: ignore[attr-defined]
+            df[df.index.month_name() == month]["Min Temperature [F]"],  # pyright: ignore[reportAttributeAccessIssue]
+            df[df.index.month_name() == month]["Max Temperature [F]"],  # pyright: ignore[reportAttributeAccessIssue]
         ]
         for month in months
     ]

docs/api/index.rst

@@ -9,16 +9,6 @@ API Reference
    ridgeplot.ridgeplot
 
 
-Color utilities
-===============
-
-.. autosummary::
-   :toctree: public/
-   :nosignatures:
-
-   ridgeplot.list_all_colorscale_names
-
-
 Data loading utilities
 ======================
 

docs/api/internal/_obj/traces.rst

@@ -0,0 +1,10 @@
+ridgeplot._obj.traces
+================
+
+Object-oriented trace interfaces.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   traces/*

docs/api/internal/_obj/traces/area.rst

@@ -0,0 +1,7 @@
+ridgeplot._obj.traces.area
+===========================
+
+Area trace object.
+
+.. automodule:: ridgeplot._obj.traces.area
+   :private-members:

docs/api/internal/_obj/traces/bar.rst

@@ -0,0 +1,7 @@
+ridgeplot._obj.traces.bar
+===========================
+
+Bar trace object.
+
+.. automodule:: ridgeplot._obj.traces.bar
+   :private-members:

docs/api/internal/_obj/traces/base.rst

@@ -0,0 +1,7 @@
+ridgeplot._obj.traces.base
+===========================
+
+Base trace object and utilities.
+
+.. automodule:: ridgeplot._obj.traces.base
+   :private-members:

docs/api/internal/hist.rst

@@ -0,0 +1,7 @@
+ridgeplot._hist
+==============
+
+Histogram utilities.
+
+.. automodule:: ridgeplot._hist
+   :private-members:

docs/api/internal/obj.rst

@@ -0,0 +1,10 @@
+ridgeplot._obj
+================
+
+Object-oriented interfaces.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   _obj/*

docs/conf.py

@@ -3,13 +3,14 @@
 import sys
 from contextlib import contextmanager
 from datetime import datetime
+from importlib import import_module
 from pathlib import Path
 from typing import TYPE_CHECKING
 
 try:
     import importlib.metadata as importlib_metadata
 except ImportError:
-    import importlib_metadata  # type: ignore[no-redef]
+    import importlib_metadata  # pyright: ignore[no-redef]
 
 try:
     from cicd.compile_plotly_charts import compile_plotly_charts
@@ -204,9 +205,9 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "packaging": ("https://packaging.pypa.io/en/latest", None),
-    "numpy": ("https://docs.scipy.org/doc/numpy/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
-    "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
     "statsmodels": ("https://www.statsmodels.org/stable/", None),
     "plotly": ("https://plotly.com/python-api-reference/", None),
 }
@@ -263,18 +264,9 @@
     # ------- ._color.interpolation ----------------
     "ridgeplot._color.interpolation.ColorscaleInterpolants",
     "ridgeplot._color.interpolation.SolidColormode",
-    # ------- ._figure_factory ---------------------
-    "ridgeplot._figure_factory.TraceType",
-    "ridgeplot._figure_factory.TraceTypesArray",
-    "ridgeplot._figure_factory.ShallowTraceTypesArray",
-    "ridgeplot._figure_factory.LabelsArray",
-    "ridgeplot._figure_factory.ShallowLabelsArray",
     # ------- ._kde --------------------------------
     "ridgeplot._kde.KDEPoints",
     "ridgeplot._kde.KDEBandwidth",
-    "ridgeplot._kde.SampleWeights",
-    "ridgeplot._kde.SampleWeightsArray",
-    "ridgeplot._kde.ShallowSampleWeightsArray",
     # ------- ._missing ----------------------------
     "ridgeplot._missing.MISSING",
     "ridgeplot._missing.MissingType",
@@ -298,13 +290,32 @@
     "ridgeplot._types.SamplesRow",
     "ridgeplot._types.Samples",
     "ridgeplot._types.ShallowSamples",
+    "ridgeplot._types.TraceType",
+    "ridgeplot._types.TraceTypesArray",
+    "ridgeplot._types.ShallowTraceTypesArray",
+    "ridgeplot._types.LabelsArray",
+    "ridgeplot._types.ShallowLabelsArray",
+    "ridgeplot._types.SampleWeights",
+    "ridgeplot._types.SampleWeightsArray",
+    "ridgeplot._types.ShallowSampleWeightsArray",
 }
+for fq in _TYPE_ALIASES_FULLY_QUALIFIED:
+    module_name, _, type_name = fq.rpartition(".")
+    try:
+        import_module(module_name)
+    except ImportError as e:
+        raise AssertionError(f"Type alias {fq!r} is not importable: {e}") from e
+
 _TYPE_ALIASES = {fq.split(".")[-1]: fq for fq in _TYPE_ALIASES_FULLY_QUALIFIED}
 autodoc_type_aliases = {
     **{a: a for a in _TYPE_ALIASES.values()},
     **{fq: fq for fq in _TYPE_ALIASES.values()},
 }
 napoleon_type_aliases = {a: f":data:`~{fq}`" for a, fq in _TYPE_ALIASES.items()}
+EXTRA_NAPOLEON_ALIASES = {
+    "Collection[Color]": r":data:`~collections.abc.Collection`\[:data:`~ridgeplot._types.Color`\]",
+}
+napoleon_type_aliases.update(EXTRA_NAPOLEON_ALIASES)
 
 
 # -- sphinx_remove_toctrees ------------------------------------------------------------------------
@@ -380,5 +391,5 @@ def setup(app: Sphinx) -> None:
     compile_plotly_charts()
     # app.connect("html-page-context", register_jinja_functions)
 
-    app.connect("build-finished", lambda *_: _fix_generated_public_api_rst())
-    app.connect("build-finished", lambda *_: _fix_html_charts())
+    app.connect("build-finished", lambda *_: _fix_generated_public_api_rst())  # pyright: ignore[reportUnknownLambdaType]
+    app.connect("build-finished", lambda *_: _fix_html_charts())  # pyright: ignore[reportUnknownLambdaType]