# Using `importlib.metadata`

Novo na versão 3.8.

Alterado na versão 3.10: `importlib.metadata` não é mais provisório.

Código-fonte: 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.

## Visão Geral

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

Você pode obter a string de versão para `wheel` executando o seguinte:

    (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.

Você pode obter os metadados para uma distribuição:

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

Você também pode obter uma número da versão da distribuição, listar seus arquivos constituintes e obter uma lista dos Requisitos de distribuição da distribuição.

## API funcional

Este pacote fornece a seguinte funcionalidade por meio de sua API pública.

### Pontos de entrada

A função `entry_points()` retorna uma coleção de pontos de entrada. Os pontos de entrada são representados por instâncias `EntryPoint`; cada `EntryPoint` tem atributos `.name`, `.group` e `.value` e um método `.load()` para resolver o valor. Existem também atributos `.module`, `.attr` e `.extras` para obter os componentes do atributo `.value`.

Consultar todos os pontos de entrada:

    >>> 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` possui um método `select` para selecionar pontos de entrada que correspondam a propriedades específicas. Selecione pontos de entrada no grupo `console_scripts`:

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

Equivalentemente, já que `entry_points` passa argumento nomeado para seleção:

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

Escolha um script específico chamado “wheel” (encontrado no projeto wheel):

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

De forma equivalente, consulte esse ponto de entrada durante a seleção:

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

Inspecione o ponto de entrada resolvido:

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

O `group` e `name` são valores arbitrários definidos pelo autor do pacote e normalmente um cliente desejará resolver todos os pontos de entrada para um grupo específico. Leia a documentação do setuptools para obter mais informações sobre pontos de entrada, sua definição e uso.

Notas de compatibilidade

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. For compatibility, if no parameters are passed to entry_points, a `SelectableGroups` object is returned, implementing that dict interface. In the future, calling `entry_points` with no parameters will return an `EntryPoints` object. Users should rely on the selection interface to retrieve entry points by group.

### Metadados de distribuição

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

    >>> wheel_metadata = metadata('wheel')

As chaves da estrutura de dados retornada, um `PackageMetadata`, nomeiam as palavras reservadas dos metadados, e os valores são retornados sem análise dos metadados de distribuição:

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

`PackageMetadata` também apresenta um atributo `json` que retorna todos os metadados em um formato compatível com JSON pela PEP 566:

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

Alterado na versão 3.10: A `Description` agora é incluída nos metadados quando apresentada através do payload. Os caracteres de continuação de linha foram removidos.

Novo na versão 3.10: O atributo `json` foi adicionado.

### Versões de distribuição

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

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

### Arquivos de distribuição

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>

Uma vez que tenha o arquivo, você também pode ler seu conteúdo:

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

Você também pode usar o método `locate` para obter o caminho absoluto para o arquivo:

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

No caso em que o arquivo de metadados que lista os arquivos (RECORD ou SOURCES.txt) estiver faltando, `files()` retornará `None`. O chamador pode querer agrupar chamadas para `files()` em always_iterable ou de outra forma se proteger contra isso condição se a distribuição de destino não for conhecida por ter os metadados presentes.

### Requisitos de distribuição

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'], ...}

Novo na versão 3.10.

## Distribuições

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

Assim, uma forma alternativa de obter o número da versão é através da instância `Distribution`:

    >>> dist.version
    '0.32.3'

Existem todos os tipos de metadados adicionais disponíveis na instância `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.

## Estendendo o algoritmo de pesquisa

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.

A classe abstrata `importlib.abc.MetaPathFinder` define a interface esperada dos localizadores pelo sistema de importação do Python. `importlib.metadata` estende este protocolo procurando por um chamável `find_distributions` opcional nos localizadores de `sys.meta_path` e apresenta esta interface estendida como a classe base abstrata `DistributionFinder`, que define este método abstrato:

    @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``.
        """

O objeto `DistributionFinder.Context` fornece propriedades `.path` e `.name` indicando o caminho para pesquisar e o nome a ser correspondido e pode fornecer outro contexto relevante.

O que isso significa na prática é que para prover suporte à localização de metadados de pacotes de distribuição em outros locais fora do sistema de arquivos, crie uma subclasse `Distribution` e implemente os métodos abstratos. Então, a partir de um localizador personalizado, retorne instâncias deste derivado de `Distribution` no método `find_distributions()`.