19.5. mimetypes – Сопоставление имён файлов с MIME-типами¶mimetypes – Map filenames to MIME types

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

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

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

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

mimetypes.guess_type(url, strict=True)¶

Определяет тип файла по его имени или 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-типы.

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 предотвратит применение системных значений по умолчанию: будут присутствовать только известные значения из встроенного списка.

Изменено в версии 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'