importlib.resources – Package resource reading, opening and access¶
Source code: Lib/importlib/resources/__init__.py
Added in version 3.7.
This module leverages Python’s import system to provide access to resources 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.
Resources can be opened or read in either binary or text mode.
Resources are roughly akin to files inside directories, though it’s important
to keep in mind that this is just a metaphor. Resources and packages do
not have to exist as physical files and directories on the file system:
for example, a package and its resources can be imported from a zip file using
zipimport.
Note
This module provides functionality similar to pkg_resources Basic Resource Access without the performance overhead of that package. This makes reading resources included in packages easier, with more stable and consistent semantics.
The standalone backport of this module provides more information on