Skip to main content

Read metadata from Python packages

Project description

=========================
``importlib_metadata``
=========================

``importlib_metadata`` is a library to access the metadata for a Python
package. It is intended to be ported to Python 3.8.


Usage
=====

``importlib_metadata``, unlike its sister packages importlib and
importlib.resources, operates on Python Distribution packages (the
package as installed by pip or similar).

The main feature is the :class:`Distribution` class.

Construct one by passing a top-level module (or package) to
:func:`distribution`:

>>> dist = importlib_resources.distribution(importlib_resources)

From there, the package metadata is available on ``dist.metadata``:

>>> 'Version' in dist.metadata
True

:func:`distribution` also accepts a known distribution package name:

>>> dist = importlib_resources.distribution('importlib_resources')


Package Version
===============

`PEP 396 <https://www.python.org/dev/peps/pep-0396/>` specifies
a convention for presenting a package's version. For many packages,
this version is not defined in code, but is primarily or only defined
in the package metadata. In this case, use of ``importlib_metadata``
can present this version::

__version__ = importlib_metadata.Distribution.from_named_module(__name__).version


Distribution Name
=================

This project introduces the concept of a mapping from an imported module
to its distribution package name. Many times, the name of the imported
module or package matches the distribution package (e.g. requests).

Other times, the imported name and distribution package name differ.
For example, the ``path`` module is the top-level module in the
`path.py <https://pypi.org/project/path.py>`_ distribution package
and in the `setuptools <https://pypi.org/project/setuptools>`_
project, there are two top-level packages, ``setuptools`` and
``pkg_resources``, both sharing the same metadata.

For projects where the name of the top level module does not match
exactly to the distribution package name, those modules should present
a ``__dist_name__`` member with the distribution package name
and this property will be used by importlib_metadata to resolve the
metadata for those Python packages.


Support for Custom Package Installers
=====================================

``importlib_metadata`` provides hooks for third-party package installers
through their declared finders. A custom installer, if it provides its
own finder for installed packages, should also provide on that finder
a ``find_distribution`` callable that when called with
the name of a package will return a ``Distribution`` instance capable
of loading the metadata for that named package (or None if that finder
has no knowledge of that package or its metadata).


Caveats
=======

This project primarily supports third-party packages installed by PyPA
tools (or other conforming packages). It does not support:

- Packages in the stdlib.
- Packages installed without metadata.
- Zip packages.


Project details
===============

* Project home: https://gitlab.com/python-devs/importlib_metadata
* Report bugs at: https://gitlab.com/python-devs/importlib_metadata/issues
* Code hosting: https://gitlab.com/python-devs/importlib_metadata.git
* Documentation: http://importlib_metadata.readthedocs.io/


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for importlib-metadata, version 0.3
Filename, size File type Python version Upload date Hashes
Filename, size importlib_metadata-0.3-py2.py3-none-any.whl (17.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size importlib_metadata-0.3.tar.gz (15.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page