Skip to content

Fix FigureWidget compound array property synchronization (Fixes #5689) #5714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
seshan18 wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −0
Open

Fix FigureWidget compound array property synchronization (Fixes #5689) #5714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8619b9
Fix FigureWidget compound array property synchronization (Fixes #5689)
seshan18 Aug 28, 2026
fb82089
Add changelog entry for FigureWidget array property fix (#5689)
seshan18 Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
### Added
- Support `marginal_x`/`marginal_y="heatmap"` in `density_heatmap`, drawing a single-row/column heatmap strip in the margin colored by the same `z`/`histfunc` aggregate as the main plot and sharing its color scale [[#5706](https://github.com/plotly/plotly.py/issues/5706)], with thanks to @lucasjamar for the contribution!

### Fixed
- Fix `FigureWidget` state synchronization bug where frontend modifications to array properties (like `layout.shapes`) failed to properly update the Python property cache and occasionally surfaced `Undefined` objects [[#5689](https://github.com/plotly/plotly.py/issues/5689)]

## [7.0.0] - 2026-08-25

### Fixed
Expand Down
10 changes: 10 additions & 0 deletions plotly/basedatatypes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5458,6 +5458,16 @@ def _dispatch_change_callbacks(self, changed_paths):
-------
None
"""
# Invalidate cache for changed compound array properties so that they are
# reconstructed from the underlying properties dictionary on the next access.
# We only pop from _compound_array_props because compound arrays are immutable
# tuples that must be rebuilt to reflect added or removed elements.
for path in changed_paths:
if len(path) > 0:
prop = path[0]
if prop in self._compound_array_props:
self._compound_array_props.pop(prop, None)

# Loop over registered callbacks
# ------------------------------
for prop_path_tuples, callbacks in self._change_callbacks.items():
Expand Down
Loading