importlib.resources – Чтение, открытие и доступ к ресурсам пакетов

Функции, помеченные как устаревшие

Более старое, устаревшее множество функций по-прежнему доступно, но планируется его удаление в будущей версии Python. Основным недостатком этих функций является то, что они не поддерживают каталоги: они предполагают, что все ресурсы расположены непосредственно внутри пакета.

importlib.resources.Package

Всякий раз, когда функция принимает аргумент Package, вы можете передать либо объект module object, либо имя модуля в виде строки. Вы можете передавать только объекты модулей, чья __spec__.submodule_search_locations не является None.

Тип Package определён как Union[str, ModuleType].

Устарело начиная с версии 3.12.

importlib.resources.Resource

Для аргументов ресурса функций ниже вы можете передать имя ресурса в виде строки или объект path-like object.

Тип Resource определён как Union[str, os.PathLike].

importlib.resources.open_binary(package, resource)

Открывает ресурс внутри пакета для двоичного чтения.

Пакет — это либо имя, либо объект модуля, который соответствует требованиям Package. Ресурс — это имя ресурса, который нужно открыть внутри пакета; он не должен содержать разделители путей и не должен иметь подресурсы (т. е. не может быть каталогом). Эта функция возвращает экземпляр typing.BinaryIO — двоичный поток ввода-вывода, открытый для чтения.

Устарело начиная с версии 3.11: Вызовы этой функции можно заменить на:

files(package).joinpath(resource).open('rb')

importlib.resources.open_text(package, resource, encoding='utf-8', errors='strict')

Открывает ресурс внутри пакета для текстового чтения. По умолчанию ресурс открывается для чтения в кодировке UTF-8.

Пакет — это либо имя, либо объект модуля, который соответствует требованиям Package. Ресурс — это имя ресурса, который нужно открыть внутри пакета; он не должен содержать разделители путей и не должен иметь подресурсы (т. е. не может быть каталогом). encoding и errors имеют то же значение, что и для встроенной функции open().

Эта функция возвращает экземпляр typing.TextIO — текстовый поток ввода-вывода, открытый для чтения.

Устарело начиная с версии 3.11: Вызовы этой функции можно заменить на:

files(package).joinpath(resource).open('r', encoding=encoding)

importlib.resources.read_binary(package, resource)

Считывает и возвращает содержимое ресурса внутри пакета как bytes.

Пакет — это либо имя, либо объект модуля, который соответствует требованиям Package. Ресурс — это имя ресурса, который нужно открыть внутри пакета; он не должен содержать разделители путей и не должен иметь подресурсы (т. е. не может быть каталогом). Эта функция возвращает содержимое ресурса как bytes.

Устарело начиная с версии 3.11: Вызовы этой функции можно заменить на:

files(package).joinpath(resource).read_bytes()

importlib.resources.read_text(package, resource, encoding='utf-8', errors='strict')

Считывает и возвращает содержимое ресурса внутри пакета как str. По умолчанию содержимое считывается как строго UTF-8.

Пакет — это либо имя, либо объект модуля, который соответствует требованиям Package. Ресурс — это имя ресурса, который нужно открыть внутри пакета; он не должен содержать разделители путей и не должен иметь подресурсы (т. е. не может быть каталогом). encoding и errors имеют то же значение, что и для встроенной функции open(). Эта функция возвращает содержимое ресурса как str.

Устарело начиная с версии 3.11: Вызовы этой функции можно заменить на:

files(package).joinpath(resource).read_text(encoding=encoding)

importlib.resources.path(package, resource)

Возвращает путь к ресурсу как фактический путь в файловой системе. Эта функция возвращает менеджер контекста для использования в операторе with. Менеджер контекста предоставляет объект pathlib.Path.

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

Пакет — это либо имя, либо объект модуля, который соответствует требованиям Package. Ресурс — это имя ресурса, который нужно открыть внутри пакета; он не должен содержать разделители путей и не должен иметь подресурсы (т. е. не может быть каталогом).

Устарело начиная с версии 3.11: Вызовы этой функции можно заменить на as_file():

as_file(files(package).joinpath(resource))

importlib.resources.is_resource(package, name)

Возвращает True, если в пакете есть ресурс с именем name, в противном случае False. Эта функция не рассматривает каталоги как ресурсы. Пакет — это либо имя, либо объект модуля, который соответствует требованиям Package.

Устарело начиная с версии 3.11: Вызовы этой функции можно заменить на:

files(package).joinpath(resource).is_file()

importlib.resources.contents(package)

Возвращает итерируемый объект по именованным элементам внутри пакета. Итерируемый объект возвращает str ресурсы (например, файлы) и нересурсы (например, каталоги). Итерируемый объект не рекурсивно входит в подкаталоги.

Пакет — это либо имя, либо объект модуля, который соответствует требованиям Package.

Устарело начиная с версии 3.11: Вызовы этой функции можно заменить на:

(resource.name for resource in files(package).iterdir() if resource.is_file())