Skip to content

Commit ef08aa1

Browse files
tacaswelltacaswell
committed
MNT : rename dirty -> stale
1 parent 46af65a commit ef08aa1

File tree

5 files changed

+49
-49
lines changed

5 files changed

+49
-49
lines changed

‎lib/matplotlib/_pylab_helpers.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ def draw_all(cls, force=False):
146146
state machine.
147147
"""
148148
for f_mgr in cls.get_all_fig_managers():
149-
# TODO add logic to check if figure is dirty
150-
if force or f_mgr.canvas.figure.dirty:
149+
# TODO add logic to check if figure is stale
150+
if force or f_mgr.canvas.figure.stale:
151151
f_mgr.canvas.draw()
152152

153153
atexit.register(Gcf.destroy_all)

‎lib/matplotlib/artist.py

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ def draw_wrapper(artist, renderer, *args, **kwargs):
6868
return draw_wrapper
6969

7070

71-
def _dirty_figure_callback(self):
72-
self.figure.dirty = True
71+
def _stale_figure_callback(self):
72+
self.figure.stale = True
7373

7474

75-
def _dirty_axes_callback(self):
76-
self.axes.dirty = True
75+
def _stale_axes_callback(self):
76+
self.axes.stale = True
7777

7878

7979
class Artist(object):
@@ -117,7 +117,7 @@ def __init__(self):
117117
self._snap = None
118118
self._sketch = rcParams['path.sketch']
119119
self._path_effects = rcParams['path.effects']
120-
self._dirty = True
120+
self._stale = True
121121

122122
def __getstate__(self):
123123
d = self.__dict__.copy()
@@ -222,28 +222,28 @@ def axes(self, new_axes):
222222

223223
self._axes = new_axes
224224
if new_axes is not None and new_axes is not self:
225-
self.add_callback(_dirty_axes_callback)
225+
self.add_callback(_stale_axes_callback)
226226

227227
return new_axes
228228

229229
@property
230-
def dirty(self):
230+
def stale(self):
231231
"""
232-
If the artist is 'dirty' and needs to be re-drawn for the output to
232+
If the artist is 'stale' and needs to be re-drawn for the output to
233233
match the internal state of the artist.
234234
"""
235-
return self._dirty
235+
return self._stale
236236

237-
@dirty.setter
238-
def dirty(self, val):
239-
# only trigger call-back stack on being marked as 'dirty'
240-
# when not already dirty
237+
@stale.setter
238+
def stale(self, val):
239+
# only trigger call-back stack on being marked as 'stale'
240+
# when not already stale
241241
# the draw process will take care of propagating the cleaning
242242
# process
243-
if not (self._dirty == val):
244-
self._dirty = val
245-
# only trigger propagation if marking as dirty
246-
if self._dirty:
243+
if not (self._stale == val):
244+
self._stale = val
245+
# only trigger propagation if marking as stale
246+
if self._stale:
247247
self.pchanged()
248248

249249
def get_window_extent(self, renderer):
@@ -606,7 +606,7 @@ def set_figure(self, fig):
606606
"""
607607
self.figure = fig
608608
if self.figure and self.figure is not self:
609-
self.add_callback(_dirty_figure_callback)
609+
self.add_callback(_stale_figure_callback)
610610
self.pchanged()
611611

612612
def set_clip_box(self, clipbox):
@@ -763,7 +763,7 @@ def draw(self, renderer, *args, **kwargs):
763763
'Derived classes drawing method'
764764
if not self.get_visible():
765765
return
766-
self._dirty = False
766+
self._stale = False
767767

768768
def set_alpha(self, alpha):
769769
"""

‎lib/matplotlib/axes/_base.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2064,7 +2064,7 @@ def draw(self, renderer=None, inframe=False):
20642064
# will draw the edges
20652065
if self.axison and self._frameon:
20662066
self.patch.draw(renderer)
2067-
self.patch.dirty = False
2067+
self.patch.stale = False
20682068

20692069
if _do_composite:
20702070
# make a composite image, blending alpha
@@ -2097,22 +2097,22 @@ def draw(self, renderer=None, inframe=False):
20972097
self.patch.get_transform()))
20982098

20992099
renderer.draw_image(gc, round(l), round(b), im)
2100-
im.dirty = False
2100+
im.stale = False
21012101
gc.restore()
21022102

21032103
if dsu_rasterized:
21042104
for zorder, a in dsu_rasterized:
21052105
a.draw(renderer)
2106-
a.dirty = False
2106+
a.stale = False
21072107
renderer.stop_rasterizing()
21082108

21092109
for zorder, a in dsu:
21102110
a.draw(renderer)
2111-
a.dirty = False
2111+
a.stale = False
21122112

21132113
renderer.close_group('axes')
21142114
self._cachedRenderer = renderer
2115-
self.dirty = False
2115+
self.stale = False
21162116

21172117
def draw_artist(self, a):
21182118
"""
@@ -2125,7 +2125,7 @@ def draw_artist(self, a):
21252125
' caches the render')
21262126
raise AttributeError(msg)
21272127
a.draw(self._cachedRenderer)
2128-
a.dirty = False
2128+
a.stale = False
21292129

21302130
def redraw_in_frame(self):
21312131
"""

‎lib/matplotlib/figure.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,12 +1106,12 @@ def draw_composite():
11061106
dsu.sort(key=itemgetter(0))
11071107
for zorder, a, func, args in dsu:
11081108
func(*args)
1109-
a.dirty = False
1109+
a.stale = False
11101110

11111111
renderer.close_group('figure')
11121112

11131113
self._cachedRenderer = renderer
1114-
self.dirty = False
1114+
self.stale = False
11151115
self.canvas.draw_event(renderer)
11161116

11171117
def draw_artist(self, a):

‎lib/matplotlib/lines.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ def set_fillstyle(self, fs):
478478
ACCEPTS: ['full' | 'left' | 'right' | 'bottom' | 'top' | 'none']
479479
"""
480480
self._marker.set_fillstyle(fs)
481-
self.dirty = True
481+
self.stale = True
482482

483483
def set_markevery(self, every):
484484
"""Set the markevery property to subsample the plot when using markers.
@@ -532,7 +532,7 @@ def set_markevery(self, every):
532532
533533
"""
534534
if self._markevery != every:
535-
self.dirty = True
535+
self.stale = True
536536
self._markevery = every
537537

538538
def get_markevery(self):
@@ -676,7 +676,7 @@ def set_transform(self, t):
676676
Artist.set_transform(self, t)
677677
self._invalidx = True
678678
self._invalidy = True
679-
self.dirty = True
679+
self.stale = True
680680

681681
def _is_sorted(self, x):
682682
"""return true if x is sorted"""
@@ -915,7 +915,7 @@ def set_antialiased(self, b):
915915
ACCEPTS: [True | False]
916916
"""
917917
if self._antialiased != b:
918-
self.dirty = True
918+
self.stale = True
919919
self._antialiased = b
920920

921921
def set_color(self, color):
@@ -925,7 +925,7 @@ def set_color(self, color):
925925
ACCEPTS: any matplotlib color
926926
"""
927927
if color != self._color:
928-
self.dirty = True
928+
self.stale = True
929929
self._color = color
930930

931931
def set_drawstyle(self, drawstyle):
@@ -940,7 +940,7 @@ def set_drawstyle(self, drawstyle):
940940
'steps-post']
941941
"""
942942
if self._drawstyle != drawstyle:
943-
self.dirty = True
943+
self.stale = True
944944
self._drawstyle = drawstyle
945945

946946
def set_linewidth(self, w):
@@ -951,7 +951,7 @@ def set_linewidth(self, w):
951951
"""
952952
w = float(w)
953953
if self._linewidth != w:
954-
self.dirty = True
954+
self.stale = True
955955
self._linewidth = w
956956

957957
def set_linestyle(self, ls):
@@ -1045,7 +1045,7 @@ def set_marker(self, marker):
10451045
10461046
"""
10471047
self._marker.set_marker(marker)
1048-
self.dirty = True
1048+
self.stale = True
10491049

10501050
def set_markeredgecolor(self, ec):
10511051
"""
@@ -1056,7 +1056,7 @@ def set_markeredgecolor(self, ec):
10561056
if ec is None:
10571057
ec = 'auto'
10581058
if self._markeredgecolor != ec:
1059-
self.dirty = True
1059+
self.stale = True
10601060
self._markeredgecolor = ec
10611061

10621062
def set_markeredgewidth(self, ew):
@@ -1068,7 +1068,7 @@ def set_markeredgewidth(self, ew):
10681068
if ew is None:
10691069
ew = rcParams['lines.markeredgewidth']
10701070
if self._markeredgewidth != ew:
1071-
self.dirty = True
1071+
self.stale = True
10721072
self._markeredgewidth = ew
10731073

10741074
def set_markerfacecolor(self, fc):
@@ -1080,7 +1080,7 @@ def set_markerfacecolor(self, fc):
10801080
if fc is None:
10811081
fc = 'auto'
10821082
if self._markerfacecolor != fc:
1083-
self.dirty = True
1083+
self.stale = True
10841084
self._markerfacecolor = fc
10851085

10861086
def set_markerfacecoloralt(self, fc):
@@ -1092,7 +1092,7 @@ def set_markerfacecoloralt(self, fc):
10921092
if fc is None:
10931093
fc = 'auto'
10941094
if self._markerfacecoloralt != fc:
1095-
self.dirty = True
1095+
self.stale = True
10961096
self._markerfacecoloralt = fc
10971097

10981098
def set_markersize(self, sz):
@@ -1103,7 +1103,7 @@ def set_markersize(self, sz):
11031103
"""
11041104
sz = float(sz)
11051105
if self._markersize != sz:
1106-
self.dirty = True
1106+
self.stale = True
11071107
self._markersize = sz
11081108

11091109
def set_xdata(self, x):
@@ -1114,7 +1114,7 @@ def set_xdata(self, x):
11141114
"""
11151115
self._xorig = x
11161116
self._invalidx = True
1117-
self.dirty = True
1117+
self.stale = True
11181118

11191119
def set_ydata(self, y):
11201120
"""
@@ -1124,7 +1124,7 @@ def set_ydata(self, y):
11241124
"""
11251125
self._yorig = y
11261126
self._invalidy = True
1127-
self.dirty = True
1127+
self.stale = True
11281128

11291129
def set_dashes(self, seq):
11301130
"""
@@ -1139,7 +1139,7 @@ def set_dashes(self, seq):
11391139
else:
11401140
self.set_linestyle('--')
11411141
if self._dashSeq != seq:
1142-
self.dirty = True
1142+
self.stale = True
11431143
self._dashSeq = seq # TODO: offset ignored for now
11441144

11451145
def _draw_lines(self, renderer, gc, path, trans):
@@ -1324,7 +1324,7 @@ def set_dash_joinstyle(self, s):
13241324
raise ValueError('set_dash_joinstyle passed "%s";\n' % (s,)
13251325
+ 'valid joinstyles are %s' % (self.validJoin,))
13261326
if self._dashjoinstyle != s:
1327-
self.dirty = True
1327+
self.stale = True
13281328
self._dashjoinstyle = s
13291329

13301330
def set_solid_joinstyle(self, s):
@@ -1338,7 +1338,7 @@ def set_solid_joinstyle(self, s):
13381338
+ 'valid joinstyles are %s' % (self.validJoin,))
13391339

13401340
if self._solidjoinstyle != s:
1341-
self.dirty = True
1341+
self.stale = True
13421342
self._solidjoinstyle = s
13431343

13441344
def get_dash_joinstyle(self):
@@ -1364,7 +1364,7 @@ def set_dash_capstyle(self, s):
13641364
raise ValueError('set_dash_capstyle passed "%s";\n' % (s,)
13651365
+ 'valid capstyles are %s' % (self.validCap,))
13661366
if self._dashcapstyle != s:
1367-
self.dirty = True
1367+
self.stale = True
13681368
self._dashcapstyle = s
13691369

13701370
def set_solid_capstyle(self, s):
@@ -1378,7 +1378,7 @@ def set_solid_capstyle(self, s):
13781378
raise ValueError('set_solid_capstyle passed "%s";\n' % (s,)
13791379
+ 'valid capstyles are %s' % (self.validCap,))
13801380
if self._solidcapstyle != s:
1381-
self.dirty = True
1381+
self.stale = True
13821382
self._solidcapstyle = s
13831383

13841384
def get_dash_capstyle(self):

0 commit comments

Comments
 (0)