[Python-checkins] bpo-33582: Emit deprecation warning for `formatargspec` (GH-6994)
Miss Islington (bot)
webhook-mailer at python.org
Mon Jun 11 16:44:19 EDT 2018
https://github.com/python/cpython/commit/60b8274fec3ff029591d8718650223c5ce78a05c
commit: 60b8274fec3ff029591d8718650223c5ce78a05c
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-06-11T13:44:16-07:00
summary:
bpo-33582: Emit deprecation warning for `formatargspec` (GH-6994)
(cherry picked from commit 46c5cd0f6e22bdfbdd3f0b18f1d01eda754e7e11)
Co-authored-by: Matthias Bussonnier <bussonniermatthias at gmail.com>
files:
A Misc/NEWS.d/next/Library/2018-05-19-15-58-14.bpo-33582.qBZPmF.rst
M Lib/inspect.py
M Lib/test/test_inspect.py
diff --git a/Lib/inspect.py b/Lib/inspect.py
index 022cc1922c7a..8e242e82f00e 100644
--- a/Lib/inspect.py
+++ b/Lib/inspect.py
@@ -18,7 +18,7 @@
getargvalues(), getcallargs() - get info about function arguments
getfullargspec() - same, with support for Python 3 features
- formatargspec(), formatargvalues() - format an argument spec
+ formatargvalues() - format an argument spec
getouterframes(), getinnerframes() - get info about frames
currentframe() - get the current stack frame
stack(), trace() - get info about frames on the stack or in a traceback
@@ -1211,7 +1211,19 @@ def formatargspec(args, varargs=None, varkw=None, defaults=None,
kwonlyargs, kwonlydefaults, annotations). The other five arguments
are the corresponding optional formatting functions that are called to
turn names and values into strings. The last argument is an optional
- function to format the sequence of arguments."""
+ function to format the sequence of arguments.
+
+ Deprecated since Python 3.5: use the `signature` function and `Signature`
+ objects.
+ """
+
+ from warnings import warn
+
+ warn("`formatargspec` is deprecated since Python 3.5. Use `signature` and "
+ " the `Signature` object directly",
+ DeprecationWarning,
+ stacklevel=2)
+
def formatargandannotation(arg):
result = formatarg(arg)
if arg in annotations:
diff --git a/Lib/test/test_inspect.py b/Lib/test/test_inspect.py
index ff6f01454513..8b701614962b 100644
--- a/Lib/test/test_inspect.py
+++ b/Lib/test/test_inspect.py
@@ -712,8 +712,9 @@ def assertArgSpecEquals(self, routine, args_e, varargs_e=None,
self.assertEqual(varkw, varkw_e)
self.assertEqual(defaults, defaults_e)
if formatted is not None:
- self.assertEqual(inspect.formatargspec(args, varargs, varkw, defaults),
- formatted)
+ with self.assertWarns(DeprecationWarning):
+ self.assertEqual(inspect.formatargspec(args, varargs, varkw, defaults),
+ formatted)
def assertFullArgSpecEquals(self, routine, args_e, varargs_e=None,
varkw_e=None, defaults_e=None,
@@ -729,8 +730,9 @@ def assertFullArgSpecEquals(self, routine, args_e, varargs_e=None,
self.assertEqual(kwonlydefaults, kwonlydefaults_e)
self.assertEqual(ann, ann_e)
if formatted is not None:
- self.assertEqual(inspect.formatargspec(args, varargs, varkw, defaults,
- kwonlyargs, kwonlydefaults, ann),
+ with self.assertWarns(DeprecationWarning):
+ self.assertEqual(inspect.formatargspec(args, varargs, varkw, defaults,
+ kwonlyargs, kwonlydefaults, ann),
formatted)
def test_getargspec(self):
diff --git a/Misc/NEWS.d/next/Library/2018-05-19-15-58-14.bpo-33582.qBZPmF.rst b/Misc/NEWS.d/next/Library/2018-05-19-15-58-14.bpo-33582.qBZPmF.rst
new file mode 100644
index 000000000000..3471c0e7f0b8
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2018-05-19-15-58-14.bpo-33582.qBZPmF.rst
@@ -0,0 +1 @@
+Emit a deprecation warning for inspect.formatargspec
More information about the Python-checkins
mailing list