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 в качестве объекта, подобного пути.

mimetypes.guess_all_extensions(type, strict=True)

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

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

mimetypes.guess_extension(type, strict=True)

Определяет расширение файла по типу MIME, заданному параметром type. Возвращаемое значение — строка, содержащая расширение имени файла, включая ведущую точку ('.'). Расширение не гарантированно ассоциировано с каким-либо конкретным потоком данных, но было бы сопоставлено с типом MIME type функцией guess_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

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

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'