[Flix6x]

Description

Part of #2795: registries of named asset and sensor chart types, planned for v1.2.0.

So far, an asset's or sensor's chart-type was the name of a function in belief_charts. This PR gives each chart type a public, kebab-case name, plus a label, a description, and the assets or sensors it applies to; an asset chart type also has its layout (the graphs it draws, in the sensors_to_show format). They live in two registries (one for assets, one for sensors) in flexmeasures/data/models/charts/chart_types.py, which share their registration and lookup (ChartTypeRegistry).

• The registry holds two built-in chart types:

  • default (was chart_for_multiple_sensors);
  • charge-point-sessions (was chart_for_chargepoint_sessions), which applies only to assets with charge points.

  Which graphs the Charge Points chart draws below its sessions is now decided in one place.

• AssetChartTypeField validates chart-type on GET /api/v3_0/assets/<id>/chart against the registry as it is at request time.

  • The old function names are still accepted, and the docs call them deprecated.
  • The OpenAPI enum lists the built-in types.

• The asset page asks for its charts by public name and builds its chart picker from the registry.

• Plugins can register asset chart types through register_asset_chart_type, the same function that registers the built-in ones.

  • It refuses names that are already taken.
  • The chart type's fields are marked provisional.
  • documentation/plugin/customisation.rst has a short section on it.

• Sensor chart types get the same treatment:

  • bar-chart (was bar_chart), histogram, daily-heatmap (was daily_heatmap) and weekly-heatmap (was weekly_heatmap); the old names stay accepted (sessions, bookmarked URLs).
  • GET /api/ui/sensor/<id>/chart validates chart-type against the registry at request time (unknown names still get the 422 from Build only the listed chart types, and leave the chart defaults alone #2801), and the session keeps the public name.
  • chart_type_to_chart_specs builds from the registry; CHART_TYPES/SENSOR_CHART_TYPES are the registry.
  • Plugins register their own through register_sensor_chart_type, which refuses taken names.
  • The sensor page builds its picker from the registry (the types that apply to the sensor), and starts with the last chosen type where it applies.

• The fast chart draws the built-in chart types by their public names (and still the legacy ones). For a chart type it does not know, such as one a plugin registered, the asset and sensor pages show the Vega-Lite chart, and disable the fast-chart toggle while it is picked.

• Fixes a Charge Points chart bug: a "Power flow by type" graph now shows only the charge points power, also when its title starts with a lowercase letter.

• Tests for both registries, the fields, the endpoints (public, legacy and snake_case names), the pickers, the fast chart's chart types, and chart types registered by a plugin after the app started.

• Changelog entries in new v1.2.0 and v3.0-41 sections.

Look & Feel

No visible change. The asset and sensor pages' chart pickers offer the same charts as before, under the same labels.

How to test

uv run pytest flexmeasures/data/tests/test_chart_types.py flexmeasures/api/ui/tests flexmeasures/api/v3_0/tests/test_assets_api.py flexmeasures/ui/tests

Before merging

• Merge main once Build only the listed chart types, and leave the chart defaults alone #2801 is in. Build only the listed chart types, and leave the chart defaults alone #2801 allow-lists the chart types chart_type_to_chart_specs builds, including the asset ones. When resolving that merge, the asset ones belong to this registry, so Build only the listed chart types, and leave the chart defaults alone #2801's list keeps only the sensor chart types. The resolution has been tried locally (all tests pass).
• Fill in the PR number in the changelog entries.

Further Improvements

• Let asset chart data rest on the registry of chart types #2802: let chart_data (from perf: load only the data each asset chart type draws #2790) use the registry's names and layouts.
• Chart types as a public, renderer-neutral feature: a registry of named layouts for /chart and /chart_data #2795: renderer-neutral layouts, so the fast chart can draw a chart type a plugin brings.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UBBvKZkzbfEPKctwTN8SDf

[read-the-docs-community]

Documentation build overview

📚 flexmeasures | 🛠️ Build #35605973 | 📁 Comparing 7990439 against latest (37e9faa)

  🔍 Preview build  

17 files changed · + 2 added · ± 15 modified

+ Added

• _autosummary/flexmeasures.data.models.charts.chart_types.html
• _autosummary/flexmeasures.data.schemas.charts.html

± Modified

• changelog.html
• genindex.html
• py-modindex.html
• _autosummary/flexmeasures.api.ui.sensors.html
• _autosummary/flexmeasures.api.v3_0.assets.html
• _autosummary/flexmeasures.data.models.charts.belief_charts.html
• _autosummary/flexmeasures.data.models.charts.html
• _autosummary/flexmeasures.data.models.generic_assets.html
• _autosummary/flexmeasures.data.models.time_series.html
• _autosummary/flexmeasures.data.schemas.html
• and 5 more...

[Flix6x]

Brought this branch up to date with main and renumbered its API change log section, since v1.1.0 shipped with API version v3.0-34 (#2818):

• 03becfe merges main. Conflicts: the changelog entries move into main's v1.2.0 section; the API section now sits on top of v3.0-34, and its sentence about the 422 for an unknown chart-type is dropped, as v3.0-34 already ships that; in test_fast_chart.py, the tests both sides added are all kept.
• 7c8ade2 renumbers the API section from v3.0-41 to v3.0-35, the next unreleased version. No other file referred to v3.0-41.

The chart type tests (Python and JS, 155) pass locally.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UBBvKZkzbfEPKctwTN8SDf