# `importlib.metadata` を使う

バージョン 3.8 で追加.

バージョン 3.10 で変更: `importlib.metadata` は暫定的なものではなくなりました。

ソースコード: Lib/importlib/metadata/__init__.py

`importlib.metadata` is a library that provides for access to installed package metadata. Built in part on Python's import system, this library intends to replace similar functionality in the entry point API and metadata API of `pkg_resources`. Along with `importlib.resources` in Python 3.7 and newer (backported as importlib_resources for older versions of Python), this can eliminate the need to use the older and less efficient `pkg_resources` package.

By "installed package" we generally mean a third-party package installed into Python's `site-packages` directory via tools such as pip. Specifically, it means a package with either a discoverable `dist-info` or `egg-info` directory, and metadata defined by PEP 566 or its older specifications. By default, package metadata can live on the file system or in zip archives on `sys.path`. Through an extension mechanism, the metadata can live almost anywhere.

## 概要

Let's say you wanted to get the version string for a package you've installed using `pip`. We start by creating a virtual environment and installing something into it:

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

以下のように実行することで、`wheel` のバージョン文字列を取得することができます:

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

You can also get the set of entry points keyed by group, such as `console_scripts`, `distutils.commands` and others. Each group contains a sequence of EntryPoint objects.

ディストリビューションのメタデータ を取得することができます。:

    >>> 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を通じて以下の機能を提供します。

### エントリポイント

`entry_points()` 関数は、エントリポイントの集合を返します。各 `EntryPoint` は `.name`, `.group`, `.value` 属性と値を解決する `.load()` メソッドを持っています。 また、 `.value` 属性の構成要素を取得するための `.module`, `.attr`, `.extras` 属性が存在します。

すべてのエントリポイントに問い合わせる:

    >>> eps = entry_points()

The `entry_points()` function returns an `EntryPoints` object, a sequence of all `EntryPoint` objects with `names` and `groups` attributes for convenience:

    >>> sorted(eps.groups)
    ['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']

`EntryPoints` には、特定のプロパティに一致するエントリポイントを選択するための `select` メソッドがあります。`console_scripts` グループ内のエントリポイントを選択する:

    >>> scripts = eps.select(group='console_scripts')

Equivalently, since `entry_points` passes keyword arguments through to select:

    >>> scripts = entry_points(group='console_scripts')

"wheel" という名前の特定のスクリプトを選択します。(wheelプロジェクトにあります):

    >>> 'wheel' in scripts.names
    True
    >>> wheel = scripts['wheel']

同様に、選択時にそのエントリポイントを問い合わせます:

    >>> (wheel,) = entry_points(group='console_scripts', name='wheel')
    >>> (wheel,) = entry_points().select(group='console_scripts', name='wheel')

解決したエントリポイントを検証する:

    >>> wheel
    EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')
    >>> wheel.module
    'wheel.cli'
    >>> wheel.attr
    'main'
    >>> wheel.extras
    []
    >>> main = wheel.load()
    >>> main
    <function main at 0x103528488>

`group` と `name` はパッケージの作者によって定義された任意の値で、通常クライアントは特定のグループのエントリポイントを解決したいと思うでしょう。エントリポイント、その他の定義、使用方法についての詳細は setuptoolsのドキュメント を参照してください。

互換性に関する注意

"選択可能" なエントリポイントは `importlib_metadata` 3.6 と Python 3.10 で導入されました。これらの変更以前は、 `entry_points` はパラメータを受け付けず、常にグループ名をキーとするエントリポイントの辞書を返していました。互換性のため、entry_points にパラメータが渡されない場合、その dict インターフェースを実装した `SelectableGroups` オブジェクトが返されます。将来的には、パラメータを指定せずに `entry_points` を呼び出すと、 `EntryPoints` オブジェクトが返されるようになります。ユーザーは、グループごとにエントリポイントを取得するために、選択インターフェースに依存する必要があります。

### 配布物メタデータ

Every distribution includes some metadata, which you can extract using the `metadata()` function:

    >>> wheel_metadata = metadata('wheel')

返されたデータ構造である `PackageMetadata` のキーはメタデータのキーワードを表し、値は配布パッケージのメタデータから解析されずに返されます:

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

`PackageMetadata` には `json` 属性があり、 PEP 566 に従ってすべてのメタデータをJSON互換の形式で返します:

    >>> wheel_metadata.json['requires_python']
    '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

バージョン 3.10 で変更: ペイロードを通して提示されるとき、 `Description` がメタデータに含まれるようになりました。行の継続文字は削除されました。

バージョン 3.10 で追加: `json` 属性が追加されました。

### 配布物バージョン

The `version()` function is the quickest way to get a distribution's version number, as a string:

    >>> 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.PurePath` 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

また、 `locate` メソッドを使用すると、ファイルへの絶対パスを取得することができます:

    >>> util.locate()
    PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')

In the case where the metadata file listing files (RECORD or SOURCES.txt) is missing, `files()` will return `None`. The caller may wish to wrap calls to `files()` in always_iterable or otherwise guard against this condition if the target distribution is not known to have the metadata present.

### 配布物の要件

To get the full set of requirements for a distribution, use the `requires()` function:

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

### Package distributions

A convenience method to resolve the distribution or distributions (in the case of a namespace package) for top-level Python packages or modules:

    >>> packages_distributions()
    {'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...}

バージョン 3.10 で追加.

## Distributions

While the above API is the most common and convenient usage, you can get all of that information from the `Distribution` class. A `Distribution` is an abstract object that represents the metadata for a Python package. You can get the `Distribution` instance:

    >>> 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'

The full set of available metadata is not described here. See PEP 566 for additional details.

## 検索アルゴリズムの拡張

Because package metadata is not available through `sys.path` searches, or package loaders directly, the metadata for a package is found through import system finders. To find a distribution package's metadata, `importlib.metadata` queries the list of meta path finders on `sys.meta_path`.

The default `PathFinder` for Python includes a hook that calls into `importlib.metadata.MetadataPathFinder` for finding distributions loaded from typical file-system-based paths.

抽象クラス `importlib.abc.MetaPathFinder` はPythonの importシステムによってファインダーに期待されるインターフェイスを定義しています。 `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``.
        """

`DistributionFinder.Context` オブジェクトは、検索するパスと一致する名前を示す `.path` と `.name` のプロパティを提供し、その他の関連するコンテキストを提供することもできます。

つまり、ファイルシステム以外の場所にある配布パッケージのメタデータを見つけるには、 `Distribution` をサブクラス化して抽象メソッドを実装します。そして、カスタムファインダーから `find_distributions()` メソッドで、派生した `Distribution` のインスタンスを返します。