2019-05-25 01:59:01 +02:00
.. _using:
2023-05-06 04:40:19 +02:00
========================================================
:mod: `!importlib.metadata` -- Accessing package metadata
========================================================
2019-05-25 01:59:01 +02:00
2021-04-15 02:56:21 +02:00
.. module :: importlib.metadata
2023-05-06 04:40:19 +02:00
:synopsis: Accessing package metadata
2021-04-15 02:56:21 +02:00
2021-04-17 01:13:38 +02:00
.. versionadded :: 3.8
2021-07-13 01:56:40 +02:00
.. versionchanged :: 3.10
`` importlib.metadata `` is no longer provisional.
2021-04-17 01:13:38 +02:00
2021-10-30 17:12:47 +02:00
**Source code:** :source: `Lib/importlib/metadata/__init__.py`
2021-04-15 02:56:21 +02:00
2023-05-06 04:40:19 +02:00
`` importlib.metadata `` is a library that provides access to
2022-10-06 21:25:24 +02:00
the metadata of an installed `Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_ ,
such as its entry points
or its top-level names (`Import Package <https://packaging.python.org/en/latest/glossary/#term-Import-Package> `_ \s, modules, if any).
Built in part on Python's import system, this library
2019-05-25 01:59:01 +02:00
intends to replace similar functionality in the `entry point
2024-09-13 04:29:08 +02:00
API`_ and `metadata API`_ of `` pkg_resources `` . Along with
2022-06-26 03:04:28 +02:00
:mod: `importlib.resources` ,
this package can eliminate the need to use the older and less efficient
2019-05-25 01:59:01 +02:00
`` pkg_resources `` package.
2023-05-06 04:40:19 +02:00
`` importlib.metadata `` operates on third-party *distribution packages*
2022-10-06 21:25:24 +02:00
installed into Python's `` site-packages `` directory via tools such as
2024-04-15 20:22:00 +02:00
:pypi: `pip` .
2022-10-06 21:25:24 +02:00
Specifically, it works with distributions with discoverable
`` dist-info `` or `` egg-info `` directories,
and metadata defined by the `Core metadata specifications <https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata> `_ .
.. important ::
These are *not* necessarily equivalent to or correspond 1:1 with
the top-level *import package* names
that can be imported inside Python code.
One *distribution package* can contain multiple *import packages*
(and single modules),
and one top-level *import package*
may map to multiple *distribution packages*
if it is a namespace package.
2023-11-18 00:11:30 +01:00
You can use :ref: `packages_distributions() <package-distributions>`
2022-10-06 21:25:24 +02:00
to get a mapping between them.
By default, distribution metadata can live on the file system
or in zip archives on
2024-09-13 04:29:08 +02:00
:data: `sys.path` . Through an extension mechanism, the metadata can live almost
2019-05-25 01:59:01 +02:00
anywhere.
2022-06-26 03:04:28 +02:00
.. seealso ::
https://importlib-metadata.readthedocs.io/
The documentation for `` importlib_metadata `` , which supplies a
backport of `` importlib.metadata `` .
2022-10-06 21:25:24 +02:00
This includes an `API reference
<https://importlib-metadata.readthedocs.io/en/latest/api.html>`__
for this module's classes and functions,
as well as a `migration guide
<https://importlib-metadata.readthedocs.io/en/latest/migration.html>`__
for existing users of `` pkg_resources `` .
2022-06-26 03:04:28 +02:00
2019-05-25 01:59:01 +02:00
Overview
========
2022-10-06 21:25:24 +02:00
Let's say you wanted to get the version string for a
`Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_ you've installed
2024-09-13 04:29:08 +02:00
using `` pip `` . We start by creating a virtual environment and installing
2019-05-26 16:30:52 +02:00
something into it:
2019-05-25 01:59:01 +02:00
2019-05-26 16:30:52 +02:00
.. code-block :: shell-session
2019-05-25 01:59:01 +02:00
2023-03-14 19:40:12 +01:00
$ python -m venv example
2019-05-25 01:59:01 +02:00
$ source example/bin/activate
2022-04-09 20:37:01 +02:00
(example) $ python -m pip install wheel
2019-05-25 01:59:01 +02:00
2019-05-26 16:30:52 +02:00
You can get the version string for `` wheel `` by running the following:
2019-05-25 01:59:01 +02:00
2019-05-26 16:30:52 +02:00
.. code-block :: pycon
2019-05-25 01:59:01 +02:00
(example) $ python
>>> from importlib.metadata import version # doctest: +SKIP
>>> version('wheel') # doctest: +SKIP
'0.32.3'
2022-06-26 03:04:28 +02:00
You can also get a collection of entry points selectable by properties of the EntryPoint (typically 'group' or 'name'), such as
2024-09-13 04:29:08 +02:00
`` console_scripts `` , `` distutils.commands `` and others. Each group contains a
2022-06-26 03:04:28 +02:00
collection of :ref: `EntryPoint <entry-points>` objects.
2019-05-25 01:59:01 +02:00
You can get the :ref: `metadata for a distribution <metadata>` ::
>>> list(metadata('wheel')) # doctest: +SKIP
['Metadata-Version', 'Name', 'Version', 'Summary', 'Home-page', 'Author', 'Author-email', 'Maintainer', 'Maintainer-email', 'License', 'Project-URL', 'Project-URL', 'Project-URL', 'Keywords', 'Platform', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Requires-Python', 'Provides-Extra', 'Requires-Dist', 'Requires-Dist']
You can also get a :ref: `distribution's version number <version>` , list its
:ref: `constituent files <files>` , and get a list of the distribution's
:ref: `requirements` .
2024-10-07 15:44:18 +02:00
.. exception :: PackageNotFoundError
Subclass of :class: `ModuleNotFoundError` raised by several functions in this
module when queried for a distribution package which is not installed in the
current Python environment.
2019-05-25 01:59:01 +02:00
Functional API
==============
This package provides the following functionality via its public API.
.. _entry-points:
Entry points
------------
2024-10-07 15:44:18 +02:00
.. function :: entry_points(**select_params)
Returns a :class: `EntryPoints` instance describing entry points for the
current environment. Any given keyword parameters are passed to the
2024-10-07 18:51:53 +02:00
:meth: `!select` method for comparison to the attributes of
2024-10-07 15:44:18 +02:00
the individual entry point definitions.
Note: it is not currently possible to query for entry points based on
their :attr: `!EntryPoint.dist` attribute (as different :class: `!Distribution`
instances do not currently compare equal, even if they have the same attributes)
.. class :: EntryPoints
Details of a collection of installed entry points.
Also provides a `` .groups `` attribute that reports all identifed entry
point groups, and a `` .names `` attribute that reports all identified entry
point names.
.. class :: EntryPoint
Details of an installed entry point.
Each :class: `!EntryPoint` instance has `` .name `` , `` .group `` , and `` .value ``
attributes and a `` .load() `` method to resolve the value. There are also
`` .module `` , `` .attr `` , and `` .extras `` attributes for getting the
components of the `` .value `` attribute, and `` .dist `` for obtaining
information regarding the distribution package that provides the entry point.
2021-03-15 03:20:49 +01:00
Query all entry points::
2019-05-25 01:59:01 +02:00
>>> eps = entry_points() # doctest: +SKIP
2021-03-15 03:20:49 +01:00
2024-10-07 15:44:18 +02:00
The :func: `!entry_points` function returns a :class: `!EntryPoints` object,
a collection of all :class: `!EntryPoint` objects with `` names `` and `` groups ``
2021-03-15 03:20:49 +01:00
attributes for convenience::
2021-03-13 17:31:45 +01:00
>>> sorted(eps.groups) # doctest: +SKIP
2019-05-25 01:59:01 +02:00
['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']
2021-03-15 03:20:49 +01:00
2024-10-07 18:51:53 +02:00
:class: `!EntryPoints` has a :meth: `!select` method to select entry points
2021-03-15 03:20:49 +01:00
matching specific properties. Select entry points in the
`` console_scripts `` group::
2021-03-13 17:31:45 +01:00
>>> scripts = eps.select(group='console_scripts') # doctest: +SKIP
2021-03-15 03:20:49 +01:00
2024-10-07 15:44:18 +02:00
Equivalently, since :func: `!entry_points` passes keyword arguments
2021-03-15 03:20:49 +01:00
through to select::
>>> scripts = entry_points(group='console_scripts') # doctest: +SKIP
Pick out a specific script named "wheel" (found in the wheel project)::
2021-03-13 17:31:45 +01:00
>>> 'wheel' in scripts.names # doctest: +SKIP
True
>>> wheel = scripts['wheel'] # doctest: +SKIP
2021-03-15 03:20:49 +01:00
Equivalently, query for that entry point during selection::
>>> (wheel,) = entry_points(group='console_scripts', name='wheel') # doctest: +SKIP
>>> (wheel,) = entry_points().select(group='console_scripts', name='wheel') # doctest: +SKIP
Inspect the resolved entry point::
2019-05-25 01:59:01 +02:00
>>> wheel # doctest: +SKIP
EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')
2020-06-05 22:34:16 +02:00
>>> wheel.module # doctest: +SKIP
'wheel.cli'
>>> wheel.attr # doctest: +SKIP
'main'
>>> wheel.extras # doctest: +SKIP
[]
2019-05-25 01:59:01 +02:00
>>> main = wheel.load() # doctest: +SKIP
>>> main # doctest: +SKIP
<function main at 0x103528488>
The `` group `` and `` name `` are arbitrary values defined by the package author
and usually a client will wish to resolve all entry points for a particular
2024-09-13 04:29:08 +02:00
group. Read `the setuptools docs
2022-06-21 20:55:18 +02:00
<https://setuptools.pypa.io/en/latest/userguide/entry_point.html> `_
2020-06-05 22:34:16 +02:00
for more information on entry points, their definition, and usage.
2019-05-25 01:59:01 +02:00
2023-12-21 21:04:05 +01:00
.. versionchanged :: 3.12
The "selectable" entry points were introduced in `` importlib_metadata ``
3.6 and Python 3.10. Prior to those changes, `` entry_points `` accepted
no parameters and always returned a dictionary of entry points, keyed
by group. With `` importlib_metadata `` 5.0 and Python 3.12,
`` entry_points `` always returns an `` EntryPoints `` object. See
2024-04-15 20:22:00 +02:00
:pypi: `backports.entry_points_selectable`
2023-12-21 21:04:05 +01:00
for compatibility options.
.. versionchanged :: 3.13
`` EntryPoint `` objects no longer present a tuple-like interface
(:meth: `~object.__getitem__` ).
2019-05-25 01:59:01 +02:00
.. _metadata:
Distribution metadata
---------------------
2024-10-07 15:44:18 +02:00
.. function :: metadata(distribution_name)
Return the distribution metadata corresponding to the named
distribution package as a :class: `PackageMetadata` instance.
Raises :exc: `PackageNotFoundError` if the named distribution
package is not installed in the current Python environment.
.. class :: PackageMetadata
A concrete implementation of the
2024-10-30 18:46:09 +01:00
`PackageMetadata protocol <https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata> `_ .
2024-10-07 15:44:18 +02:00
2024-10-30 18:46:09 +01:00
In addition to providing the defined protocol methods and attributes, subscripting
the instance is equivalent to calling the :meth: `!get` method.
2024-10-07 15:44:18 +02:00
Every `Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_
includes some metadata, which you can extract using the :func: `!metadata` function::
2019-05-25 01:59:01 +02:00
>>> wheel_metadata = metadata('wheel') # doctest: +SKIP
2024-10-07 15:44:18 +02:00
The keys of the returned data structure name the metadata keywords, and
2020-12-31 18:56:43 +01:00
the values are returned unparsed from the distribution metadata::
2019-05-25 01:59:01 +02:00
>>> wheel_metadata['Requires-Python'] # doctest: +SKIP
'>=2.7, !=3.0.*, !=3.1.* , !=3.2.*, !=3.3.* '
2024-10-07 18:51:53 +02:00
:class: `PackageMetadata` also presents a :attr: `!json` attribute that returns
2021-05-02 23:03:40 +02:00
all the metadata in a JSON-compatible form per :PEP: `566` ::
>>> wheel_metadata.json['requires_python']
'>=2.7, !=3.0.*, !=3.1.* , !=3.2.*, !=3.3.* '
2024-10-07 15:44:18 +02:00
The full set of available metadata is not described here.
See the PyPA `Core metadata specification <https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata> `_ for additional details.
2022-06-26 03:04:28 +02:00
2021-05-02 23:03:40 +02:00
.. versionchanged :: 3.10
The `` Description `` is now included in the metadata when presented
through the payload. Line continuation characters have been removed.
The `` json `` attribute was added.
2019-05-25 01:59:01 +02:00
.. _version:
Distribution versions
---------------------
2024-10-07 15:44:18 +02:00
.. function :: version(distribution_name)
Return the installed distribution package version for the named
distribution package.
Raises :exc: `PackageNotFoundError` if the named distribution
package is not installed in the current Python environment.
The :func: `!version` function is the quickest way to get a
2022-10-06 21:25:24 +02:00
`Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_ 's version
2019-05-25 01:59:01 +02:00
number, as a string::
>>> version('wheel') # doctest: +SKIP
'0.32.3'
.. _files:
Distribution files
------------------
2024-10-07 15:44:18 +02:00
.. function :: files(distribution_name)
Return the full set of files contained within the named
distribution package.
Raises :exc: `PackageNotFoundError` if the named distribution
package is not installed in the current Python environment.
Returns :const: `None` if the distribution is found but the installation
database records reporting the files associated with the distribuion package
are missing.
.. class :: PackagePath
A :class: `pathlib.PurePath` derived object with additional `` dist `` ,
`` size `` , and `` hash `` properties corresponding to the distribution
package's installation metadata for that file.
The :func: `!files` function takes a
`Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_
name and returns all of the files installed by this distribution. Each file is reported
as a :class: `PackagePath` instance. For example::
2019-05-25 01:59:01 +02:00
>>> util = [p for p in files('wheel') if 'util.py' in str(p)][0] # doctest: +SKIP
>>> util # doctest: +SKIP
PackagePath('wheel/util.py')
>>> util.size # doctest: +SKIP
859
>>> util.dist # doctest: +SKIP
<importlib.metadata._hooks.PathDistribution object at 0x101e0cef0>
>>> util.hash # doctest: +SKIP
<FileHash mode: sha256 value: bYkw5oMccfazVCoYQwKkkemoVyMAFoR34mmKBx8R1NI>
Once you have the file, you can also read its contents::
>>> print(util.read_text()) # doctest: +SKIP
import base64
import sys
...
def as_bytes(s):
if isinstance(s, text_type):
return s.encode('utf-8')
return s
2024-10-07 18:51:53 +02:00
You can also use the :meth: `!locate` method to get the absolute
2024-10-07 15:44:18 +02:00
path to the file::
2021-04-29 01:27:37 +02:00
>>> util.locate() # doctest: +SKIP
PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')
2019-09-02 17:08:03 +02:00
In the case where the metadata file listing files
2024-10-07 15:44:18 +02:00
(`` RECORD `` or `` SOURCES.txt `` ) is missing, :func: `!files` will
return :const: `None` . The caller may wish to wrap calls to
:func: `!files` in `always_iterable
2019-09-02 17:08:03 +02:00
<https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable> `_
or otherwise guard against this condition if the target
distribution is not known to have the metadata present.
2019-05-25 01:59:01 +02:00
.. _requirements:
Distribution requirements
-------------------------
2024-10-07 15:44:18 +02:00
.. function :: requires(distribution_name)
Return the declared dependency specifiers for the named
distribution package.
Raises :exc: `PackageNotFoundError` if the named distribution
package is not installed in the current Python environment.
2022-10-06 21:25:24 +02:00
To get the full set of requirements for a `Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_ ,
2024-10-07 15:44:18 +02:00
use the :func: `!requires`
2019-09-10 15:53:31 +02:00
function::
2019-05-25 01:59:01 +02:00
2019-09-10 15:53:31 +02:00
>>> requires('wheel') # doctest: +SKIP
["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]
2019-05-25 01:59:01 +02:00
2022-10-06 21:25:24 +02:00
.. _package-distributions:
.. _import-distribution-package-mapping:
Mapping import to distribution packages
---------------------------------------
2021-03-13 17:31:45 +01:00
2024-10-07 15:44:18 +02:00
.. function :: packages_distributions()
Return a mapping from the top level module and import package
names found via :attr: `sys.meta_path` to the names of the distribution
packages (if any) that provide the corresponding files.
To allow for namespace packages (which may have members provided by
multiple distribution packages), each top level import name maps to a
list of distribution names rather than mapping directly to a single name.
2022-10-06 21:25:24 +02:00
A convenience method to resolve the `Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_
name (or names, in the case of a namespace package)
that provide each importable top-level
Python module or `Import Package <https://packaging.python.org/en/latest/glossary/#term-Import-Package> `_ ::
2021-03-13 17:31:45 +01:00
>>> packages_distributions()
{'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...}
2023-04-21 04:12:48 +02:00
Some editable installs, `do not supply top-level names
<https://github.com/pypa/packaging-problems/issues/609> `_, and thus this
function is not reliable with such installs.
2021-03-15 03:20:49 +01:00
.. versionadded :: 3.10
2022-03-13 20:53:29 +01:00
.. _distributions:
2021-03-13 17:31:45 +01:00
2019-05-25 01:59:01 +02:00
Distributions
=============
2024-10-07 15:44:18 +02:00
.. function :: distribution(distribution_name)
Return a :class: `Distribution` instance describing the named
distribution package.
Raises :exc: `PackageNotFoundError` if the named distribution
package is not installed in the current Python environment.
.. class :: Distribution
Details of an installed distribution package.
Note: different :class: `!Distribution` instances do not currently compare
equal, even if they relate to the same installed distribution and
accordingly have the same attributes.
While the module level API described above is the most common and convenient usage,
you can get all of that information from the :class: `!Distribution` class.
:class: `!Distribution` is an abstract object that represents the metadata for
a Python `Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_ .
You can get the concreate :class: `!Distribution` subclass instance for an installed
distribution package by calling the :func: `distribution` function::
2019-05-25 01:59:01 +02:00
>>> from importlib.metadata import distribution # doctest: +SKIP
>>> dist = distribution('wheel') # doctest: +SKIP
2024-10-07 15:44:18 +02:00
>>> type(dist) # doctest: +SKIP
<class 'importlib.metadata.PathDistribution'>
2019-05-25 01:59:01 +02:00
Thus, an alternative way to get the version number is through the
2024-10-07 15:44:18 +02:00
:class: `!Distribution` instance::
2019-05-25 01:59:01 +02:00
>>> dist.version # doctest: +SKIP
'0.32.3'
2024-10-07 15:44:18 +02:00
There are all kinds of additional metadata available on :class: `!Distribution`
instances::
2019-05-25 01:59:01 +02:00
2020-12-31 20:37:53 +01:00
>>> dist.metadata['Requires-Python'] # doctest: +SKIP
2019-05-25 01:59:01 +02:00
'>=2.7, !=3.0.*, !=3.1.* , !=3.2.*, !=3.3.* '
2020-12-31 20:37:53 +01:00
>>> dist.metadata['License'] # doctest: +SKIP
2019-05-25 01:59:01 +02:00
'MIT'
2024-05-16 07:13:47 +02:00
For editable packages, an `` origin `` property may present :pep: `610`
2023-12-21 21:04:05 +01:00
metadata::
>>> dist.origin.url
'file:///path/to/wheel-0.32.3.editable-py3-none-any.whl'
2022-10-06 21:25:24 +02:00
The full set of available metadata is not described here.
2024-10-07 15:44:18 +02:00
See the PyPA `Core metadata specification <https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata> `_ for additional details.
2019-05-25 01:59:01 +02:00
2023-12-21 21:04:05 +01:00
.. versionadded :: 3.13
The `` .origin `` property was added.
2019-05-25 01:59:01 +02:00
2022-06-26 03:04:28 +02:00
Distribution Discovery
======================
2022-10-06 21:25:24 +02:00
By default, this package provides built-in support for discovery of metadata
for file system and zip file `Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_ \s.
This metadata finder search defaults to `` sys.path `` , but varies slightly in how it interprets those values from how other import machinery does. In particular:
2022-06-26 03:04:28 +02:00
- `` importlib.metadata `` does not honor :class: `bytes` objects on `` sys.path `` .
- `` importlib.metadata `` will incidentally honor :py:class: `pathlib.Path` objects on `` sys.path `` even though such values will be ignored for imports.
2024-09-13 04:29:08 +02:00
Implementing Custom Providers
=============================
`` importlib.metadata `` address two API surfaces, one for *consumers*
and another for *providers* . Most users are consumers, consuming
metadata provided by the packages. There are other use-cases, however,
where users wish to expose metadata through some other mechanism,
such as alongside a custom importer. Such a use case calls for a
*custom provider* .
2019-05-25 01:59:01 +02:00
2022-10-06 21:25:24 +02:00
Because `Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package> `_ metadata
is not available through :data: `sys.path` searches, or
package loaders directly,
the metadata for a distribution is found through import
2024-09-13 04:29:08 +02:00
system :ref: `finders <finders-and-loaders>` . To find a distribution package's metadata,
2019-12-29 18:26:35 +01:00
`` importlib.metadata `` queries the list of :term: `meta path finders <meta path finder>` on
:data: `sys.meta_path` .
2019-05-25 01:59:01 +02:00
2024-09-13 04:29:08 +02:00
The implementation has hooks integrated into the `` PathFinder `` ,
serving metadata for distribution packages found on the file system.
2019-05-25 01:59:01 +02:00
The abstract class :py:class: `importlib.abc.MetaPathFinder` defines the
interface expected of finders by Python's import system.
`` importlib.metadata `` extends this protocol by looking for an optional
`` find_distributions `` callable on the finders from
2019-12-29 18:26:35 +01:00
:data: `sys.meta_path` and presents this extended interface as the
2019-09-10 15:53:31 +02:00
`` DistributionFinder `` abstract base class, which defines this abstract
method::
2019-05-25 01:59:01 +02:00
2019-09-10 15:53:31 +02:00
@abc.abstractmethod
2024-09-13 04:29:08 +02:00
def find_distributions(context=DistributionFinder.Context()) -> Iterable[Distribution]:
2019-05-25 01:59:01 +02:00
"""Return an iterable of all Distribution instances capable of
2019-09-10 15:53:31 +02:00
loading the metadata for packages for the indicated `` context `` .
2019-05-25 01:59:01 +02:00
"""
2019-09-10 15:53:31 +02:00
The `` DistributionFinder.Context `` object provides `` .path `` and `` .name ``
2020-06-05 22:34:16 +02:00
properties indicating the path to search and name to match and may
2024-09-13 04:29:08 +02:00
supply other relevant context sought by the consumer.
2019-09-10 15:53:31 +02:00
2024-09-13 04:29:08 +02:00
In practice, to support finding distribution package
2019-12-11 02:05:10 +01:00
metadata in locations other than the file system, subclass
`` Distribution `` and implement the abstract methods. Then from
a custom finder, return instances of this derived `` Distribution `` in the
2019-09-10 15:53:31 +02:00
`` find_distributions() `` method.
2019-05-25 01:59:01 +02:00
2024-05-01 19:04:02 +02:00
Example
-------
2024-09-13 04:29:08 +02:00
Imagine a custom finder that loads Python modules from a database::
2024-05-01 19:04:02 +02:00
class DatabaseImporter(importlib.abc.MetaPathFinder):
def __init__(self, db):
self.db = db
def find_spec(self, fullname, target=None) -> ModuleSpec:
return self.db.spec_from_name(fullname)
sys.meta_path.append(DatabaseImporter(connect_db(...)))
That importer now presumably provides importable modules from a
database, but it provides no metadata or entry points. For this
custom importer to provide metadata, it would also need to implement
`` DistributionFinder `` ::
from importlib.metadata import DistributionFinder
class DatabaseImporter(DistributionFinder):
...
def find_distributions(self, context=DistributionFinder.Context()):
query = dict(name=context.name) if context.name else {}
for dist_record in self.db.query_distributions(query):
yield DatabaseDistribution(dist_record)
In this way, `` query_distributions `` would return records for
each distribution served by the database matching the query. For
example, if `` requests-1.0 `` is in the database, `` find_distributions ``
would yield a `` DatabaseDistribution `` for `` Context(name='requests') ``
or `` Context(name=None) `` .
For the sake of simplicity, this example ignores `` context.path ` ` \. The
`` path `` attribute defaults to `` sys.path `` and is the set of import paths to
be considered in the search. A `` DatabaseImporter `` could potentially function
without any concern for a search path. Assuming the importer does no
partitioning, the "path" would be irrelevant. In order to illustrate the
purpose of `` path `` , the example would need to illustrate a more complex
`` DatabaseImporter `` whose behavior varied depending on
`` sys.path `` /`` PYTHONPATH `` . In that case, the `` find_distributions `` should
honor the `` context.path `` and only yield `` Distribution ` ` \ s pertinent to that
path.
`` DatabaseDistribution `` , then, would look something like::
2024-10-21 10:44:18 +02:00
class DatabaseDistribution(importlib.metadata.Distribution):
2024-05-01 19:04:02 +02:00
def __init__(self, record):
self.record = record
def read_text(self, filename):
"""
Read a file like "METADATA" for the current distribution.
"""
if filename == "METADATA":
return f"""Name: {self.record.name}
Version: {self.record.version}
"""
if filename == "entry_points.txt":
return "\n".join(
f"""[{ep.group}]\n{ep.name}={ep.value}"""
for ep in self.record.entry_points)
def locate_file(self, path):
raise RuntimeError("This distribution has no file system")
This basic implementation should provide metadata and entry points for
packages served by the `` DatabaseImporter `` , assuming that the
`` record `` supplies suitable `` .name `` , `` .version `` , and
`` .entry_points `` attributes.
The `` DatabaseDistribution `` may also provide other metadata files, like
`` RECORD `` (required for `` Distribution.files `` ) or override the
implementation of `` Distribution.files `` . See the source for more inspiration.
2019-05-25 01:59:01 +02:00
.. _`entry point API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points
.. _`metadata API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api