Skip to content

GH-95815: Document less specific error for os.remove#99571

Merged
ronaldoussoren merged 1 commit intopython:mainfrom
ronaldoussoren:gh95815-os.remove-docs
Nov 21, 2022
Merged

GH-95815: Document less specific error for os.remove#99571
ronaldoussoren merged 1 commit intopython:mainfrom
ronaldoussoren:gh95815-os.remove-docs

Conversation

@ronaldoussoren
Copy link
Contributor

@ronaldoussoren ronaldoussoren commented Nov 18, 2022 •
edited by bedevere-bot
Loading

os.remove can raise PermissionError instead of IsADirectoryError, when the object to be removed is a directory (in particular on macOS).

This reverts a change done in #14262.

@ronaldoussoren
pythonGH-95815: Document less specific error for os.remove
c7ee166 
os.remove can raise PermissionError instead of IsADirectoryError,
when the object to be removed is a directory (in particular on
macOS).

This reverts a change done in python#14262.
@ronaldoussoren ronaldoussoren added docs Documentation in the Doc dir needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Nov 18, 2022
@bedevere-bot bedevere-bot mentioned this pull request Nov 18, 2022
Closed
@ronaldoussoren
Copy link
Contributor Author

ronaldoussoren commented Nov 18, 2022

This PR is the minimal change that makes the documentation reflect reality. An alternative would be to document that the function might raise either IsADirectoryError or PermissionError. I'm not sure which option would be the best fix.

hauntsaninja
hauntsaninja approved these changes Nov 20, 2022
View reviewed changes
Copy link
Contributor

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. Documenting the specific subclasses in this case doesn't seem particularly helpful and probably would just lead to people writing less portable code e.g. if they stop reading after seeing IsADirectoryError.

@ronaldoussoren ronaldoussoren merged commit 1cae31d into python:main Nov 21, 2022
@miss-islington
Copy link
Contributor

miss-islington commented Nov 21, 2022

Thanks @ronaldoussoren for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

miss-islington commented Nov 21, 2022

Sorry @ronaldoussoren, I had trouble checking out the 3.11 backport branch.
Please retry by removing and re-adding the "needs backport to 3.11" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 1cae31d26ba621f6b1f0656ad3d69a0236338bad 3.11

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 21, 2022
@ronaldoussoren @miss-islington
pythonGH-95815: Document less specific error for os.remove (pythonGH-…
ec50066 
…99571)

os.remove can raise PermissionError instead of IsADirectoryError,
when the object to be removed is a directory (in particular on
macOS).

This reverts a change done in pythonGH-14262.
(cherry picked from commit 1cae31d)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
@bedevere-bot
Copy link

bedevere-bot commented Nov 21, 2022

GH-99639 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Nov 21, 2022
@ronaldoussoren ronaldoussoren added 3.11 only security fixes needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes 3.11 only security fixes labels Nov 21, 2022
@miss-islington
Copy link
Contributor

miss-islington commented Nov 21, 2022

Thanks @ronaldoussoren for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 21, 2022
@ronaldoussoren @miss-islington
pythonGH-95815: Document less specific error for os.remove (pythonGH-…
5a62ac6 
…99571)

os.remove can raise PermissionError instead of IsADirectoryError,
when the object to be removed is a directory (in particular on
macOS).

This reverts a change done in pythonGH-14262.
(cherry picked from commit 1cae31d)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
@bedevere-bot
Copy link

bedevere-bot commented Nov 21, 2022

GH-99641 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Nov 21, 2022
ronaldoussoren added a commit that referenced this pull request Nov 21, 2022
@miss-islington @ronaldoussoren
[3.11] GH-95815: Document less specific error for os.remove (GH-99571) (
bb4c091 
#99641)

GH-95815: Document less specific error for os.remove (GH-99571)

os.remove can raise PermissionError instead of IsADirectoryError,
when the object to be removed is a directory (in particular on
macOS).

This reverts a change done in GH-14262.
(cherry picked from commit 1cae31d)

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>

Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
ronaldoussoren added a commit that referenced this pull request Nov 21, 2022
@miss-islington @ronaldoussoren
[3.10] GH-95815: Document less specific error for os.remove (GH-99571) (
101dfae 
#99639)

GH-95815: Document less specific error for os.remove (GH-99571)

os.remove can raise PermissionError instead of IsADirectoryError,
when the object to be removed is a directory (in particular on
macOS).

This reverts a change done in GH-14262.
(cherry picked from commit 1cae31d)


Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hauntsaninja hauntsaninja hauntsaninja approved these changes

Assignees

@ronaldoussoren ronaldoussoren

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ronaldoussoren @miss-islington @bedevere-bot @hauntsaninja