1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

gh-112645: remove deprecation warning for use of onerror in shutil.rmtree (#112659)

Browse Source
This commit is contained in:
Irit Katriel 2023-12-03 14:02:37 +00:00 committed by GitHub
parent 162d3d428a
commit 97857ac058
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 9 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Doc/whatsnew/3.12.rst
View File

@ -838,8 +838,7 @@ shutil
* :func:`shutil.rmtree` now accepts a new argument *onexc* which is an
error handler like *onerror* but which expects an exception instance
rather than a *(typ, val, tb)* triplet. *onerror* is deprecated and
will be removed in Python 3.14.
rather than a *(typ, val, tb)* triplet. *onerror* is deprecated.
(Contributed by Irit Katriel in :gh:`102828`.)
* :func:`shutil.which` now consults the *PATHEXT* environment variable to
@ -1261,8 +1260,8 @@ Deprecated
:mod:`concurrent.futures` the fix is to use a different
:mod:`multiprocessing` start method such as ``"spawn"`` or ``"forkserver"``.
* :mod:`shutil`: The *onerror* argument of :func:`shutil.rmtree` is deprecated and will be removed
in Python 3.14. Use *onexc* instead. (Contributed by Irit Katriel in :gh:`102828`.)
* :mod:`shutil`: The *onerror* argument of :func:`shutil.rmtree` is deprecated;
use *onexc* instead. (Contributed by Irit Katriel in :gh:`102828`.)
* :mod:`sqlite3`:

5
Lib/shutil.py
View File

@ -721,11 +721,6 @@ def rmtree(path, ignore_errors=False, onerror=None, *, onexc=None, dir_fd=None):
If both onerror and onexc are set, onerror is ignored and onexc is used.
"""
if onerror is not None:
import warnings
warnings.warn("onerror argument is deprecated, use onexc instead",
DeprecationWarning, stacklevel=2)
sys.audit("shutil.rmtree", path, dir_fd)
if ignore_errors:
def onexc(*args):

15
Lib/test/test_shutil.py
View File

@ -208,8 +208,7 @@ class TestRmTree(BaseTest, unittest.TestCase):
errors = []
def onerror(*args):
errors.append(args)
with self.assertWarns(DeprecationWarning):
shutil.rmtree(link, onerror=onerror)
shutil.rmtree(link, onerror=onerror)
self.assertEqual(len(errors), 1)
self.assertIs(errors[0][0], os.path.islink)
self.assertEqual(errors[0][1], link)
@ -270,8 +269,7 @@ class TestRmTree(BaseTest, unittest.TestCase):
errors = []
def onerror(*args):
errors.append(args)
with self.assertWarns(DeprecationWarning):
shutil.rmtree(link, onerror=onerror)
shutil.rmtree(link, onerror=onerror)
self.assertEqual(len(errors), 1)
self.assertIs(errors[0][0], os.path.islink)
self.assertEqual(errors[0][1], link)
@ -340,8 +338,7 @@ class TestRmTree(BaseTest, unittest.TestCase):
errors = []
def onerror(*args):
errors.append(args)
with self.assertWarns(DeprecationWarning):
shutil.rmtree(filename, onerror=onerror)
shutil.rmtree(filename, onerror=onerror)
self.assertEqual(len(errors), 2)
self.assertIs(errors[0][0], os.scandir)
self.assertEqual(errors[0][1], filename)
@ -410,8 +407,7 @@ class TestRmTree(BaseTest, unittest.TestCase):
self.addCleanup(os.chmod, self.child_file_path, old_child_file_mode)
self.addCleanup(os.chmod, self.child_dir_path, old_child_dir_mode)
with self.assertWarns(DeprecationWarning):
shutil.rmtree(TESTFN, onerror=self.check_args_to_onerror)
shutil.rmtree(TESTFN, onerror=self.check_args_to_onerror)
# Test whether onerror has actually been called.
self.assertEqual(self.errorState, 3,
"Expected call to onerror function did not happen.")
@ -537,8 +533,7 @@ class TestRmTree(BaseTest, unittest.TestCase):
self.addCleanup(os.chmod, self.child_file_path, old_child_file_mode)
self.addCleanup(os.chmod, self.child_dir_path, old_child_dir_mode)
with self.assertWarns(DeprecationWarning):
shutil.rmtree(TESTFN, onerror=onerror, onexc=onexc)
shutil.rmtree(TESTFN, onerror=onerror, onexc=onexc)
self.assertTrue(onexc_called)
self.assertFalse(onerror_called)

1
Misc/NEWS.d/next/Library/2023-12-03-12-41-48.gh-issue-112645.blMsKf.rst Normal file
View File

@ -0,0 +1 @@
Remove deprecation error on passing ``onerror`` to :func:`shutil.rmtree`.