]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.14] gh-136516: Mention installation artifacts as de-facto resources (GH-136419...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 7 Oct 2025 17:50:13 +0000 (19:50 +0200)
committerGitHub <noreply@github.com>
Tue, 7 Oct 2025 17:50:13 +0000 (23:20 +0530)
gh-136516: Mention installation artifacts as de-facto resources (GH-136419)

Files like NUL on windows are, from `importlib.resources` point of
view, an artifact caused by installing to a filesystem directory.
Mention these.
(cherry picked from commit fac4964fdb2ae12969b485de496dd6d064fdbe99)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Doc/library/importlib.resources.rst

index e002198899c8b8b000561a9c16b472c0db2c6dd4..7a11f4fe0690048aed61cb81f1296506ca50032b 100644 (file)
@@ -16,11 +16,12 @@ within *packages*.
 "Resources" are file-like resources associated with a module or package in
 Python. The resources may be contained directly in a package, within a
 subdirectory contained in that package, or adjacent to modules outside a
-package. Resources may be text or binary. As a result, Python module sources
-(.py) of a package and compilation artifacts (pycache) are technically
-de-facto resources of that package. In practice, however, resources are
-primarily those non-Python artifacts exposed specifically by the package
-author.
+package. Resources may be text or binary. As a result, a package's Python
+module sources (.py), compilation artifacts (pycache), and installation
+artifacts (like :func:`reserved filenames <os.path.isreserved>`
+in directories) are technically de-facto resources of that package.
+In practice, however, resources are primarily those non-Python artifacts
+exposed specifically by the package author.
 
 Resources can be opened or read in either binary or text mode.