diff options
author | Ram Rachum <ram@rachum.com> | 2020-10-03 09:52:13 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-03 09:52:13 (GMT) |
commit | f97e42ef4d97dee64f45ed65170a6e77c8e46fdf (patch) | |
tree | 8f7c47df186dc3645170ed9bbbac21d4b93aaedb /Lib/pathlib.py | |
parent | 6a412c94b6b68e7e3632562dc7358a12ffd1447f (diff) | |
download | cpython-f97e42ef4d97dee64f45ed65170a6e77c8e46fdf.zip cpython-f97e42ef4d97dee64f45ed65170a6e77c8e46fdf.tar.gz cpython-f97e42ef4d97dee64f45ed65170a6e77c8e46fdf.tar.bz2 |
bpo-40833: Clarify Path.rename doc-string regarding relative paths (GH-20554)
Diffstat (limited to 'Lib/pathlib.py')
-rw-r--r-- | Lib/pathlib.py | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/Lib/pathlib.py b/Lib/pathlib.py index babc443..147be2f 100644 --- a/Lib/pathlib.py +++ b/Lib/pathlib.py @@ -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) |