summaryrefslogtreecommitdiffstats
path: root/Lib/unittest/case.py
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2019-04-01 06:16:35 (GMT)
committerGitHub <noreply@github.com>2019-04-01 06:16:35 (GMT)
commit42a139ed88c487f325a241c6ee8b308b3c045975 (patch)
treede56527188eff240b06496c3451e525af959dcad /Lib/unittest/case.py
parent5f2c50810a67982b0c80f6d3258fee3647f67005 (diff)
downloadcpython-42a139ed88c487f325a241c6ee8b308b3c045975.zip
cpython-42a139ed88c487f325a241c6ee8b308b3c045975.tar.gz
cpython-42a139ed88c487f325a241c6ee8b308b3c045975.tar.bz2
bpo-36492: Deprecate passing some arguments as keyword arguments. (GH-12637)
Deprecated passing the following arguments as keyword arguments: - "func" in functools.partialmethod(), weakref.finalize(), profile.Profile.runcall(), cProfile.Profile.runcall(), bdb.Bdb.runcall(), trace.Trace.runfunc() and curses.wrapper(). - "function" in unittest.addModuleCleanup() and unittest.TestCase.addCleanup(). - "fn" in the submit() method of concurrent.futures.ThreadPoolExecutor and concurrent.futures.ProcessPoolExecutor. - "callback" in contextlib.ExitStack.callback(), contextlib.AsyncExitStack.callback() and contextlib.AsyncExitStack.push_async_callback(). - "c" and "typeid" in the create() method of multiprocessing.managers.Server and multiprocessing.managers.SharedMemoryServer. - "obj" in weakref.finalize(). Also allowed to pass arbitrary keyword arguments (even "self" and "func") if the above arguments are passed as positional argument.
Diffstat (limited to 'Lib/unittest/case.py')
-rw-r--r--Lib/unittest/case.py44
1 files changed, 41 insertions, 3 deletions
diff --git a/Lib/unittest/case.py b/Lib/unittest/case.py
index a157ae8..972a465 100644
--- a/Lib/unittest/case.py
+++ b/Lib/unittest/case.py
@@ -86,9 +86,21 @@ def _id(obj):
_module_cleanups = []
-def addModuleCleanup(function, *args, **kwargs):
+def addModuleCleanup(*args, **kwargs):
"""Same as addCleanup, except the cleanup items are called even if
setUpModule fails (unlike tearDownModule)."""
+ if args:
+ function, *args = args
+ elif 'function' in kwargs:
+ function = kwargs.pop('function')
+ import warnings
+ warnings.warn("Passing 'function' as keyword argument is deprecated",
+ DeprecationWarning, stacklevel=2)
+ else:
+ raise TypeError('addModuleCleanup expected at least 1 positional '
+ 'argument, got %d' % (len(args)-1))
+ args = tuple(args)
+
_module_cleanups.append((function, args, kwargs))
@@ -463,18 +475,44 @@ class TestCase(object):
"""
self._type_equality_funcs[typeobj] = function
- def addCleanup(self, function, *args, **kwargs):
+ def addCleanup(*args, **kwargs):
"""Add a function, with arguments, to be called when the test is
completed. Functions added are called on a LIFO basis and are
called after tearDown on test failure or success.
Cleanup items are called even if setUp fails (unlike tearDown)."""
+ if len(args) >= 2:
+ self, function, *args = args
+ elif not args:
+ raise TypeError("descriptor 'addCleanup' of 'TestCase' object "
+ "needs an argument")
+ elif 'function' in kwargs:
+ function = kwargs.pop('function')
+ self, *args = args
+ import warnings
+ warnings.warn("Passing 'function' as keyword argument is deprecated",
+ DeprecationWarning, stacklevel=2)
+ else:
+ raise TypeError('addCleanup expected at least 1 positional '
+ 'argument, got %d' % (len(args)-1))
+ args = tuple(args)
+
self._cleanups.append((function, args, kwargs))
@classmethod
- def addClassCleanup(cls, function, *args, **kwargs):
+ def addClassCleanup(*args, **kwargs):
"""Same as addCleanup, except the cleanup items are called even if
setUpClass fails (unlike tearDownClass)."""
+ if len(args) >= 2:
+ cls, function, *args = args
+ elif not args:
+ raise TypeError("descriptor 'addClassCleanup' of 'TestCase' object "
+ "needs an argument")
+ else:
+ raise TypeError('addClassCleanup expected at least 1 positional '
+ 'argument, got %d' % (len(args)-1))
+ args = tuple(args)
+
cls._class_cleanups.append((function, args, kwargs))
def setUp(self):