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

Prefer warn_deprecated instead of warnings.warn.#11297

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.

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

Already on GitHub?Sign in to your account

Merged
timhoffm merged 1 commit intomatplotlib:masterfromanntzer:warn_deprecated
Jul 1, 2018
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
3 changes: 3 additions & 0 deletionsdoc/api/next_api_changes/2018-02-15-AL-deprecations.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,9 @@ The following modules are deprecated:

The following classes, methods, functions, and attributes are deprecated:

- ``RcParams.msg_depr``, ``RcParams.msg_depr_ignore``,
``RcParams.msg_depr_set``, ``RcParams.msg_obsolete``,
``RcParams.msg_backend_obsolete``,
- ``afm.parse_afm``,
- ``backend_pgf.get_texcommand``,
- ``backend_ps.get_bbox``,
Expand Down
148 changes: 80 additions & 68 deletionslib/matplotlib/__init__.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,11 +123,11 @@
import importlib
import inspect
from inspect import Parameter
import itertools
import locale
import logging
import os
from pathlib import Path
import pprint
import re
import shutil
import stat
Expand DownExpand Up@@ -800,23 +800,29 @@ def gen_candidates():
return fname


# names of keys to deprecate
# the values are a tuple of (new_name, f_old_2_new, f_new_2_old)
# the inverse function may be `None`
# rcParams deprecated and automatically mapped to another key.
# Values are tuples of (version, new_name, f_old2new, f_new2old).
_deprecated_map = {}

_deprecated_ignore_map = {'nbagg.transparent': 'figure.facecolor'}
# rcParams deprecated; some can manually be mapped to another key.
# Values are tuples of (version, new_name_or_None).
_deprecated_ignore_map = {
'text.dvipnghack': ('2.1', None),
'nbagg.transparent': ('2.2', 'figure.facecolor'),
'plugins.directory': ('2.2', None),
'pgf.debug': ('3.0', None),
}

_obsolete_set = {'pgf.debug', 'plugins.directory', 'text.dvipnghack'}
# rcParams deprecated; can use None to suppress warnings; remain actually
# listed in the rcParams (not included in _all_deprecated).
# Values are typles of (version,)
_deprecated_remain_as_none = {
'axes.hold': ('2.1',),
'backend.qt4': ('2.2',),
'backend.qt5': ('2.2',),
}

# The following may use a value of None to suppress the warning.
# do NOT include in _all_deprecated
_deprecated_set = {'axes.hold',
'backend.qt4',
'backend.qt5'}

_all_deprecated = set(itertools.chain(
_deprecated_ignore_map, _deprecated_map, _obsolete_set))
_all_deprecated = {*_deprecated_map, *_deprecated_ignore_map}


class RcParams(MutableMapping, dict):
Expand All@@ -831,16 +837,35 @@ class RcParams(MutableMapping, dict):
validate = {key: converter
for key, (default, converter) in defaultParams.items()
if key not in _all_deprecated}
msg_depr = "%s is deprecated and replaced with %s; please use the latter."
msg_depr_set = ("%s is deprecated. Please remove it from your "
"matplotlibrc and/or style files.")
msg_depr_ignore = "%s is deprecated and ignored. Use %s instead."
msg_obsolete = ("%s is obsolete. Please remove it from your matplotlibrc "
"and/or style files.")
msg_backend_obsolete = ("The {} rcParam was deprecated in version 2.2. In"
" order to force the use of a specific Qt binding,"
" either import that binding first, or set the "
"QT_API environment variable.")

@property
@cbook.deprecated("3.0")
def msg_depr(self):
return "%s is deprecated and replaced with %s; please use the latter."

@property
@cbook.deprecated("3.0")
def msg_depr_ignore(self):
return "%s is deprecated and ignored. Use %s instead."

@property
@cbook.deprecated("3.0")
def msg_depr_set(self):
return ("%s is deprecated. Please remove it from your matplotlibrc "
"and/or style files.")

@property
@cbook.deprecated("3.0")
def msg_obsolete(self):
return ("%s is obsolete. Please remove it from your matplotlibrc "
"and/or style files.")

@property
@cbook.deprecated("3.0")
def msg_backend_obsolete(self):
return ("The {} rcParam was deprecated in version 2.2. In order to "
"force the use of a specific Qt binding, either import that "
"binding first, or set the QT_API environment variable.")

# validate values on the way in
def __init__(self, *args, **kwargs):
Expand All@@ -849,26 +874,25 @@ def __init__(self, *args, **kwargs):
def __setitem__(self, key, val):
try:
if key in _deprecated_map:
alt_key, alt_val, inverse_alt = _deprecated_map[key]
warnings.warn(self.msg_depr % (key, alt_key),
mplDeprecation)
version,alt_key, alt_val, inverse_alt = _deprecated_map[key]
cbook.warn_deprecated(
version, key, obj_type="rcparam", alternative=alt_key)
key = alt_key
val = alt_val(val)
elif key in _deprecated_set and val is not None:
elif key in _deprecated_remain_as_none and val is not None:
version, = _deprecated_remain_as_none[key]
addendum = None
if key.startswith('backend'):
warnings.warn(self.msg_backend_obsolete.format(key),
mplDeprecation)
else:
warnings.warn(self.msg_depr_set % key,
mplDeprecation)
addendum = (
"In order to force the use of a specific Qt binding, "
"either import that binding first, or set the QT_API "
"environment variable.")
cbook.warn_deprecated(
"2.2", key, obj_type="rcparam", addendum=addendum)
elif key in _deprecated_ignore_map:
alt = _deprecated_ignore_map[key]
warnings.warn(self.msg_depr_ignore % (key, alt),
mplDeprecation)
return
elif key in _obsolete_set:
warnings.warn(self.msg_obsolete % (key, ),
mplDeprecation)
version, alt_key = _deprecated_ignore_map[key]
cbook.warn_deprecated(
version, key, obj_type="rcparam", alternative=alt_key)
return
try:
cval = self.validate[key](val)
Expand All@@ -881,42 +905,30 @@ def __setitem__(self, key, val):
'list of valid parameters.' % (key,))

def __getitem__(self, key):
inverse_alt = None
if key in _deprecated_map:
alt_key, alt_val, inverse_alt = _deprecated_map[key]
warnings.warn(self.msg_depr % (key, alt_key),
mplDeprecation)
key = alt_key
version,alt_key, alt_val, inverse_alt = _deprecated_map[key]
cbook.warn_deprecated(
version, key, obj_type="rcparam", alternative=alt_key)
return inverse_alt(dict.__getitem__(self, alt_key))

elif key in _deprecated_ignore_map:
alt = _deprecated_ignore_map[key]
warnings.warn(self.msg_depr_ignore % (key, alt),
mplDeprecation)
key = alt

elif key in _obsolete_set:
warnings.warn(self.msg_obsolete % (key, ),
mplDeprecation)
return None

val = dict.__getitem__(self, key)
if inverse_alt is not None:
return inverse_alt(val)
else:
return val
version, alt_key = _deprecated_ignore_map[key]
cbook.warn_deprecated(
version, key, obj_type, alternative=alt_key)
return dict.__getitem__(self, alt_key) if alt_key else None

return dict.__getitem__(self, key)

def __repr__(self):
import pprint
class_name = self.__class__.__name__
indent = len(class_name) + 1
repr_split = pprint.pformat(dict(self), indent=1,
width=80 - indent).split('\n')
repr_indented = ('\n' + ' ' * indent).join(repr_split)
return '{0}({1})'.format(class_name, repr_indented)
return '{}({})'.format(class_name, repr_indented)

def __str__(self):
return '\n'.join('{0}: {1}'.format(k, v)
for k, v in sorted(self.items()))
return '\n'.join(map('{0[0]}: {0[1]}'.format, sorted(self.items())))

def __iter__(self):
"""Yield sorted list of keys."""
Expand DownExpand Up@@ -1043,10 +1055,10 @@ def _rc_params_in_file(fname, fail_on_error=False):
warnings.warn('Bad val "%s" on %s\n\t%s' %
(val, error_details, msg))
elif key in _deprecated_ignore_map:
warnings.warn('%s is deprecated. Update your matplotlibrc to use '
'%s instead.' % (key, _deprecated_ignore_map[key]),
mplDeprecation)

version, alt_key = _deprecated_ignore_map[key]
cbook.warn_deprecated(
version, key, alternative=alt_key,
addendum="Please update your matplotlibrc.")
else:
print("""
Bad key "%s" on line %d in
Expand Down
4 changes: 2 additions & 2 deletionslib/matplotlib/axes/_base.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1310,8 +1310,8 @@ def set_adjustable(self, adjustable, share=False):
and independently on each Axes as it is drawn.
"""
if adjustable == 'box-forced':
warnings.warn("The 'box-forced' keyword argument is deprecated"
" since2.2.",cbook.mplDeprecation, stacklevel=2)
cbook.warn_deprecated(
"2.2","box-forced", obj_type="keyword argument")
if adjustable not in ('box', 'datalim', 'box-forced'):
raise ValueError("argument must be 'box', or 'datalim'")
if share:
Expand Down
1 change: 0 additions & 1 deletionlib/matplotlib/axes/_subplots.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
from matplotlib import docstring
import matplotlib.artist as martist
from matplotlib.axes._axes import Axes
from matplotlib.cbook import mplDeprecation
from matplotlib.gridspec import GridSpec, SubplotSpec
import matplotlib._layoutbox as layoutbox

Expand Down
9 changes: 5 additions & 4 deletionslib/matplotlib/cbook/deprecation.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,8 @@ def _generate_deprecation_message(
if removal else
"")))
+ "."
+ (" Use %(alternative)s instead." if alternative else ""))
+ (" Use %(alternative)s instead." if alternative else "")
+ (" %(addendum)s" if addendum else ""))

return (
message % dict(func=name, name=name, obj_type=obj_type, since=since,
Expand DownExpand Up@@ -103,9 +104,9 @@ def warn_deprecated(
obj_type='module')

"""
message = _generate_deprecation_message(
since, message, name, alternative, pending, obj_type,removal=removal)
message = '\n' + message
message ='\n' +_generate_deprecation_message(
since, message, name, alternative, pending, obj_type,addendum,
removal=removal)
category = (PendingDeprecationWarning if pending
else MatplotlibDeprecationWarning)
warnings.warn(message, category, stacklevel=2)
Expand Down
9 changes: 4 additions & 5 deletionslib/matplotlib/gridspec.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,6 @@
from matplotlib import _pylab_helpers, tight_layout, rcParams
from matplotlib.transforms import Bbox
import matplotlib._layoutbox as layoutbox
from matplotlib.cbook import mplDeprecation

_log = logging.getLogger(__name__)

Expand DownExpand Up@@ -277,8 +276,8 @@ def get_subplot_params(self, figure=None, fig=None):
parameters are from rcParams unless a figure attribute is set.
"""
if fig is not None:
warnings.warn("the 'fig' kwarg is deprecated "
"use 'figure' instead", mplDeprecation)
cbook.warn_deprecated("2.2", "fig", obj_type="keyword argument",
alternative="figure")
if figure is None:
figure = fig

Expand DownExpand Up@@ -367,8 +366,8 @@ def get_subplot_params(self, figure=None, fig=None):
"""Return a dictionary of subplot layout parameters.
"""
if fig is not None:
warnings.warn("the 'fig' kwarg is deprecated "
"use 'figure' instead", mplDeprecation)
cbook.warn_deprecated("2.2", "fig", obj_type="keyword argument",
alternative="figure")
if figure is None:
figure = fig

Expand Down
6 changes: 3 additions & 3 deletionslib/matplotlib/tests/test_rcparams.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -453,7 +453,7 @@ def test_rcparams_reset_after_fail():

def test_if_rctemplate_is_up_to_date():
# This tests if the matplotlibrc.template file contains all valid rcParams.
deprecated = {*mpl._all_deprecated, *mpl._deprecated_set}
deprecated = {*mpl._all_deprecated, *mpl._deprecated_remain_as_none}
path_to_rc = os.path.join(mpl.get_data_path(), 'matplotlibrc')
with open(path_to_rc, "r") as f:
rclines = f.readlines()
Expand All@@ -472,8 +472,8 @@ def test_if_rctemplate_is_up_to_date():
if not found:
missing.update({k: v})
if missing:
raise ValueError("The following params are missing" +
"in thematplotlibrc.template file: {}"
raise ValueError("The following params are missingin the "
"matplotlibrc.template file: {}"
.format(missing.items()))


Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp