`importlib.metadata.md`

203 строк · 15.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.9/library/importlib.metadata.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Использование `importlib.metadata`89**Исходный код:** [Lib/importlib/metadata.py](https://python-all.ru/src/3.9/Lib/importlib/metadata.py)1011Новое в версии 3.8.1213> **Примечание**14>15> Эта функциональность является предварительной и может отклоняться от обычной семантики версий стандартной библиотеки.1617`importlib.metadata` – это библиотека, обеспечивающая доступ к метаданным установленных пакетов. Частично основанная на системе импорта Python, эта библиотека призвана заменить аналогичную функциональность в [точки входа API](https://python-all.ru/3.9/library/importlib.metadata.html) и [API метаданных](https://python-all.ru/3.9/library/importlib.metadata.html) из `pkg_resources`. Вместе с [`importlib.resources`](https://python-all.ru/3.9/library/importlib.html#module-importlib.resources) (начиная с Python 3.7 и новее, с обратным портированием как [importlib\_resources](https://python-all.ru/3.9/library/importlib.metadata.html) для более старых версий Python), это позволяет отказаться от использования устаревшего и менее эффективного пакета `pkg_resources`.1819Под «установленным пакетом» обычно понимается сторонний пакет, установленный в каталог `site-packages` Python с помощью таких инструментов, как [pip](https://python-all.ru/3.9/library/importlib.metadata.html). В частности, это пакет, имеющий либо обнаруживаемый каталог `dist-info` или `egg-info` и метаданные, определённые [**PEP 566**](https://python-all.ru/3.9/library/importlib.metadata.html) или более старыми спецификациями. По умолчанию метаданные пакета могут находиться в файловой системе или в zip-архивах на [`sys.path`](https://python-all.ru/3.9/library/sys.html#sys.path). Благодаря механизму расширения метаданные могут находиться практически где угодно.2021## Обзор2223Предположим, вы хотите получить строку версии для пакета, установленного с помощью `pip`. Начнём с создания виртуального окружения и установки чего-нибудь в него:2425```console26$ python3 -m venv example27$ source example/bin/activate28(example) $ pip install wheel29```3031Вы можете получить строку версии для `wheel`, выполнив следующее:3233```pycon34(example) $ python35>>> from importlib.metadata import version  36>>> version('wheel')  37'0.32.3'38```3940Также можно получить набор точек входа, разбитых по группам, таких как `console_scripts`, `distutils.commands` и другие. Каждая группа содержит последовательность объектов [EntryPoint](https://python-all.ru/3.9/library/importlib.metadata.html#entry-points).4142Вы можете получить [метаданные для дистрибутива](https://python-all.ru/3.9/library/importlib.metadata.html#metadata):4344```python45>>> list(metadata('wheel'))  46['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']47```4849Вы также можете получить [номер версии дистрибутива](https://python-all.ru/3.9/library/importlib.metadata.html#version), перечислить его [составные файлы](https://python-all.ru/3.9/library/importlib.metadata.html#files) и получить список [зависимостей дистрибутива](https://python-all.ru/3.9/library/importlib.metadata.html#requirements).5051## Функциональное API5253Этот пакет предоставляет следующие функции через свой публичный API.5455### Точки входа5657Функция `entry_points()` возвращает словарь всех точек входа, сгруппированных по группам. Точки входа представлены экземплярами `EntryPoint`; каждый `EntryPoint` имеет атрибуты `.name`, `.group` и `.value`, а также метод `.load()` для разрешения значения. Также имеются атрибуты `.module`, `.attr` и `.extras` для получения компонентов атрибута `.value`:5859```python60>>> eps = entry_points()  61>>> list(eps)  62['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']63>>> scripts = eps['console_scripts']  64>>> wheel = [ep for ep in scripts if ep.name == 'wheel'][0]  65>>> wheel  66EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')67>>> wheel.module  68'wheel.cli'69>>> wheel.attr  70'main'71>>> wheel.extras  72[]73>>> main = wheel.load()  74>>> main  75<function main at 0x103528488>76```7778`group` и `name` – произвольные значения, определяемые автором пакета; обычно клиент хочет получить все точки входа для определённой группы. Подробнее о точках входа, их определении и использовании читайте в [документации setuptools](https://python-all.ru/3.9/library/importlib.metadata.html).7980### Метаданные дистрибутива8182Каждый дистрибутив содержит некоторые метаданные, которые можно извлечь с помощью функции `metadata()`:8384```python85>>> wheel_metadata = metadata('wheel')  86```8788Ключи возвращаемой структуры данных [1](https://python-all.ru/3.9/library/importlib.metadata.html#f1) именуют ключевые слова метаданных, а их значения возвращаются без разбора из метаданных дистрибутива:8990```python91>>> wheel_metadata['Requires-Python']  92'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'93```9495### Версии дистрибутивов9697Функция `version()` – это самый быстрый способ получить номер версии дистрибутива в виде строки:9899```python100>>> version('wheel')  101'0.32.3'102```103104### Файлы дистрибутива105106Также можно получить полный набор файлов, содержащихся в дистрибутиве. Функция `files()` принимает имя пакета дистрибутива и возвращает все файлы, установленные этим дистрибутивом. Каждый возвращаемый файловый объект – это `PackagePath`, производный объект [`pathlib.PurePath`](https://python-all.ru/3.9/library/pathlib.html#pathlib.PurePath) с дополнительными свойствами `dist`, `size` и `hash`, как указано в метаданных. Например:107108```python109>>> util = [p for p in files('wheel') if 'util.py' in str(p)][0]  110>>> util  111PackagePath('wheel/util.py')112>>> util.size  113859114>>> util.dist  115<importlib.metadata._hooks.PathDistribution object at 0x101e0cef0>116>>> util.hash  117<FileHash mode: sha256 value: bYkw5oMccfazVCoYQwKkkemoVyMAFoR34mmKBx8R1NI>118```119120Получив файл, можно также прочитать его содержимое:121122```python123>>> print(util.read_text())  124import base64125import sys126...127def as_bytes(s):128    if isinstance(s, text_type):129        return s.encode('utf-8')130    return s131```132133Также можно использовать метод `locate`, чтобы получить абсолютный путь к файлу:134135```python136>>> util.locate()  137PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')138```139140В случае, если файл метаданных со списком файлов (RECORD или SOURCES.txt) отсутствует, `files()` вернёт `None`. Вызывающий код может обернуть вызовы `files()` в [always\_iterable](https://python-all.ru/3.9/library/importlib.metadata.html) или иным образом защититься от этой ситуации, если неизвестно, что целевой дистрибутив содержит метаданные.141142### Зависимости дистрибутивов143144Чтобы получить полный набор зависимостей для дистрибутива, используйте функцию `requires()`:145146```python147>>> requires('wheel')  148["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]149```150151## Дистрибутивы152153Хотя приведённый выше API является наиболее распространённым и удобным способом использования, всю эту информацию можно получить из класса `Distribution`. `Distribution` – это абстрактный объект, представляющий метаданные для пакета Python. Можно получить экземпляр `Distribution`:154155```python156>>> from importlib.metadata import distribution  157>>> dist = distribution('wheel')  158```159160Таким образом, альтернативный способ получить номер версии – через экземпляр `Distribution`:161162```python163>>> dist.version  164'0.32.3'165```166167На экземпляре `Distribution` доступны всевозможные дополнительные метаданные:168169```python170>>> dist.metadata['Requires-Python']  171'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'172>>> dist.metadata['License']  173'MIT'174```175176Полный набор доступных метаданных здесь не описан. Подробнее см. [**PEP 566**](https://python-all.ru/3.9/library/importlib.metadata.html) .177178## Расширение алгоритма поиска179180Поскольку метаданные пакета недоступны через поиск [`sys.path`](https://python-all.ru/3.9/library/sys.html#sys.path) или напрямую через загрузчики пакетов, метаданные пакета находятся через систему импорта [искатели](https://python-all.ru/3.9/reference/import.html#finders-and-loaders). Чтобы найти метаданные пакета дистрибутива, `importlib.metadata` запрашивает список [искателей метапути](https://python-all.ru/3.9/glossary.html#term-meta-path-finder) в [`sys.meta_path`](https://python-all.ru/3.9/library/sys.html#sys.meta_path).181182Стандартный `PathFinder` для Python включает хук, который вызывает `importlib.metadata.MetadataPathFinder` для поиска дистрибутивов, загруженных из типичных путей файловой системы.183184Абстрактный класс [`importlib.abc.MetaPathFinder`](https://python-all.ru/3.9/library/importlib.html#importlib.abc.MetaPathFinder) определяет интерфейс, ожидаемый от искателей системой импорта Python. `importlib.metadata` расширяет этот протокол, проверяя наличие опционального вызываемого объекта `find_distributions` у искателей из [`sys.meta_path`](https://python-all.ru/3.9/library/sys.html#sys.meta_path), и предоставляет этот расширенный интерфейс как абстрактный базовый класс `DistributionFinder`, который определяет следующий абстрактный метод:185186```python187@abc.abstractmethod188def find_distributions(context=DistributionFinder.Context()):189    """Возвращает итерируемый объект со всеми экземплярами Distribution, способными190    загружать метаданные для пакетов для указанного ``context``.191    """192```193194Объект `DistributionFinder.Context` предоставляет свойства `.path` и `.name`, указывающие путь для поиска и имя для сопоставления, а также может предоставлять другой релевантный контекст.195196На практике это означает, что для поддержки поиска метаданных дистрибутивного пакета в местах, отличных от файловой системы, нужно создать подкласс `Distribution` и реализовать абстрактные методы. Затем из пользовательского находильщика возвращать экземпляры этого производного `Distribution` в методе `find_distributions()`.197198Сноски199200**[1](https://python-all.ru/3.9/library/importlib.metadata.html#id2)**201202Технически, возвращаемый объект метаданных дистрибутива является [`email.message.EmailMessage`](https://python-all.ru/3.9/library/email.message.html#email.message.EmailMessage) экземпляром, но это деталь реализации и не является частью стабильного API. Следует использовать только методы и синтаксис, подобные словарю, для доступа к содержимому метаданных.203