bpo-38422: Clarify docstrings of pathlib suffix(es) (GH-16679)
Whenever I use `path.suffix` I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking.
https://bugs.python.org/issue38422
Automerge-Triggered-By: @pitrou
(cherry picked from commit 8d4fef4ee2a318097f429cf6cbd4fb2e430bb9da)
Co-authored-by: Ram Rachum <ram@rachum.com>
diff --git a/Lib/pathlib.py b/Lib/pathlib.py
index 70b011b..c42bde4 100644
--- a/Lib/pathlib.py
+++ b/Lib/pathlib.py
@@ -799,7 +799,11 @@
@property
def suffix(self):
- """The final component's last suffix, if any."""
+ """
+ The final component's last suffix, if any.
+
+ This includes the leading period. For example: '.txt'
+ """
name = self.name
i = name.rfind('.')
if 0 < i < len(name) - 1:
@@ -809,7 +813,11 @@
@property
def suffixes(self):
- """A list of the final component's suffixes, if any."""
+ """
+ A list of the final component's suffixes, if any.
+
+ These include the leading periods. For example: ['.tar', '.gz']
+ """
name = self.name
if name.endswith('.'):
return []