# 使用 `importlib.metadata`

3.8 版新加入.

源代码： Lib/importlib/metadata.py

備註

这个功能是暂定的，可能会偏离标准库通常的版本语义。

`importlib.metadata` 是一个提供对已安装包的元数据访问的库。这个库部分建立在 Python 的导入系统上，旨在取代 `pkg_resources` 的 entry point API 和 metadata API 中的类似功能。 通过和 Python 3.7 或更高版本中的 `importlib.resources` 一同使用（对于旧版本的 Python 则作为 importlib_resources 向后移植），这可以消除对使用较旧且较为低效的 `pkg_resources` 包的需要。

此处所说的 “已安装的包” 通常指通过 pip 等工具安装在 Python `site-packages` 目录下的第三方包。具体来说，它指的是一个具有可发现的 `dist-info` 或 `egg-info` 目录以及 PEP 566 或其更早的规范所定义的元数据的包。默认情况下，包的元数据可以存在于文件系统中或 `sys.path` 上的压缩文件中。 通过扩展机制，元数据几乎可以存在于任何地方。

## 概述

假设你想得到你用 `pip` 安装的一个包的版本字符串。 我们首先创建一个虚拟环境，并在其中安装一些东西：

    $ python3 -m venv example
    $ source example/bin/activate
    (example) $ pip install wheel

你可以通过运行以下代码得到 `wheel` 的版本字符串：

    (example) $ python
    >>> from importlib.metadata import version
    >>> version('wheel')
    '0.32.3'

你也可以获得以组名为关键字的入口点集合，比如 `console_scripts` 和 `distutils.commands` 。每个组包含一个 入口点 对象的序列。

你可以获得 分发的元数据：

    >>> list(metadata('wheel'))
    ['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']

你也可以获得 分发的版本号，列出它的 构成文件，并且得到分发的 分发的依赖 列表。

## 函数式 API

这个包通过其公共 API 提供了以下功能。

### 入口点

The `entry_points()` function returns a dictionary of all entry points, keyed by group. Entry points are represented by `EntryPoint` instances; each `EntryPoint` has a `.name`, `.group`, and `.value` attributes and a `.load()` method to resolve the value.

    >>> eps = entry_points()
    >>> list(eps)
    ['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']
    >>> scripts = eps['console_scripts']
    >>> wheel = [ep for ep in scripts if ep.name == 'wheel'][0]
    >>> wheel
    EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')
    >>> main = wheel.load()
    >>> main
    <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 group. Read the setuptools docs for more information on entrypoints, their definition, and usage.

### 分发的元数据

每个分发都包含某些元数据，你可以通过 `metadata()` 函数提取它们：

    >>> wheel_metadata = metadata('wheel')

The keys of the returned data structure 1 name the metadata keywords, and their values are returned unparsed from the distribution metadata:

    >>> wheel_metadata['Requires-Python']
    '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

### 分发的版本

`version()` 函数是以字符串形式获取分发的版本号的最快方式：

    >>> version('wheel')
    '0.32.3'

### 分发的文件

You can also get the full set of files contained within a distribution. The `files()` function takes a distribution package name and returns all of the files installed by this distribution. Each file object returned is a `PackagePath`, a `pathlib.Path` derived object with additional `dist`, `size`, and `hash` properties as indicated by the metadata. For example:

    >>> util = [p for p in files('wheel') if 'util.py' in str(p)][0]
    >>> util
    PackagePath('wheel/util.py')
    >>> util.size
    859
    >>> util.dist
    <importlib.metadata._hooks.PathDistribution object at 0x101e0cef0>
    >>> util.hash
    <FileHash mode: sha256 value: bYkw5oMccfazVCoYQwKkkemoVyMAFoR34mmKBx8R1NI>

当你获得了文件对象，你可以读取其内容：

    >>> print(util.read_text())
    import base64
    import sys
    ...
    def as_bytes(s):
        if isinstance(s, text_type):
            return s.encode('utf-8')
        return s

当列出包含文件的元数据文件（RECORD 或 SOURCES.txt）不存在时， `files()` 函数将返回 `None` 。调用者可能会想要将对 `files()` 的调用封装在 always_iterable 中，或者用其他方法来应对目标分发元数据存在性未知的情况。

### 分发的依赖

使用 `requires()` 函数来获得分发的依赖集合：

    >>> requires('wheel')
    ["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]

## 分发

以上的 API 是最常见而方便的用法，但是你也可以通过 `Distribution` 类获得以上所有信息。 `Distribution` 是一个代表 Python 包的元数据的抽象对象。你可以这样获取 `Distribution` 实例：

    >>> from importlib.metadata import distribution
    >>> dist = distribution('wheel')

因此，可以通过 `Distribution` 实例获得版本号：

    >>> dist.version
    '0.32.3'

`Distribution` 实例具有所有可用的附加元数据：

    >>> dist.metadata['Requires-Python']
    '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
    >>> dist.metadata['License']
    'MIT'

此处并未描述全部可用的元数据集合。 请参见 PEP 566 以了解更多细节。

## 扩展搜索算法

因为包的元数据无法通过搜索 `sys.path` 或通过包加载器获得，包的元数据是通过导入系统的 查找器 找到的。 `importlib.metadata` 查询在 `sys.meta_path` 上的 元数据查找器 列表以获得分发包的元数据。

Python 默认的 `PathFinder` 包含一个调用 `importlib.metadata.MetadataPathFinder` 来查找从典型的文件系统路径加载发布的钩子。

抽象基类 `importlib.abc.MetaPathFinder` 定义了 Python 导入系统期望的查找器接口。 `importlib.metadata` 通过寻找 `sys.meta_path` 上查找器可选的 `find_distributions` 可调用的属性扩展这个协议，并将这个扩展接口作为 `DistributionFinder` 抽象基类提供，它定义了这个抽象方法：

    @abc.abstractmethod
    def find_distributions(context=DistributionFinder.Context()):
        """Return an iterable of all Distribution instances capable of
        loading the metadata for packages for the indicated ``context``.
        """

The `DistributionFinder.Context` object provides `.path` and `.name` properties indicating the path to search and names to match and may supply other relevant context.

这在实践中意味着要支持在文件系统外的其他位置查找分发包的元数据，你需要子类化 `Distribution` 并实现抽象方法，之后从一个自定义查找器的 `find_distributions()` 方法返回这个派生的 `Distribution` 实例。

备注

1

  Technically, the returned distribution metadata object is an `email.message.EmailMessage` instance, but this is an implementation detail, and not part of the stable API. You should only use dictionary-like methods and syntax to access the metadata contents.