Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-40833: Clarify Path.rename doc-string regarding relative paths (GH-20554)

This commit is contained in:
Ram Rachum 2020-10-03 12:52:13 +03:00 committed by GitHub
parent 6a412c94b6
commit f97e42ef4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/library/pathlib.rst
View File

@ -1008,6 +1008,10 @@ call fails (for example because the path doesn't exist).
>>> target.open().read()
'some text'
The target path may be absolute or relative. Relative paths are interpreted
relative to the current working directory, *not* the directory of the Path
object.
.. versionchanged:: 3.8
Added return value, return the new Path instance.
@ -1018,6 +1022,10 @@ call fails (for example because the path doesn't exist).
instance pointing to *target*. If *target* points to an existing file or
directory, it will be unconditionally replaced.
The target path may be absolute or relative. Relative paths are interpreted
relative to the current working directory, *not* the directory of the Path
object.
.. versionchanged:: 3.8
Added return value, return the new Path instance.

19
Lib/pathlib.py
View File

@ -1366,17 +1366,26 @@ class Path(PurePath):
def rename(self, target):
"""
Rename this path to the given path,
and return a new Path instance pointing to the given path.
Rename this path to the target path.
The target path may be absolute or relative. Relative paths are
interpreted relative to the current working directory, *not* the
directory of the Path object.
Returns the new Path instance pointing to the target path.
"""
self._accessor.rename(self, target)
return self.__class__(target)
def replace(self, target):
"""
Rename this path to the given path, clobbering the existing
destination if it exists, and return a new Path instance
pointing to the given path.
Rename this path to the target path, overwriting if that path exists.
The target path may be absolute or relative. Relative paths are
interpreted relative to the current working directory, *not* the
directory of the Path object.
Returns the new Path instance pointing to the target path.
"""
self._accessor.replace(self, target)
return self.__class__(target)