Skip to content

Init MaxNLocator params only once #12998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 28, 2018
Merged

Init MaxNLocator params only once #12998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/api/next_api_changes/2018-12-16-TH-deprecations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Deprecations
````````````

The class variable ``matplotlib.ticker.MaxNLocator.default_params`` is
deprecated and will be removed in a future version. The defaults are not
supposed to be user-configurable.

``matplotlib.ticker.MaxNLocator`` and its ``set_params`` method will issue
a warning on unknown keyword arguments instead of silently ignoring them.
Future versions will raise an error.
69 changes: 53 additions & 16 deletions lib/matplotlib/ticker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1824,12 +1824,12 @@ class MaxNLocator(Locator):
"""
Select no more than N intervals at nice locations.
"""
default_params = dict(nbins=10,
steps=None,
integer=False,
symmetric=False,
prune=None,
min_n_ticks=2)
_default_params = dict(nbins=10,
steps=None,
integer=False,
symmetric=False,
prune=None,
min_n_ticks=2)

def __init__(self, *args, **kwargs):
"""
Expand All @@ -1840,7 +1840,7 @@ def __init__(self, *args, **kwargs):
ticks. If the string `'auto'`, the number of bins will be
automatically determined based on the length of the axis.

steps: array-like, optional
steps : array-like, optional
Sequence of nice numbers starting with 1 and ending with 10;
e.g., [1, 2, 4, 5, 10], where the values are acceptable
tick multiples. i.e. for the example, 20, 40, 60 would be
Expand Down Expand Up @@ -1871,12 +1871,17 @@ def __init__(self, *args, **kwargs):

"""
if args:
if 'nbins' in kwargs:
cbook.deprecated("3.1",
message='Calling MaxNLocator with positional '
'and keyword parameter *nbins* is '
'considered an error and will fail '
'in future versions of matplotlib.')
kwargs['nbins'] = args[0]
if len(args) > 1:
raise ValueError(
"Keywords are required for all arguments except 'nbins'")
self.set_params(**self.default_params)
self.set_params(**kwargs)
self.set_params(**{**self._default_params, **kwargs})

@staticmethod
def _validate_steps(steps):
Expand All @@ -1893,6 +1898,16 @@ def _validate_steps(steps):
steps = np.hstack((steps, 10))
return steps

@cbook.deprecated("3.1")
@property
def default_params(self):
return self._default_params

@cbook.deprecated("3.1")
@default_params.setter
def default_params(self, params):
self._default_params = params

@staticmethod
def _staircase(steps):
# Make an extended staircase within which the needed
Expand All @@ -1902,30 +1917,52 @@ def _staircase(steps):
return np.hstack(flights)

def set_params(self, **kwargs):
"""Set parameters within this locator."""
"""
Set parameters for this locator.

Parameters
----------
nbins : int or 'auto', optional
see `.MaxNLocator`
steps : array-like, optional
see `.MaxNLocator`
integer : bool, optional
see `.MaxNLocator`
symmetric : bool, optional
see `.MaxNLocator`
prune : {'lower', 'upper', 'both', None}, optional
see `.MaxNLocator`
min_n_ticks : int, optional
see `.MaxNLocator`
"""
if 'nbins' in kwargs:
self._nbins = kwargs['nbins']
self._nbins = kwargs.pop('nbins')
if self._nbins != 'auto':
self._nbins = int(self._nbins)
if 'symmetric' in kwargs:
self._symmetric = kwargs['symmetric']
self._symmetric = kwargs.pop('symmetric')
if 'prune' in kwargs:
prune = kwargs['prune']
prune = kwargs.pop('prune')
if prune is not None and prune not in ['upper', 'lower', 'both']:
raise ValueError(
"prune must be 'upper', 'lower', 'both', or None")
self._prune = prune
if 'min_n_ticks' in kwargs:
self._min_n_ticks = max(1, kwargs['min_n_ticks'])
self._min_n_ticks = max(1, kwargs.pop('min_n_ticks'))
if 'steps' in kwargs:
steps = kwargs['steps']
steps = kwargs.pop('steps')
if steps is None:
self._steps = np.array([1, 1.5, 2, 2.5, 3, 4, 5, 6, 8, 10])
else:
self._steps = self._validate_steps(steps)
self._extended_steps = self._staircase(self._steps)
if 'integer' in kwargs:
self._integer = kwargs['integer']
self._integer = kwargs.pop('integer')
if kwargs:
key, _ = kwargs.popitem()
cbook.warn_deprecated("3.1",
message="MaxNLocator.set_params got an "
f"unexpected parameter: {key}")

def _raw_ticks(self, vmin, vmax):
"""
Expand Down