Reinstate & deprecate ContourSet.antialiased #26399
Conversation
cb30499 to
0ec8821
Compare
|
Array is good, we have the normalization in there to ensure that the private variable is always an array (provided it goes through the setter) The general principle is to be forgiving on inputs and specific on outputs, where possible (subclassing relationships can put some generalization pressure on outputs, in some cases, but usually not too much) |
| def antialiased(self): | ||
| return all(self.get_antialiased()) | ||
|
|
||
| @antialiased.setter |
There was a problem hiding this comment.
deprecation needs to be added to the getter and setter individually (otherwise users who use only the setter will not be warned)
There was a problem hiding this comment.
This works for both - I've updated the test to show that. I also tried adding the deprecation to both but with different warning messages: this gave me both messages whether I was setting or getting.
In [3]: cs.antialiased = False
<ipython-input-3-e2ba4606272c>:1: MatplotlibDeprecationWarning: The antialiased attribute was deprecated in Matplotlib 3.8 and will be removed two minor releases later. Use set_antialiased instead.
cs.antialiased = False
<ipython-input-3-e2ba4606272c>:1: MatplotlibDeprecationWarning: The antialiased attribute was deprecated in Matplotlib 3.8 and will be removed two minor releases later. Use get_antialiased instead. Note that get_antialiased returns an array.
cs.antialiased = False
| @@ -113,6 +112,8 @@ class ContourSet(ContourLabeler, Collection): | |||
| @property | |||
| def alpha(self) -> float | None: ... | |||
| @property | |||
| def antialiased(self) -> bool: ... | |||
There was a problem hiding this comment.
setter should be added to the pyi as well
0ec8821 to
035d3e3
Compare
PR summary
Closes #26343
As agreed on last week's call, reinstate
antialiasedas a deprecated property. Useallto get from the_antialisedsarray to single bool on the way out.There did not seem to be an existing
get_method so I added one. I've currently typed its output asNDArray, as that is what it will be due to the way theset_method works. Would it better to type it asSequence, consistent with otherCollections.get_...methods?PR checklist