mimetypes — сопоставление имён файлов с типами MIME

Исходный код: Lib/mimetypes.py

Модуль mimetypes преобразует имя файла или URL в тип MIME, связанный с расширением имени файла, и наоборот. Доступны преобразования имени файла в тип MIME и типа MIME в расширение имени файла; при последнем преобразовании кодировки не поддерживаются.

Модуль предоставляет один класс и несколько вспомогательных функций. Функции служат обычным интерфейсом этого модуля, однако некоторые приложения могут также заинтересоваться классом.

Описанные ниже функции предоставляют основной интерфейс модуля. Если модуль не был инициализирован, они вызовут init(), если используют информацию, которую настраивает init().

mimetypes.guess_type(url, strict=True)

Определяет тип файла по его имени, пути или URL, заданному параметром url. URL может быть строкой или объектом, подобным пути.

Возвращаемое значение — кортеж (type, encoding), где type — None, если тип определить не удалось (отсутствует или неизвестно расширение), либо строка вида 'type/subtype', пригодная для заголовка MIME content-type.

encoding — None, если кодировка отсутствует, или имя программы, использованной для кодирования (например, compress или gzip). Кодировка подходит для использования в заголовке Content-Encoding, но не в заголовке Content-Transfer-Encoding. Сопоставления определяются таблицей. Расширения кодировки учитывают регистр; сначала для расширений типа выполняется поиск с учётом регистра, затем без учёта регистра.

Необязательный аргумент strict — флаг, указывающий, ограничен ли список известных типов MIME только официальными типами, зарегистрированными в IANA. Если strict равен True (значение по умолчанию), поддерживаются только типы IANA; если strict равен False, также распознаются некоторые дополнительные нестандартные, но широко используемые типы MIME.

Изменено в версии 3.8: Добавлена поддержка объектов, подобных пути, в качестве значения url.

Устарело с версии 3.13: Передача пути к файлу вместо URL считается устаревшей. Используйте для этого guess_file_type().

mimetypes.guess_file_type(path, *, strict=True)

Определяет тип файла по его пути, заданному параметром path. Аналогична функции guess_type(), но принимает путь вместо URL. Путь может быть строкой, объектом bytes или объектом, подобным пути.

Добавлено в версии 3.13.

mimetypes.guess_all_extensions(type, strict=True)

Определяет расширения файла по его типу MIME, заданному параметром type. Возвращаемое значение — список строк со всеми возможными расширениями имён файлов, включая начальную точку ('.'). Не гарантируется, что расширения связаны с каким-либо конкретным потоком данных, но функции guess_type() и guess_file_type() сопоставят их с типом MIME type.

Необязательный аргумент strict имеет то же значение, что и в функции guess_type().

mimetypes.guess_extension(type, strict=True)

Определяет расширение файла по его типу MIME, заданному параметром type. Возвращаемое значение — строка с расширением имени файла, включая начальную точку ('.'). Не гарантируется, что расширение связано с каким-либо конкретным потоком данных, но функции guess_type() и guess_file_type() сопоставят его с типом MIME type. Если расширение для type определить не удаётся, возвращается None.

Необязательный аргумент strict имеет то же значение, что и в функции guess_type().

Для управления поведением модуля доступны дополнительные функции и элементы данных.

mimetypes.init(files=None)

Инициализирует внутренние структуры данных. Если задан параметр files, он должен содержать последовательность имён файлов, которые следует использовать для дополнения карты типов по умолчанию. Если параметр не задан, имена используемых файлов берутся из knownfiles; в Windows загружаются текущие настройки реестра. Каждый файл, указанный в files или knownfiles, имеет приоритет над файлами, указанными до него. Функцию init() можно вызывать повторно.

Если передать пустой список в files, системные значения по умолчанию применяться не будут: останутся только общеизвестные значения из встроенного списка.

Если files равен None, внутренняя структура данных полностью перестраивается до исходного значения по умолчанию. Эта операция стабильна и при многократном вызове даёт одинаковые результаты.

Изменено в версии 3.2: Ранее настройки реестра Windows игнорировались.

mimetypes.read_mime_types(filename)

Загружает карту типов из файла filename, если он существует. Карта типов возвращается в виде словаря, сопоставляющего расширения имён файлов, включая начальную точку ('.'), со строками вида 'type/subtype'. Если файл filename не существует или его не удаётся прочитать, возвращается None.

mimetypes.add_type(type, ext, strict=True)

Добавляет сопоставление типа MIME type с расширением ext. Если расширение уже известно, новый тип заменит старый. Если тип уже известен, расширение будет добавлено в список известных расширений.

Если strict равен True (значение по умолчанию), сопоставление будет добавлено к официальным типам MIME, в противном случае — к нестандартным.

mimetypes.inited

Флаг, указывающий, были ли инициализированы глобальные структуры данных. Функция init() устанавливает его в True.

mimetypes.knownfiles

Список имён файлов с картами типов, которые обычно устанавливаются. Обычно эти файлы называются mime.types и устанавливаются в разные расположения разными пакетами.

mimetypes.suffix_map

Словарь, сопоставляющий суффиксы с суффиксами. Он позволяет распознавать закодированные файлы, в которых кодировка и тип обозначены одним и тем же расширением. Например, расширение .tgz сопоставляется с .tar.gz, чтобы кодировку и тип можно было распознать отдельно.

mimetypes.encodings_map

Словарь, сопоставляющий расширения имён файлов с типами кодировки.

mimetypes.types_map

Словарь, сопоставляющий расширения имён файлов с типами MIME.

mimetypes.common_types

Словарь, сопоставляющий расширения имён файлов с нестандартными, но широко распространёнными типами MIME.

Пример использования модуля:

>>> import mimetypes
>>> mimetypes.init()
>>> mimetypes.knownfiles
['/etc/mime.types', '/etc/httpd/mime.types', ... ]
>>> mimetypes.suffix_map['.tgz']
'.tar.gz'
>>> mimetypes.encodings_map['.gz']
'gzip'
>>> mimetypes.types_map['.tgz']
'application/x-tar-gz'