Skip to content

iw.current_index is now non-reentrant #829

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

Merged
clewis7 merged 1 commit into from
May 20, 2025
Merged

iw.current_index is now non-reentrant #829

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
61 changes: 37 additions & 24 deletions fastplotlib/widgets/image_widget/_widget.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,33 +195,44 @@ def current_index(self, index: dict[str, int]):
if not self._initialized:
return

if not set(index.keys()).issubset(set(self._current_index.keys())):
raise KeyError(
f"All dimension keys for setting `current_index` must be present in the widget sliders. "
f"The dimensions currently used for sliders are: {list(self.current_index.keys())}"
)
if self._reentrant_block:
return

for k, val in index.items():
if not isinstance(val, int):
raise TypeError("Indices for all dimensions must be int")
if val < 0:
raise IndexError("negative indexing is not supported for ImageWidget")
if val > self._dims_max_bounds[k]:
raise IndexError(
f"index {val} is out of bounds for dimension '{k}' "
f"which has a max bound of: {self._dims_max_bounds[k]}"
try:
self._reentrant_block = True # block re-execution until current_index has *fully* completed execution
if not set(index.keys()).issubset(set(self._current_index.keys())):
raise KeyError(
f"All dimension keys for setting `current_index` must be present in the widget sliders. "
f"The dimensions currently used for sliders are: {list(self.current_index.keys())}"
)

self._current_index.update(index)
for k, val in index.items():
if not isinstance(val, int):
raise TypeError("Indices for all dimensions must be int")
if val < 0:
raise IndexError("negative indexing is not supported for ImageWidget")
if val > self._dims_max_bounds[k]:
raise IndexError(
f"index {val} is out of bounds for dimension '{k}' "
f"which has a max bound of: {self._dims_max_bounds[k]}"
)

for i, (ig, data) in enumerate(zip(self.managed_graphics, self.data)):
frame = self._process_indices(data, self._current_index)
frame = self._process_frame_apply(frame, i)
ig.data = frame
self._current_index.update(index)

# call any event handlers
for handler in self._current_index_changed_handlers:
handler(self.current_index)
for i, (ig, data) in enumerate(zip(self.managed_graphics, self.data)):
frame = self._process_indices(data, self._current_index)
frame = self._process_frame_apply(frame, i)
ig.data = frame

# call any event handlers
for handler in self._current_index_changed_handlers:
handler(self.current_index)
except Exception as exc:
# raise original exception
raise exc # current_index setter has raised. The lines above below are probably more relevant!
finally:
# set_value has finished executing, now allow future executions
self._reentrant_block = False

@property
def n_img_dims(self) -> list[int]:
Expand Down Expand Up @@ -574,10 +585,12 @@ def __init__(

self.figure.add_gui(self._image_widget_sliders)

self._initialized = True

self._current_index_changed_handlers = set()

self._reentrant_block = False

self._initialized = True

@property
def frame_apply(self) -> dict | None:
return self._frame_apply
Expand Down
Loading