mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-01 12:52:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-31972: Improve docstrings for pathlib classes (GH-5310)

Browse source 
(cherry picked from commit dfa015cf77)

Co-authored-by: chason <chason@gmail.com>
This commit is contained in:
Miss Islington (bot) 2018-02-18 16:48:07 -08:00 • committed by GitHub
parent 034a945fa7
commit 19b7f6694a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

30
Lib/pathlib.py
View file

@ -584,7 +584,9 @@ class _PathParents(Sequence):
class PurePath(object):
"""PurePath represents a filesystem path and offers operations which
"""Base class for manipulating paths without I/O.
PurePath represents a filesystem path and offers operations which
don't imply any actual filesystem I/O. Depending on your system,
instantiating a PurePath will return either a PurePosixPath or a
PureWindowsPath object. You can also instantiate either of these classes
@ -939,11 +941,21 @@ os.PathLike.register(PurePath)
class PurePosixPath(PurePath):
"""PurePath subclass for non-Windows systems.
On a POSIX system, instantiating a PurePath should return this object.
However, you can also instantiate it directly on any system.
"""
_flavour = _posix_flavour
__slots__ = ()
class PureWindowsPath(PurePath):
"""PurePath subclass for Windows systems.
On a Windows system, instantiating a PurePath should return this object.
However, you can also instantiate it directly on any system.
"""
_flavour = _windows_flavour
__slots__ = ()
@ -952,6 +964,14 @@ class PureWindowsPath(PurePath):
class Path(PurePath):
"""PurePath subclass that can make system calls.
Path represents a filesystem path but unlike PurePath, also offers
methods to do system calls on path objects. Depending on your system,
instantiating a Path will return either a PosixPath or a WindowsPath
object. You can also instantiate a PosixPath or WindowsPath directly,
but cannot instantiate a WindowsPath on a POSIX system or vice versa.
"""
__slots__ = (
'_accessor',
'_closed',
@ -1427,9 +1447,17 @@ class Path(PurePath):
class PosixPath(Path, PurePosixPath):
"""Path subclass for non-Windows systems.
On a POSIX system, instantiating a Path should return this object.
"""
__slots__ = ()
class WindowsPath(Path, PureWindowsPath):
"""Path subclass for Windows systems.
On a Windows system, instantiating a Path should return this object.
"""
__slots__ = ()
def owner(self):

1
Misc/NEWS.d/next/Documentation/2018-01-25-14-23-12.bpo-31972.w1m_8r.rst Normal file
View file

@ -0,0 +1 @@
Improve docstrings for `pathlib.PurePath` subclasses.