Skip to content
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

Jump to bottom

Undeprecate the onerror argument in shutil.rmtree() #112645

Closed
serhiy-storchaka opened this issue Dec 3, 2023 · 4 comments · Fixed by #112659
Closed

Undeprecate the onerror argument in shutil.rmtree() #112645

serhiy-storchaka opened this issue Dec 3, 2023 · 4 comments · Fixed by #112659
Labels
3.12 bugs and security fixes 3.13 bugs and security fixes stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error

Comments

@serhiy-storchaka
Copy link
Member

serhiy-storchaka commented Dec 3, 2023 •
edited by bedevere-app bot
Loading

Bug report

A new onexc parameter was added in shutil.rmtree() in 3.12 (see #102828). At the same time passing the onerror argument was deprecated. It creates inconvenience for code that should run on several Python versions. It forces users to modify their working code to avoid deprecation warnings.

I think that there was nothing wrong in onerror. The only advantage of onexc over onerror was that it may require to write less code in some cases, but the deprecation causes an opposite effect -- it requires to write more code.

So I think that the deprecation should be reverted.

@iritkatriel

Linked PRs
@serhiy-storchaka serhiy-storchaka added type-bug An unexpected behavior, bug, or error stdlib Python modules in the Lib dir 3.12 bugs and security fixes 3.13 bugs and security fixes labels Dec 3, 2023
@serhiy-storchaka serhiy-storchaka mentioned this issue Dec 3, 2023
Closed
@iritkatriel
Copy link
Member

We can remove the deprecation warning but leave it deprecated in the docs.

iritkatriel added a commit to iritkatriel/cpython that referenced this issue Dec 3, 2023
@iritkatriel
pythongh-112645: remove deprecation warning for use of onerror in shu…
c312317 
…til.rmtree
@iritkatriel iritkatriel mentioned this issue Dec 3, 2023
Merged
iritkatriel added a commit that referenced this issue Dec 3, 2023
@iritkatriel
gh-112645: remove deprecation warning for use of onerror in shutil.rm…
97857ac 
…tree (#112659)
@serhiy-storchaka
Copy link
Member Author

Thank you @iritkatriel. Please backport this change to 3.12.

iritkatriel added a commit to iritkatriel/cpython that referenced this issue Dec 3, 2023
@iritkatriel
pythongh-112645: remove deprecation warning for use of onerror in shu…
dcd1eac 
…til.rmtree (python#112659)

(cherry picked from commit 97857ac)
@bedevere-app bedevere-app bot mentioned this issue Dec 3, 2023
Merged
iritkatriel added a commit that referenced this issue Dec 3, 2023
@iritkatriel
[3.12] gh-112645: remove deprecation warning for use of onerror in sh…
f5965c2 
…util.rmtree (#112659) (#112665)

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

(cherry picked from commit 97857ac)
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
@iritkatriel @aisk
pythongh-112645: remove deprecation warning for use of onerror in shu…
1184fe3 
…til.rmtree (python#112659)
@hugovk
Copy link
Member

hugovk commented May 10, 2024

This is still listed as pending removal in 3.14:

https://docs.python.org/3.13/whatsnew/3.13.html#pending-removal-in-python-3-14

Should we instead update the docs so it's listed as pending removal in an unspecified, future version?

https://docs.python.org/3.13/whatsnew/3.13.html#pending-removal-in-future-versions

@hugovk hugovk mentioned this issue May 11, 2024
Merged
@hugovk
Copy link
Member

hugovk commented May 11, 2024

Please see PR #118947.

@AlexWaygood AlexWaygood mentioned this issue Jun 6, 2024
Closed
Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
@iritkatriel @Glyphack
pythongh-112645: remove deprecation warning for use of onerror in shu…
b898072 
…til.rmtree (python#112659)
@bebound bebound mentioned this issue Sep 12, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.12 bugs and security fixes 3.13 bugs and security fixes stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-112645: remove deprecation warning for use of onerror in shutil.rmtree iritkatriel/cpython
3 participants
@iritkatriel @hugovk @serhiy-storchaka