Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-01-05 23:12:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-136516: Mention installation artifacts as de-facto resources (GH-136419)

Browse source 
Files like NUL on windows are, from `importlib.resources` point of
view, an artifact caused by installing to a filesystem directory.
Mention these.
This commit is contained in:
Petr Viktorin 2025-07-23 14:01:38 +02:00 • committed by GitHub
parent 99cdf1deb6
commit fac4964fdb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/library/importlib.resources.rst
View 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.