Clarify that shutil's copy functions can accept path-like values (GH-15141)
This commit is contained in:
parent
bb668f798a
commit
9488a5289d
|
@ -52,7 +52,7 @@ Directory and files operations
|
|||
|
||||
Copy the contents (no metadata) of the file named *src* to a file named
|
||||
*dst* and return *dst* in the most efficient way possible.
|
||||
*src* and *dst* are path names given as strings.
|
||||
*src* and *dst* are path-like objects or path names given as strings.
|
||||
|
||||
*dst* must be the complete target file name; look at :func:`~shutil.copy`
|
||||
for a copy that accepts a target directory path. If *src* and *dst*
|
||||
|
@ -92,7 +92,8 @@ Directory and files operations
|
|||
.. function:: copymode(src, dst, *, follow_symlinks=True)
|
||||
|
||||
Copy the permission bits from *src* to *dst*. The file contents, owner, and
|
||||
group are unaffected. *src* and *dst* are path names given as strings.
|
||||
group are unaffected. *src* and *dst* are path-like objects or path names
|
||||
given as strings.
|
||||
If *follow_symlinks* is false, and both *src* and *dst* are symbolic links,
|
||||
:func:`copymode` will attempt to modify the mode of *dst* itself (rather
|
||||
than the file it points to). This functionality is not available on every
|
||||
|
@ -108,7 +109,8 @@ Directory and files operations
|
|||
Copy the permission bits, last access time, last modification time, and
|
||||
flags from *src* to *dst*. On Linux, :func:`copystat` also copies the
|
||||
"extended attributes" where possible. The file contents, owner, and
|
||||
group are unaffected. *src* and *dst* are path names given as strings.
|
||||
group are unaffected. *src* and *dst* are path-like objects or path
|
||||
names given as strings.
|
||||
|
||||
If *follow_symlinks* is false, and *src* and *dst* both
|
||||
refer to symbolic links, :func:`copystat` will operate on
|
||||
|
|
|
@ -330,7 +330,8 @@ def copystat(src, dst, *, follow_symlinks=True):
|
|||
Copy the permission bits, last access time, last modification time, and
|
||||
flags from `src` to `dst`. On Linux, copystat() also copies the "extended
|
||||
attributes" where possible. The file contents, owner, and group are
|
||||
unaffected. `src` and `dst` are path names given as strings.
|
||||
unaffected. `src` and `dst` are path-like objects or path names given as
|
||||
strings.
|
||||
|
||||
If the optional flag `follow_symlinks` is not set, symlinks aren't
|
||||
followed if and only if both `src` and `dst` are symlinks.
|
||||
|
|
Loading…
Reference in New Issue