8000 Various fixes to deprecated and warn_deprecated. by anntzer · Pull Request #11395 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Various fixes to deprecated and warn_deprecated. #11395

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
Jun 25, 2018
Merged

Various fixes to deprecated and warn_deprecated. #11395

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
3 changes: 2 additions & 1 deletion doc/api/next_api_changes/2018-02-15-AL-deprecations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,5 @@ The following rcParams are deprecated:
- ``pgf.debug`` (the pgf backend relies on logging),

The following keyword arguments are deprecated:
- passing ``verts`` to ``scatter`` (use ``marker`` instead),
- passing ``verts`` to ``Axes.scatter`` (use ``marker`` instead),
- passing ``obj_type`` to ``cbook.deprecated``,
67 changes: 38 additions & 29 deletions lib/matplotlib/cbook/deprecation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ class MatplotlibDeprecationWarning(UserWarning):

https://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x
"""
pass


mplDeprecation = MatplotlibDeprecationWarning
Expand All @@ -28,29 +27,34 @@ def _generate_deprecation_message(
removal = {"2.2": "in 3.1", "3.0": "in 3.2"}.get(
since, "two minor releases later")
elif removal:
if pending:
raise ValueError(
"A pending deprecation cannot have a scheduled removal")
removal = "in {}".format(removal)

if not message:
message = (
"The {name} {obj_type}"
"The %(name)s %(obj_type)s"
+ (" will be deprecated in a future version"
if pending else
(" was deprecated in Matplotlib {since}"
+ (" and will be removed {removal}"
(" was deprecated in Matplotlib %(since)s"
+ (" and will be removed %(removal)s"
if removal else
"")))
+ "."
+ (" Use {alternative} instead." if alternative else ""))
+ (" Use %(alternative)s instead." if alternative else ""))

return message.format(func=name, name=name, obj_type=obj_type, since=since,
removal=removal, alternative=alternative)
return (
message % dict(func=name, name=name, obj_type=obj_type, since=since,
removal=removal, alternative=alternative)
+ addendum)


def warn_deprecated(
since, message='', name='', alternative='', pending=False,
obj_type='attribute', addendum='', *, removal=''):
"""
Used to display deprecation warning in a standard way.
Used to display deprecation in a standard way.

Parameters
----------
Expand All @@ -69,18 +73,19 @@ def warn_deprecated(
The name of the deprecated object.

alternative : str, optional
An alternative function that the user may use in place of the
deprecated function. The deprecation warning will tell the user
about this alternative if provided.
An alternative API that the user may use in place of the deprecated
API. The deprecation warning will tell the user about this alternative
if provided.

pending : bool, optional
If True, uses a PendingDeprecationWarning instead of a
DeprecationWarning.
DeprecationWarning. Cannot be used together with *removal*.

removal : str, optional
The expected removal version. With the default (an empty string), a
removal version is automatically computed from *since*. Set to other
Falsy values to not schedule a removal date.
Falsy values to not schedule a removal date. Cannot be used together
with *pending*.

obj_type : str, optional
The object type being deprecated.
Expand All @@ -101,7 +106,9 @@ def warn_deprecated(
message = _generate_deprecation_message(
since, message, name, alternative, pending, obj_type, removal=removal)
message = '\n' + message
warnings.warn(message, mplDeprecation, stacklevel=2)
category = (PendingDeprecationWarning if pending
else MatplotlibDeprecationWarning)
warnings.warn(message, category, stacklevel=2)


def deprecated(since, message='', name='', alternative='', pending=False,
Expand All @@ -120,8 +127,7 @@ def deprecated(since, message='', name='', alternative='', pending=False,
specifier `%(name)s` may be used for the name of the object,
and `%(alternative)s` may be used in the deprecation message
to insert the name of an alternative to the deprecated
object. `%(obj_type)s` may be used to insert a friendly name
for the type of object being deprecated.
object.

name : str, optional
The name of the deprecated object; if not provided the name
Expand All @@ -135,18 +141,19 @@ def new_function():
oldFunction = new_function

alternative : str, optional
An alternative object that the user may use in place of the
deprecated object. The deprecation warning will tell the user
about this alternative if provided.
An alternative API that the user may use in place of the deprecated
API. The deprecation warning will tell the user about this alternative
if provided.

pending : bool, optional
If True, uses a PendingDeprecationWarning instead of a
DeprecationWarning.
DeprecationWarning. Cannot be used together with *removal*.

removal : str, optional
The expected removal version. With the default (an empty string), a
removal version is automatically computed from *since*. Set to other
Falsy values to not schedule a removal date.
Falsy values to not schedule a removal date. Cannot be used together
with *pending*.

addendum : str, optional
Additional text appended directly to the final message.
Expand All @@ -159,9 +166,14 @@ def new_function():
@deprecated('1.4.0')
def the_function_to_deprecate():
pass

"""

if obj_type is not None:
warn_deprecated(
"3.0", "Passing 'obj_type' to the 'deprecated' decorator has no "
"effect, and is deprecated since Matplotlib %(since)s; support "
"for it will be removed %(removal)s.")

def deprecate(obj, message=message, name=name, alternative=alternative,
pending=pending, addendum=addendum):

Expand All @@ -174,12 +186,7 @@ def deprecate(obj, message=message, name=name, alternative=alternative,
func = obj.__init__

def finalize(wrapper, new_doc):
try:
obj.__doc__ = new_doc
except (AttributeError, TypeError):
# cls.__doc__ is not writeable on Py2.
# TypeError occurs on PyPy
pass
obj.__doc__ = new_doc
obj.__init__ = wrapper
return obj
else:
Expand All @@ -204,9 +211,11 @@ def finalize(wrapper, new_doc):
message = _generate_deprecation_message(
since, message, name, alternative, pending, obj_type, addendum,
removal=removal)
category = (PendingDeprecationWarning if pending
else MatplotlibDeprecationWarning)

def wrapper(*args, **kwargs):
warnings.warn(message, mplDeprecation, stacklevel=2)
warnings.warn(message, category, stacklevel=2)
return func(*args, **kwargs)

old_doc = textwrap.dedent(old_doc or '').strip('\n')
Expand Down
0