summaryrefslogtreecommitdiffstats
path: root/Lib/pathlib/_abc.py
diff options
context:
space:
mode:
authorBarney Gale <barney.gale@gmail.com>2024-01-13 08:47:00 (GMT)
committerGitHub <noreply@github.com>2024-01-13 08:47:00 (GMT)
commit21f83efd106a19f1d26e049c06678a6729a721f0 (patch)
tree35ea1900b4f4562daccb418908b467c34c518976 /Lib/pathlib/_abc.py
parentf20b151a1c49602282a0e80ffb92f68c28c04abd (diff)
downloadcpython-21f83efd106a19f1d26e049c06678a6729a721f0.zip
cpython-21f83efd106a19f1d26e049c06678a6729a721f0.tar.gz
cpython-21f83efd106a19f1d26e049c06678a6729a721f0.tar.bz2
Add module docstring for `pathlib._abc`. (#113691)
Diffstat (limited to 'Lib/pathlib/_abc.py')
-rw-r--r--Lib/pathlib/_abc.py13
1 files changed, 13 insertions, 0 deletions
diff --git a/Lib/pathlib/_abc.py b/Lib/pathlib/_abc.py
index e53921e..a6956f2 100644
--- a/Lib/pathlib/_abc.py
+++ b/Lib/pathlib/_abc.py
@@ -1,3 +1,16 @@
+"""
+Abstract base classes for rich path objects.
+
+This module is published as a PyPI package called "pathlib-abc".
+
+This module is also a *PRIVATE* part of the Python standard library, where
+it's developed alongside pathlib. If it finds success and maturity as a PyPI
+package, it could become a public part of the standard library.
+
+Two base classes are defined here -- PurePathBase and PathBase -- that
+resemble pathlib's PurePath and Path respectively.
+"""
+
import functools
import posixpath
from errno import ENOENT, ENOTDIR, EBADF, ELOOP, EINVAL