Commit6386d63

committed

MNT: Registered 3rd party scales do not need an axis parameter anymore

First step of#29349.

1 parenta18354a commit6386d63Copy full SHA for 6386d63

File tree

+51

-1

lines changed

+51

-1

lines changed

Lines changed: 10 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,10 @@`
	`1`	`+3rd party scales do not need to have an axis parameter anymore`
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	`+`
	`4`	+Since matplotlib 3.1 `PR 12831<https://github.com/matplotlib/matplotlib/pull/12831>`_
	`5`	`+scales should be reusable and therefore independent of the Axis. Therefore the use of`
	`6`	+of the axis parameter in the ``__init__`` had been discouraged. However, that
	`7`	`+parameter was still necessary for API compatibility. This is no longer the case.`
	`8`	`+`
	`9`	+`.register_scale` now accepts scale classes with and without this parameter.
	`10`	`+3rd party scales can and should remove that parameter.`

Lines changed: 16 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -690,6 +690,9 @@ def limit_range_for_scale(self, vmin, vmax, minpos):`
`690`	`690`	`'functionlog':FuncScaleLog,`
`691`	`691`	`}`
`692`	`692`
	`693`	`+# caching of signature info`
	`694`	`+_scale_has_axis_parameter= {}`
	`695`	`+`
`693`	`696`
`694`	`697`	`defget_scale_names():`
`695`	`698`	`"""Return the names of the available scales."""`
`@@ -706,7 +709,19 @@ def scale_factory(scale, axis, **kwargs):`
`706`	`709`	axis : `~matplotlib.axis.Axis`
`707`	`710`	`"""`
`708`	`711`	`scale_cls=_api.check_getitem(_scale_mapping,scale=scale)`
`709`		`-returnscale_cls(axis,**kwargs)`
	`712`	`+`
	`713`	`+# We support scales that may or may not have an initial axis parameter.`
	`714`	`+# This information is cached, so that we do not need to inspect the signature`
	`715`	`+# on every time we create a scale.`
	`716`	`+ifscalenotin_scale_has_axis_parameter:`
	`717`	`+_scale_has_axis_parameter[scale]= (`
	`718`	`+"axis"ininspect.signature(scale_cls).parameters`
	`719`	`+ )`
	`720`	`+`
	`721`	`+if_scale_has_axis_parameter[scale]:`
	`722`	`+returnscale_cls(axis,**kwargs)`
	`723`	`+else:`
	`724`	`+returnscale_cls(**kwargs)`
`710`	`725`
`711`	`726`
`712`	`727`	`ifscale_factory.__doc__:`

Lines changed: 25 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`importmatplotlib.scaleasmscale`
`9`	`9`	`frommatplotlib.tickerimportAsinhLocator,LogFormatterSciNotation`
`10`	`10`	`frommatplotlib.testing.decoratorsimportcheck_figures_equal,image_comparison`
	`11`	`+frommatplotlib.transformsimportIdentityTransform`
`11`	`12`
`12`	`13`	`importnumpyasnp`
`13`	`14`	`fromnumpy.testingimportassert_allclose`
`@@ -293,3 +294,27 @@ def test_bad_scale(self):`
`293`	`294`	`AsinhScale(axis=None,linear_width=-1)`
`294`	`295`	`s0=AsinhScale(axis=None, )`
`295`	`296`	`s1=AsinhScale(axis=None,linear_width=3.0)`
	`297`	`+`
	`298`	`+`
	`299`	`+deftest_custom_scale_without_axis():`
	`300`	`+"""`
	`301`	`+ Test that one can register and use custom scales that don't take an axis param.`
	`302`	`+ """`
	`303`	`+classCustomTransform(IdentityTransform):`
	`304`	`+pass`
	`305`	`+`
	`306`	`+classCustomScale(mscale.ScaleBase):`
	`307`	`+def__init__(self):`
	`308`	`+self._transform=CustomTransform()`
	`309`	`+`
	`310`	`+defget_transform(self):`
	`311`	`+returnself._transform`
	`312`	`+`
	`313`	`+try:`
	`314`	`+mscale.register_scale("custom",CustomScale)`
	`315`	`+fig,ax=plt.subplots()`
	`316`	`+ax.set_xscale('custom')`
	`317`	`+assertisinstance(ax.xaxis.get_transform(),CustomTransform)`
	`318`	`+finally:`
	`319`	`+# cleanup - there's no public unregister_scale()`
	`320`	`+delmscale._scale_mapping["custom"]`

Comments

(0)