diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2021-07-18 15:13:50 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2021-07-18 15:13:50 -0400 |
| commit | 01f2abe71dc72fdf5b345f4ac3086a94b23efd15 (patch) | |
| tree | 83bee7a6d933efe516f549423bff38f0d303a760 /docs/pkg_resources.rst | |
| parent | 5c24e780b83e4557ca6e9e48b468e6f4a82695c9 (diff) | |
| parent | aa5ef507f3bf78092abfff7c6a2cf55a9b2fb2dc (diff) | |
| download | python-setuptools-git-01f2abe71dc72fdf5b345f4ac3086a94b23efd15.tar.gz | |
Merge branch 'main' into change-docs-theme
Diffstat (limited to 'docs/pkg_resources.rst')
| -rw-r--r-- | docs/pkg_resources.rst | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/pkg_resources.rst b/docs/pkg_resources.rst index 9d3525ef..fb5fc077 100644 --- a/docs/pkg_resources.rst +++ b/docs/pkg_resources.rst @@ -10,6 +10,13 @@ eggs, support for merging packages that have separately-distributed modules or subpackages, and APIs for managing Python's current "working set" of active packages. +Use of ``pkg_resources`` is discouraged in favor of +`importlib.resources <https://docs.python.org/3/library/importlib.html#module-importlib.resources>`_, +`importlib.metadata <https://docs.python.org/3/library/importlib.metadata.html>`_, +and their backports (`resources <https://pypi.org/project/importlib_resources>`_, +`metadata <https://pypi.org/project/importlib_metadata>`_). +Please consider using those libraries instead of pkg_resources. + -------- Overview @@ -1219,7 +1226,7 @@ Resource Extraction If you are implementing an ``IResourceProvider`` and/or ``IMetadataProvider`` for a new distribution archive format, you may need to use the following -``IResourceManager`` methods to co-ordinate extraction of resources to the +``IResourceManager`` methods to coordinate extraction of resources to the filesystem. If you're not implementing an archive format, however, you have no need to use these methods. Unlike the other methods listed above, they are *not* available as top-level functions tied to the global ``ResourceManager``; |
