importlib.metadata – Доступ к метаданным пакета¶importlib.metadata – Accessing package metadata

Точки входа¶Entry points

importlib.metadata.entry_points(**select_params)¶

Возвращает экземпляр EntryPoints, описывающий точки входа для текущего окружения. Любые заданные именованные параметры передаются методу select() для сравнения с атрибутами отдельных определений точек входа.

Примечание: в настоящее время невозможно запрашивать точки входа на основе их атрибута EntryPoint.dist (поскольку разные экземпляры Distribution в настоящее время не сравниваются как равные, даже если они имеют одинаковые атрибуты)

class importlib.metadata.EntryPoints¶

Подробности о коллекции установленных точек входа.

Также предоставляет атрибут .groups, который сообщает все идентифицированные группы точек входа, и атрибут .names, который сообщает все идентифицированные имена точек входа.

class importlib.metadata.EntryPoint¶

Подробности об установленной точке входа.

Каждый экземпляр EntryPoint имеет атрибуты .name, .group и .value и метод .load() для разрешения значения. Также есть атрибуты .module, .attr и .extras для получения компонентов атрибута .value и .dist для получения информации о дистрибутивном пакете, который предоставляет точку входа.

Запрос всех точек входа:

>>> eps = entry_points()

Функция entry_points() возвращает объект EntryPoints, коллекцию всех объектов EntryPoint с атрибутами names и groups для удобства:

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

Аналогично, поскольку entry_points() передаёт ключевые аргументы в 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.

Метаданные дистрибутива¶Distribution metadata

importlib.metadata.metadata(distribution_name)¶

Возвращает метаданные дистрибутива для указанного пакета дистрибутива в виде экземпляра PackageMetadata.

Вызывает PackageNotFoundError, если именованный дистрибутивный пакет не установлен в текущем окружении Python.

class importlib.metadata.PackageMetadata¶

Конкретная реализация протокола PackageMetadata.

В дополнение к предоставлению определённых методов и атрибутов протокола, обращение к экземпляру по индексу эквивалентно вызову метода get().

Каждый пакет дистрибутива содержит метаданные, которые можно извлечь с помощью функции metadata():

>>> wheel_metadata = metadata('wheel')

Ключи возвращаемой структуры данных соответствуют ключевым словам метаданных, а значения возвращаются без разбора из метаданных дистрибутива:

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

PackageMetadata также предоставляет атрибут json, который возвращает все метаданные в JSON-совместимой форме согласно PEP 566:

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

Полный набор доступных метаданных здесь не описывается. За дополнительными сведениями обратитесь к спецификации основных метаданных PyPA.

Версии дистрибутивов¶Distribution versions

importlib.metadata.version(distribution_name)¶

Возвращает версию установленного пакета дистрибутива для указанного пакета дистрибутива.

Вызывает PackageNotFoundError, если именованный дистрибутивный пакет не установлен в текущем окружении Python.

Функция version() – это самый быстрый способ получить номер версии пакета дистрибутива в виде строки:

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

Файлы дистрибутива¶Distribution files

importlib.metadata.files(distribution_name)¶

Возвращает полный набор файлов, содержащихся в указанном пакете дистрибутива.

Вызывает PackageNotFoundError, если именованный дистрибутивный пакет не установлен в текущем окружении Python.

Возвращает None, если дистрибутив найден, но в базе данных установки отсутствуют записи, сообщающие о файлах, связанных с этим пакетом.

class importlib.metadata.PackagePath¶

Объект, производный от pathlib.PurePath, с дополнительными свойствами dist, size и hash, соответствующими метаданным установки пакета дистрибутива для этого файла.

Функция files() принимает имя дистрибутивного пакета и возвращает все файлы, установленные этим дистрибутивом. Каждый файл представлен как экземпляр PackagePath. Например:

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

Если файл метаданных со списком файлов (RECORD или SOURCES.txt) отсутствует, files() вернёт None. Вызывающий код может обернуть вызовы files() в always_iterable или иным образом защититься от такой ситуации, если неизвестно, что целевой дистрибутив содержит эти метаданные.

Зависимости дистрибутивов¶Distribution requirements

importlib.metadata.requires(distribution_name)¶

Возвращает объявленные спецификаторы зависимостей для именованного дистрибутивного пакета.

Вызывает PackageNotFoundError, если именованный дистрибутивный пакет не установлен в текущем окружении Python.

Чтобы получить полный набор зависимостей для дистрибутивного пакета, используйте функцию requires():

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

Отображение импортов на дистрибутивы¶Mapping import to distribution packages

importlib.metadata.packages_distributions()¶

Возвращает отображение имён модулей верхнего уровня и импортируемых пакетов, найденных с помощью sys.meta_path, на имена дистрибутивных пакетов (если таковые есть), предоставляющих соответствующие файлы.

Для поддержки пакетов пространств имён (которые могут содержать компоненты от нескольких дистрибутивов) каждое имя импорта верхнего уровня сопоставляется со списком имён дистрибутивов, а не напрямую с одним именем.

Удобный метод для разрешения имени дистрибутивного пакета (или имён, в случае пакета пространства имён), который предоставляет каждый импортируемый модуль или импортируемый пакет верхнего уровня:

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

Некоторые редактируемые установки не предоставляют имён верхнего уровня, поэтому эта функция не является надёжной для таких установок.

Пример¶Example

Рассмотрим, например, пользовательский находильщик, загружающий модули Python из базы данных:

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

Этот импортёр предположительно предоставляет импортируемые модули из базы данных, но не предоставляет метаданные или точки входа. Чтобы этот пользовательский импортёр мог предоставлять метаданные, ему также необходимо реализовать 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)

Таким образом, query_distributions будет возвращать записи для каждого дистрибутива, обслуживаемого базой данных, которые соответствуют запросу. Например, если requests-1.0 находится в базе данных, find_distributions вернёт DatabaseDistribution для Context(name='requests') или Context(name=None).

Ради простоты этот пример игнорирует context.path. Атрибут path по умолчанию равен sys.path и представляет собой набор путей импорта, которые следует учитывать при поиске. DatabaseImporter может потенциально функционировать без учёта пути поиска. Если предположить, что импортёр не выполняет разделение, «путь» не будет иметь значения. Чтобы проиллюстрировать назначение path, пример должен показать более сложный DatabaseImporter, поведение которого зависит от sys.path/PYTHONPATH. В таком случае find_distributions должен соблюдать context.path и возвращать только Distribution, относящиеся к этому пути.

Тогда DatabaseDistribution будет выглядеть примерно так:

class DatabaseDistribution(importlib.metadata.Distribution):
    def __init__(self, record):
        self.record = record

    def read_text(self, filename):
        """
        Читает файл, например "METADATA", для текущего 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")

Эта базовая реализация должна предоставлять метаданные и точки входа для пакетов, обслуживаемых DatabaseImporter, при условии, что record предоставляет подходящие атрибуты .name, .version и .entry_points.

DatabaseDistribution может также предоставлять другие файлы метаданных, например RECORD (требуется для Distribution.files), или переопределять реализацию Distribution.files. За дополнительными идеями обращайтесь к исходному коду.