-
-
Notifications
You must be signed in to change notification settings - Fork 34.8k
[3.15] gh-109503: Fix document for shutil.move() on usage of os.rename() since it's inaccurate (GH-109507) #150611
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.
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
Merged
serhiy-storchaka
merged 1 commit into
python:3.15
from
miss-islington:backport-6ecd197-3.15
Jun 9, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -885,10 +885,14 @@ def move(src, dst, copy_function=copy2): | |||||
| If dst already exists but is not a directory, it may be overwritten | ||||||
| depending on os.rename() semantics. | ||||||
|
|
||||||
| If the destination is on our current filesystem, then rename() is used. | ||||||
| Otherwise, src is copied to the destination and then removed. Symlinks are | ||||||
| recreated under the new name if os.rename() fails because of cross | ||||||
| filesystem renames. | ||||||
| os.rename() is preferably used if the source and destination are on the | ||||||
| same filesystem. In case os.rename() fails due to OSError (e.g. the user | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| has write permission to *dst* file but not to its parent directory), | ||||||
| this method falls back to using *copy_function* silently. | ||||||
| Symlinks are also recreated under the new name if os.rename() fails | ||||||
| because of cross filesystem renames. | ||||||
|
|
||||||
| It's recommended to use os.rename() if atomic move is strictly required. | ||||||
|
|
||||||
| The optional `copy_function` argument is a callable that will be used | ||||||
| to copy the source or it will be delegated to `copytree`. | ||||||
|
|
||||||
3 changes: 3 additions & 0 deletions
3
Misc/NEWS.d/next/Documentation/2023-09-16-23-42-27.gh-issue-109503.mZ-kdU.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Fix documentation for :func:`shutil.move` on usage of | ||
| :func:`os.rename` since nonatomic move might be used even if the files are | ||
| on the same filesystem. Patch by Fang Li |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid Latin abbreviations: https://devguide.python.org/documentation/style-guide/#use-simple-language