summaryrefslogtreecommitdiff
path: root/Doc/library
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/pathlib.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index d4329e7a4c..dead49b630 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -571,6 +571,30 @@ Pure paths provide the following methods and properties:
ValueError: PureWindowsPath('c:/') has an empty name
+.. method:: PurePath.with_stem(stem)
+
+ Return a new path with the :attr:`stem` changed. If the original path
+ doesn't have a name, ValueError is raised::
+
+ >>> p = PureWindowsPath('c:/Downloads/draft.txt')
+ >>> p.with_stem('final')
+ PureWindowsPath('c:/Downloads/final.txt')
+ >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
+ >>> p.with_stem('lib')
+ PureWindowsPath('c:/Downloads/lib.gz')
+ >>> p = PureWindowsPath('c:/')
+ >>> p.with_stem('')
+ Traceback (most recent call last):
+ File "<stdin>", line 1, in <module>
+ File "/home/antoine/cpython/default/Lib/pathlib.py", line 861, in with_stem
+ return self.with_name(stem + self.suffix)
+ File "/home/antoine/cpython/default/Lib/pathlib.py", line 851, in with_name
+ raise ValueError("%r has an empty name" % (self,))
+ ValueError: PureWindowsPath('c:/') has an empty name
+
+ .. versionadded:: 3.9
+
+
.. method:: PurePath.with_suffix(suffix)
Return a new path with the :attr:`suffix` changed. If the original path