Add typed panel model for multiple column charts - #553
Closed
palewire wants to merge 1 commit into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a typed MultipleColumnPanel Pydantic model to represent MultipleColumnChart.panels, ensuring panels are handled as first-class typed objects while still round-tripping unknown/custom panel options.
Changes:
- Introduces
MultipleColumnPaneland convertsMultipleColumnChart.panelsfromlist[dict]tolist[MultipleColumnPanel]via afield_validator. - Updates multiple-column chart serialization to emit panels from typed models (including alias handling and extra fields).
- Exports
MultipleColumnPanelfrom bothdatawrapper.chartsand top-leveldatawrapper, and extends integration tests accordingly.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tests/integration/test_multiple_column_chart.py | Adds coverage ensuring panels convert to typed models and preserve aliases/extra fields through serialize/deserialize. |
| datawrapper/charts/multiple_column.py | Introduces MultipleColumnPanel, types MultipleColumnChart.panels, converts dict inputs to models, and updates serialization. |
| datawrapper/charts/init.py | Re-exports MultipleColumnPanel from datawrapper.charts. |
| datawrapper/init.py | Re-exports MultipleColumnPanel from top-level datawrapper. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+82
to
+84
| def serialize_model(self) -> dict[str, Any]: | ||
| """Serialize the panel to Datawrapper's API format.""" | ||
| return self.model_dump(by_alias=True, exclude_none=True) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
MultipleColumnPanelPydantic model forMultipleColumnChart.panelsdatawrapperanddatawrapper.chartsFixes #495.
Tests
uv run pytest tests/integration/test_multiple_column_chart.py tests/integration/test_multiple_column_sample_annotations.py tests/unit/test_multiple_column_range_annotation_subclasses.py tests/unit/test_plot_height_mode_enum.py -quv run ruff check datawrapper/charts/multiple_column.py datawrapper/charts/__init__.py datawrapper/__init__.py tests/integration/test_multiple_column_chart.pyuv run ruff format --check datawrapper/charts/multiple_column.py datawrapper/charts/__init__.py datawrapper/__init__.py tests/integration/test_multiple_column_chart.pygit diff --check