From 21f83efd106a19f1d26e049c06678a6729a721f0 Mon Sep 17 00:00:00 2001 From: Barney Gale Date: Sat, 13 Jan 2024 08:47:00 +0000 Subject: [PATCH] Add module docstring for `pathlib._abc`. (#113691) --- Lib/pathlib/_abc.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Lib/pathlib/_abc.py b/Lib/pathlib/_abc.py index e53921edaa2..a6956f251f8 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