Skip to content

check ret == False in Timer._on_timer #1493

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
merged 3 commits into from
Nov 27, 2012
Merged

check ret == False in Timer._on_timer #1493

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5304ee
check `ret is False` in Timer._on_timer
minrk Nov 13, 2012
2ac78c7
add comment to protect against future 'cleanup' of `if ret is False`
minrk Nov 13, 2012
73371b0
use ret == False instead of ret is False
minrk Nov 15, 2012
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
6 changes: 4 additions & 2 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1118,12 +1118,14 @@ def _timer_set_single_shot(self):
def _on_timer(self):
'''
Runs all function that have been registered as callbacks. Functions
can return False if they should not be called any more. If there
can return False (or 0) if they should not be called any more. If there
are no callbacks, the timer is automatically stopped.
'''
for func, args, kwargs in self.callbacks:
ret = func(*args, **kwargs)
if not ret:
# docstring above explains why we use `if ret == False` here,
# instead of `if not ret`.
Copy link
Member

Choose a reason for hiding this comment

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

The comment doesn't really help, nor does the docstring. This code is not very pythonic (I would guess this was written by someone who comes from , and I think a good explanation is necessary in case of more code "cleanup".

Also, this code will break if the function called returns the integer 0 (if that is ever the case..)

My 2 cents,
N

if ret == False:
self.callbacks.remove((func, args, kwargs))

if len(self.callbacks) == 0:
Expand Down