FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

ENH: Add the ability to block callback signals by greglucas · Pull Request #20816 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

ENH: Add the ability to block callback signals - #20816

Merged
timhoffm merged 1 commit into
matplotlib:masterfrom
greglucas:callback-blocking
Aug 12, 2021
ConversationCommits (1)ChecksFiles changed
Merged

ENH: Add the ability to block callback signals#20816
timhoffm merged 1 commit into
matplotlib:masterfrom
greglucas:callback-blocking

Conversation

greglucas commented Aug 10, 2021

Copy link
Copy Markdown
Contributor

PR Summary

CallbackRegistry objects gain a context manager .block() method that can be used to temporarily block callback signals from being processed.

with callbacks.block():
    callbacks.process("test")  # Does nothing
with callbacks.block(signal="test"):
    callbacks.process("test")  # Does nothing

Closes #20802
Would help with disabling norm update signals in #19553

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

story645 reviewed Aug 10, 2021
View reviewed changes

story645 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think this could be really useful for debugging interactive stuff, so tentatively 👍

Comment thread lib/matplotlib/cbook/__init__.py Outdated
greglucas force-pushed the callback-blocking branch 2 times, most recently from a9680e7 to ad95b35 Compare August 10, 2021 23:13
story645 approved these changes Aug 10, 2021
View reviewed changes

story645 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

minor nits, but liking the new docs :)

Comment thread lib/matplotlib/cbook/__init__.py Outdated
Comment thread lib/matplotlib/cbook/__init__.py

timhoffm commented Aug 11, 2021

Copy link
Copy Markdown
Member

What do you think about naming this blocked()? I like to use context manager names that are not imperative verbs and cannot be confused with simple functions. There is no general convention on this in the community, but I think with callbacks.blocked() reads quite nicely.

greglucas commented Aug 11, 2021

Copy link
Copy Markdown
Contributor Author

@timhoffm, apparently there is a preferred convention and your suggestion lines up with that :)
https://www.python.org/dev/peps/pep-0343/#examples
I changed to blocked and moved the change note over to "next what's new" and included a short example there.

story645 commented Aug 11, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

So is maybe annoying, but I think this needs a short API changes note too. only incompatible changes need API change notes.

Also, and I might be confused about the functionality here, but would it be possible for the what's new example to be slight less toy/use like one of the auto registrated callbacks or something?

ENH: Add the ability to block callback signals
d9fef33 
CallbackRegistry objects now have a context manager .block()
method that can be used to temporarily block callback signals
from being processed.

greglucas commented Aug 12, 2021

Copy link
Copy Markdown
Contributor Author

I came up with another toy-like example, but with interactivity on the figure canvas and disabling key-press events. Did you have another example/area in mind to apply this? It looks like the widgets keep their callbacks private in _observers, so I guess this doesn't really help the end user currently over there.

story645 commented Aug 12, 2021

Copy link
Copy Markdown
Member

Using fig.canvas.callbacks is perfect - I was unsure whether the functionality extended to the fig callbacks and this clears it right up & I think would be a common use case 😄

timhoffm added this to the v3.5.0 milestone Aug 12, 2021
timhoffm merged commit 495a985 into matplotlib:master Aug 12, 2021
greglucas deleted the callback-blocking branch August 12, 2021 13:42
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

story645 story645 approved these changes
timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

New feature

Projects

None yet

Milestone

v3.5.0

Development

Successfully merging this pull request may close these issues.

Add ability to disable callbacks temporarily

3 participants

Back | FazBrowse Home | New Git URL