Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitfc958e6

Browse files
committed
Enforce convert() and un_convert()
1 parent773363f commitfc958e6

File tree

5 files changed

+97
-12
lines changed

5 files changed

+97
-12
lines changed

‎lib/matplotlib/tests/test_axes.py‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,10 @@ def test_matshow():
9797
])
9898
deftest_formatter_ticker():
9999
importmatplotlib.testing.jpl_unitsasunits
100-
units.register()
100+
# Catch warnings thrown whilst jpl unit converters don't have an
101+
# un_convert() method
102+
withpytest.warns(Warning,match='does not define an un_convert'):
103+
units.register()
101104

102105
# This should affect the tick size. (Tests issue #543)
103106
matplotlib.rcParams['lines.markeredgewidth']=30
@@ -486,7 +489,10 @@ def test_polar_alignment():
486489
deftest_fill_units():
487490
fromdatetimeimportdatetime
488491
importmatplotlib.testing.jpl_unitsasunits
489-
units.register()
492+
# Catch warnings thrown whilst jpl unit converters don't have an
493+
# un_convert() method
494+
withpytest.warns(Warning,match='does not define an un_convert'):
495+
units.register()
490496

491497
# generate some data
492498
t=units.Epoch("ET",dt=datetime(2009,4,27))
@@ -654,7 +660,10 @@ def test_polar_wrap(fig_test, fig_ref):
654660
@check_figures_equal()
655661
deftest_polar_units_1(fig_test,fig_ref):
656662
importmatplotlib.testing.jpl_unitsasunits
657-
units.register()
663+
# Catch warnings thrown whilst jpl unit converters don't have an
664+
# un_convert() method
665+
withpytest.warns(Warning,match='does not define an un_convert'):
666+
units.register()
658667
xs= [30.0,45.0,60.0,90.0]
659668
ys= [1.0,2.0,3.0,4.0]
660669

@@ -669,7 +678,10 @@ def test_polar_units_1(fig_test, fig_ref):
669678
@check_figures_equal()
670679
deftest_polar_units_2(fig_test,fig_ref):
671680
importmatplotlib.testing.jpl_unitsasunits
672-
units.register()
681+
# Catch warnings thrown whilst jpl unit converters don't have an
682+
# un_convert() method
683+
withpytest.warns(Warning,match='does not define an un_convert'):
684+
units.register()
673685
xs= [30.0,45.0,60.0,90.0]
674686
xs_deg= [x*units.degforxinxs]
675687
ys= [1.0,2.0,3.0,4.0]
@@ -838,7 +850,10 @@ def test_aitoff_proj():
838850
deftest_axvspan_epoch():
839851
fromdatetimeimportdatetime
840852
importmatplotlib.testing.jpl_unitsasunits
841-
units.register()
853+
# Catch warnings thrown whilst jpl unit converters don't have an
854+
# un_convert() method
855+
withpytest.warns(Warning,match='does not define an un_convert'):
856+
units.register()
842857

843858
# generate some data
844859
t0=units.Epoch("ET",dt=datetime(2009,1,20))
@@ -854,7 +869,10 @@ def test_axvspan_epoch():
854869
deftest_axhspan_epoch():
855870
fromdatetimeimportdatetime
856871
importmatplotlib.testing.jpl_unitsasunits
857-
units.register()
872+
# Catch warnings thrown whilst jpl unit converters don't have an
873+
# un_convert() method
874+
withpytest.warns(Warning,match='does not define an un_convert'):
875+
units.register()
858876

859877
# generate some data
860878
t0=units.Epoch("ET",dt=datetime(2009,1,20))

‎lib/matplotlib/tests/test_dates.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,10 @@ def test_too_many_date_ticks(caplog):
165165
@image_comparison(['RRuleLocator_bounds.png'])
166166
deftest_RRuleLocator():
167167
importmatplotlib.testing.jpl_unitsasunits
168-
units.register()
168+
# Catch warnings thrown whilst jpl unit converters don't have an
169+
# un_convert() method
170+
withpytest.warns(Warning,match='does not define an un_convert'):
171+
units.register()
169172

170173
# This will cause the RRuleLocator to go out of bounds when it tries
171174
# to add padding to the limits, so we make sure it caps at the correct
@@ -198,7 +201,10 @@ def test_RRuleLocator_dayrange():
198201
@image_comparison(['DateFormatter_fractionalSeconds.png'])
199202
deftest_DateFormatter():
200203
importmatplotlib.testing.jpl_unitsasunits
201-
units.register()
204+
# Catch warnings thrown whilst jpl unit converters don't have an
205+
# un_convert() method
206+
withpytest.warns(Warning,match='does not define an un_convert'):
207+
units.register()
202208

203209
# Lets make sure that DateFormatter will allow us to have tick marks
204210
# at intervals of fractional seconds.

‎lib/matplotlib/tests/test_patches.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,10 @@ def test_multi_color_hatch():
367367
@image_comparison(['units_rectangle.png'])
368368
deftest_units_rectangle():
369369
importmatplotlib.testing.jpl_unitsasU
370-
U.register()
370+
# Catch warnings thrown whilst jpl unit converters don't have an
371+
# un_convert() method
372+
withpytest.warns(Warning,match='does not define an un_convert'):
373+
U.register()
371374

372375
p=mpatches.Rectangle((5*U.km,6*U.km),1*U.km,2*U.km)
373376

‎lib/matplotlib/tests/test_units.py‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
fromunittest.mockimportMagicMock
44

55
importmatplotlib.pyplotasplt
6+
frommatplotlibimportcbook
67
frommatplotlib.testing.decoratorsimportcheck_figures_equal,image_comparison
78
importmatplotlib.unitsasmunits
89
importnumpyasnp
@@ -56,6 +57,9 @@ def convert(value, unit, axis):
5657
else:
5758
returnQuantity(value,axis.get_units()).to(unit).magnitude
5859

60+
defun_convert(value,unit,axis):
61+
returnQuantitfy(value,unit)
62+
5963
defdefault_units(value,axis):
6064
ifhasattr(value,'units'):
6165
returnvalue.units
@@ -68,6 +72,7 @@ def default_units(value, axis):
6872
qc.convert=MagicMock(side_effect=convert)
6973
qc.axisinfo=MagicMock(side_effect=lambdau,a:munits.AxisInfo(label=u))
7074
qc.default_units=MagicMock(side_effect=default_units)
75+
qc.un_convert=MagicMock(side_effect=un_convert)
7176
returnqc
7277

7378

@@ -124,7 +129,10 @@ def test_empty_set_limits_with_units(quantity_converter):
124129
savefig_kwarg={'dpi':120},style='mpl20')
125130
deftest_jpl_bar_units():
126131
importmatplotlib.testing.jpl_unitsasunits
127-
units.register()
132+
# Catch warnings thrown whilst jpl unit converters don't have an
133+
# un_convert() method
134+
withpytest.warns(Warning,match='does not define an un_convert'):
135+
units.register()
128136

129137
day=units.Duration("ET",24.0*60.0*60.0)
130138
x= [0*units.km,1*units.km,2*units.km]
@@ -140,7 +148,10 @@ def test_jpl_bar_units():
140148
savefig_kwarg={'dpi':120},style='mpl20')
141149
deftest_jpl_barh_units():
142150
importmatplotlib.testing.jpl_unitsasunits
143-
units.register()
151+
# Catch warnings thrown whilst jpl unit converters don't have an
152+
# un_convert() method
153+
withpytest.warns(Warning,match='does not define an un_convert'):
154+
units.register()
144155

145156
day=units.Duration("ET",24.0*60.0*60.0)
146157
x= [0*units.km,1*units.km,2*units.km]
@@ -175,3 +186,17 @@ class subdate(datetime):
175186

176187
fig_test.subplots().plot(subdate(2000,1,1),0,"o")
177188
fig_ref.subplots().plot(datetime(2000,1,1),0,"o")
189+
190+
191+
deftest_no_conveter_warnings():
192+
classConverter(munits.ConversionInterface):
193+
pass
194+
195+
# Check that a converter without a manuallly defined convert() method
196+
# warns
197+
withpytest.warns(cbook.deprecation.MatplotlibDeprecationWarning):
198+
Converter.convert(0,0,0)
199+
200+
# Check that manually defining a conveter doesn't warn
201+
Converter.convert=lambdaobj,unit,axis:obj
202+
Converter.convert(0,0,0)

‎lib/matplotlib/units.py‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ def convert(value, unit, axis):
2222
'Convert a datetime value to a scalar or array'
2323
return dates.date2num(value)
2424
25+
@staticmethod
26+
def un_convert(value, unit, axis):
27+
'Convert a float back to a datetime value'
28+
return dates.num2date(value)
29+
2530
@staticmethod
2631
def axisinfo(unit, axis):
2732
'Return major and minor tick locators and formatters'
@@ -44,6 +49,7 @@ def default_units(x, axis):
4449

4550
fromdecimalimportDecimal
4651
fromnumbersimportNumber
52+
importwarnings
4753

4854
importnumpyasnp
4955
fromnumpyimportma
@@ -127,6 +133,7 @@ def default_units(x, axis):
127133
"""
128134
returnNone
129135

136+
# Make this an abstractmethod in 3.5
130137
@staticmethod
131138
defconvert(obj,unit,axis):
132139
"""
@@ -135,15 +142,25 @@ def convert(obj, unit, axis):
135142
If *obj* is a sequence, return the converted sequence. The output must
136143
be a sequence of scalars that can be used by the numpy array layer.
137144
"""
145+
cbook.warn_deprecated(
146+
'3.3',
147+
message=('Using the default "does nothing" convert() method for '
148+
'Matplotlib ConversionInterface converters is deprecated '
149+
'and will raise an error in version 3.5. '
150+
'Please manually override convert().'))
138151
returnobj
139152

153+
# Uncomment this in version 3.5 to enforce an un_convert() method
154+
'''
140155
@staticmethod
156+
@abc.abstractmethod
141157
def un_convert(data, unit, axis):
142158
"""
143159
Convert data that has already been converted back to its original
144160
value.
145161
"""
146-
returndata
162+
pass
163+
'''
147164

148165
@staticmethod
149166
defis_numlike(x):
@@ -188,6 +205,14 @@ def convert(value, unit, axis):
188205
converter=ma.asarray
189206
returnconverter(value,dtype=np.float)
190207

208+
@staticmethod
209+
defun_convert(value,unit,axis):
210+
"""
211+
Un-convert from floats to Decimals.
212+
"""
213+
returnDecimal(value)
214+
215+
191216
@staticmethod
192217
defaxisinfo(unit,axis):
193218
# Since Decimal is a kind of Number, don't need specific axisinfo.
@@ -202,6 +227,14 @@ def default_units(x, axis):
202227
classRegistry(dict):
203228
"""Register types with conversion interface."""
204229

230+
def__setitem__(self,cls,converter):
231+
ifnothasattr(converter,'un_convert'):
232+
warnings.warn(
233+
f'{converter.__class__.__name__} does not define an '
234+
'un_convert() method. From Matplotlib 3.5 this will be '
235+
'required, and if not present will raise an error.')
236+
super().__setitem__(cls,converter)
237+
205238
defget_converter(self,x):
206239
"""Get the converter interface instance for *x*, or None."""
207240
ifhasattr(x,"values"):

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp