Тип аннотаций: pathlib.Path vs importlib.resources.abc.Traversable
При загрузке файловых ресурсов, входящих в мой дистрибутив, я использую importlib.resources.files. При загрузке файлов с диска я использую pathlib.Path.
Иногда я хочу написать функцию, которая будет принимать либо:
from importlib.resources.abc import Traversable
from pathlib import Path
def process_file(file_to_process: Traversable | Path) -> None: ...
Комментировать все функции обработки файлов с помощью Traversable | Path кажется громоздким. Я мог бы определить и использовать свой собственный тип объединения, но мне кажется, что в Python уже есть встроенная функция, которой мне не хватает. Мне требуется только базовое подмножество обоих типов: открытие/закрытие/чтение/запись и т. д., и ничего вроде разрешений на прикосновение или использования деталей, специфичных для ОС.
Каков правильный тип файлового ресурса, который можно загрузить из дистрибутива через importlib или с диска через pathlib?
В настоящее время я использую Python 3.11, но со временем обновлюсь, поэтому приветствуются все ответы 3.11+.
К счастью, это очень просто: я просто использую базовый файл io — в этом случае я часто просто читаю все содержимое небольших текстовых файлов. Раньше я использовал typing.cast(pathlib.Path, ...) для результата importlib.resources.files, чтобы успокоить пирайта, но это казалось неправильным, потому что базовый тип поддержки pathlib.Path не является частью importlib API. А если изменится и т.д.
Чтобы преобразовать Traversable в Path, можно использовать importlib.resources.as_file(traversable), см. docs.python.org/3/library/…
Ответы 1
Я считаю, что вы можете просто использовать Traversable во всех случаях. Похоже, Traversable — это протокол, а поскольку pathlib.Path реализует необходимые методы, объекты типа pathlib.Path тоже должны быть Traversable. А на самом деле:
>>> from pathlib import Path
>>> from importlib.resources.abc import Traversable
>>> p = Path('.')
>>> isinstance(p, Path)
True
>>> isinstance(p, Traversable)
True
Итак, вы должны иметь возможность написать:
def process_file(file_to_process: Traversable) -> None: ...
Я проверил, и mypy кажется доволен приведенной выше аннотацией при звонке process_file(Path('example.txt')).
Спасибо! Из-за импорта importlib.resources Traversable выглядит странно на мой взгляд в местах, где я выполняю только работу с файловой системой - я бы, вероятно, использовал pathlib.Path для этих типов, но имеет смысл использовать Traversable для любых частей кода, с которыми можно работать. оба.
Какие ресурсы вы пытаетесь поддержать? Вы хотите поддерживать произвольные ресурсы или просто «обычные файлы»? Если вы просто используете «обычные файлы», обратите внимание, что
Traversable, которыйimportlib.resources.filesвозвращает, будет добросовестнымPathэкземпляром.