Skip to content

Fix: Make the default plot.update function a noop #422

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

Closed
jenshnielsen wants to merge 1 commit into from
Closed

Fix: Make the default plot.update function a noop #422

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
23 changes: 13 additions & 10 deletions qcodes/plots/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ def add(self, *args, updater=None, **kwargs):
If the last one is 1D, may be `y` or `x`, `y`
If the last one is 2D, may be `z` or `x`, `y`, `z`

updater: a callable (with no args) that updates the data in this trace
if omitted, we will look for DataSets referenced in this data, and
call their sync methods.
updater ([Union[callable, string]]): If callable (with no args) callable that
updates the data in this trace. If string 'sync', we will look for DataSets
referenced in this data, and call their sync methods. If None no update is performed.

kwargs: after inserting info found in args and possibly in set_arrays
into `x`, `y`, and optionally `z`, these are passed along to
Expand Down Expand Up @@ -105,23 +105,26 @@ def add_updater(self, updater, plot_config):
"""
Add an updater to the plot.
Args:
updater (callable): callable (with no args) that updates the data in this trace
if omitted, we will look for DataSets referenced in this data, and
call their sync methods.
updater ([Union[callable, string]]): If callable (with no args) callable that
updates the data in this trace. If string 'sync', we will look for DataSets
referenced in this data, and call their sync methods. If None no update is performed.
plot_config (dict): this is a dictionary that gets populated inside
add() via expand_trace().
The reason this is here is to fetch from the data_set the sync method
to use it as an updater.
Raises:
ValueError: if updater is not callable, the string 'sync' or None.
"""
if updater is not None:
self.data_updaters.add(updater)
else:
if updater == 'sync':
for key in self.data_keys:
data_array = plot_config.get(key, '')
if hasattr(data_array, 'data_set'):
if data_array.data_set is not None:
self.data_updaters.add(data_array.data_set.sync)

elif callable(updater):
self.data_updaters.add(updater)
elif updater is not None:
raise ValueError("Updater must be callable on the string sync got {}".format)
# If previous data on this plot became static, perhaps because
# its measurement loop finished, the updater may have been halted.
# If we have new update functions, re-activate the updater
Expand Down