Commita730a69

committed

Forbid categorical data on colorbars

1 parent2a60b36 commita730a69Copy full SHA for a730a69

File tree

+32

-0

lines changed

+32

-0

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -14,3 +14,7 @@ convert data of more than one dimension (e.g. when plotting images the data is 2`
`14`	`14`	If a conversion interface raises an error when given ``None`` or 2D data as described
`15`	`15`	`above, this error will be re-raised when a user tries to use one of the newly supported`
`16`	`16`	`plotting methods with unit-ful data.`
	`17`	`+`
	`18`	`+If you have a custom conversion interface you want to forbid using with image data, the`
	`19`	+`~.units.ConversionInterface` methods that accept a ``units`` parameter should raise
	`20`	+a `matplotlib.units.ConversionError` when given ``units=None``.

Lines changed: 11 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,14 @@`
`23`	`23`	`_log=logging.getLogger(__name__)`
`24`	`24`
`25`	`25`
	`26`	`+def_check_axis(axis):`
	`27`	`+ifaxisisNone:`
	`28`	`+raiseunits.ConversionError(`
	`29`	`+"Categorical data does not support unit conversion that is not "`
	`30`	`+"attached to an x or y Axis."`
	`31`	`+ )`
	`32`	`+`
	`33`	`+`
`26`	`34`	`classStrCategoryConverter(units.ConversionInterface):`
`27`	`35`	`@staticmethod`
`28`	`36`	`defconvert(value,unit,axis):`
`@@ -45,6 +53,7 @@ def convert(value, unit, axis):`
`45`	`53`	`-------`
`46`	`54`	float or `~numpy.ndarray` of float
`47`	`55`	`"""`
	`56`	`+_check_axis(axis)`
`48`	`57`	`ifunitisNone:`
`49`	`58`	`raiseValueError(`
`50`	`59`	`'Missing category information for StrCategoryConverter; '`
`@@ -77,6 +86,7 @@ def axisinfo(unit, axis):`
`77`	`86`	`Information to support default tick labeling`
`78`	`87`
`79`	`88`	`"""`
	`89`	`+_check_axis(axis)`
`80`	`90`	`StrCategoryConverter._validate_unit(unit)`
`81`	`91`	`# locator and formatter take mapping dict because`
`82`	`92`	`# args need to be pass by reference for updates`
`@@ -100,6 +110,7 @@ def default_units(data, axis):`
`100`	`110`	`.UnitData`
`101`	`111`	`object storing string to integer mapping`
`102`	`112`	`"""`
	`113`	`+_check_axis(axis)`
`103`	`114`	`# the conversion call stack is default_units -> axis_info -> convert`
`104`	`115`	`ifaxis.unitsisNone:`
`105`	`116`	`axis.set_units(UnitData(data))`

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -529,6 +529,9 @@ def _strip_units(self, A):`
`529`	`529`	`try:`
`530`	`530`	`self._units=self._converter.default_units(A,None)`
`531`	`531`	`exceptExceptionase:`
	`532`	`+ifisinstance(e,munits.ConversionError):`
	`533`	`+raisee`
	`534`	`+`
`532`	`535`	`raiseRuntimeError(`
`533`	`536`	`f'{self._converter} failed when trying to return the default units for '`
`534`	`537`	`'this image. This may be because support has not been '`
`@@ -538,6 +541,9 @@ def _strip_units(self, A):`
`538`	`541`	`try:`
`539`	`542`	`A=self._converter.convert(A,self._units,None)`
`540`	`543`	`exceptExceptionase:`
	`544`	`+ifisinstance(e,munits.ConversionError):`
	`545`	`+raisee`
	`546`	`+`
`541`	`547`	`raisemunits.ConversionError(`
`542`	`548`	`f'{self._converter} failed when trying to convert the units for this '`
`543`	`549`	`'image. This may be because support has not been implemented '`

Lines changed: 11 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`importmatplotlib.pyplotasplt`
`10`	`10`	`importmatplotlib.categoryascat`
`11`	`11`	`frommatplotlib.testing.decoratorsimportcheck_figures_equal`
	`12`	`+importmatplotlib.unitsasmunits`
`12`	`13`
`13`	`14`
`14`	`15`	`classTestUnitData:`
`@@ -321,3 +322,13 @@ def test_set_lim():`
`321`	`322`	`ax.plot(["a","b","c","d"], [1,2,3,4])`
`322`	`323`	`withwarnings.catch_warnings():`
`323`	`324`	`ax.set_xlim("b","c")`
	`325`	`+`
	`326`	`+`
	`327`	`+deftest_mappable_error():`
	`328`	`+data=data= [["one","two"], ["three","four"]]`
	`329`	`+`
	`330`	`+fig,ax=plt.subplots()`
	`331`	`+withpytest.raises(munits.ConversionError,`
	`332`	`+match=('Categorical data does not support unit conversion '`
	`333`	`+'that is not attached to an x or y Axis.')):`
	`334`	`+ax.imshow(data)`

Comments

(0)