diff options
| author | Barney Gale <barney.gale@gmail.com> | 2024-06-19 00:59:54 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-19 00:59:54 (GMT) |
| commit | 20d5b84f57a6f7e5a76109e483abe39d9f703d56 (patch) | |
| tree | db0e439b59968cd5fcff982e13f1b155ed3f0a80 /Doc/library | |
| parent | 9f741e55c16376412c1473aa45b94314c00a0c43 (diff) | |
| download | cpython-20d5b84f57a6f7e5a76109e483abe39d9f703d56.zip cpython-20d5b84f57a6f7e5a76109e483abe39d9f703d56.tar.gz cpython-20d5b84f57a6f7e5a76109e483abe39d9f703d56.tar.bz2 | |
GH-73991: Add follow_symlinks argument to `pathlib.Path.copy()` (#120519)
Add support for not following symlinks in `pathlib.Path.copy()`.
On Windows we add the `COPY_FILE_COPY_SYMLINK` flag is following symlinks is disabled. If the source is symlink to a directory, this call will fail with `ERROR_ACCESS_DENIED`. In this case we add `COPY_FILE_DIRECTORY` to the flags and retry. This can fail on old Windowses, which we note in the docs.
No news as `copy()` was only just added.
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/pathlib.rst | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst index c8a3272..5bfcad0 100644 --- a/Doc/library/pathlib.rst +++ b/Doc/library/pathlib.rst @@ -1432,17 +1432,26 @@ Creating files and directories Copying, renaming and deleting ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. method:: Path.copy(target) +.. method:: Path.copy(target, *, follow_symlinks=True) Copy the contents of this file to the *target* file. If *target* specifies a file that already exists, it will be replaced. + If *follow_symlinks* is false, and this file is a symbolic link, *target* + will be created as a symbolic link. If *follow_symlinks* is true and this + file is a symbolic link, *target* will be a copy of the symlink target. + .. note:: This method uses operating system functionality to copy file content efficiently. The OS might also copy some metadata, such as file permissions. After the copy is complete, users may wish to call :meth:`Path.chmod` to set the permissions of the target file. + .. warning:: + On old builds of Windows (before Windows 10 build 19041), this method + raises :exc:`OSError` when a symlink to a directory is encountered and + *follow_symlinks* is false. + .. versionadded:: 3.14 |