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'