mailcap — Обработка файлов mailcap

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

Файлы mailcap используются для настройки поведения MIME-сознательных приложений, таких как почтовые клиенты и веб-браузеры, при работе с файлами различных MIME-типов. (Название «mailcap» происходит от фразы «mail capability».) Например, файл mailcap может содержать строку типа video/mpeg; xmpeg %s. Затем, если пользователь столкнётся с электронным письмом или веб-документом с MIME-типом video/mpeg, %s будет заменён именем файла (обычно принадлежащим временному файлу), и программа xmpeg может быть автоматически запущена для просмотра файла.

Формат mailcap документирован в RFC 1524, «A User Agent Configuration Mechanism For Multimedia Mail Format Information», но не является интернет-стандартом. Однако файлы mailcap поддерживаются на большинстве Unix-систем.

mailcap.findmatch(caps, MIMEtype, key='view', filename='/dev/null', plist=[])

Возвращает кортеж из 2 элементов; первый элемент — строка, содержащая командную строку для выполнения (которая может быть передана в os.system()), а второй элемент — запись mailcap для данного MIME-типа. Если подходящий MIME-тип не найден, возвращается (None, None).

key — имя требуемого поля, которое представляет собой тип выполняемого действия; по умолчанию значение равно ‘view’, так как в большинстве случаев требуется просто просмотреть тело данных MIME-типа. Другие возможные значения могут быть ‘compose’ и ‘edit’, если требуется создать новый документ заданного MIME-типа или изменить существующие данные.

filename — имя файла, которое будет использовано для замены %s в командной строке; по умолчанию значение равно '/dev/null', что, скорее всего, не нужно, поэтому обычно вы переопределите его, указав имя файла.

plist может быть списком, содержащим именованные параметры; по умолчанию это просто пустой список. Каждый элемент списка должен быть строкой, содержащей имя параметра, знак равенства ('=') и значение параметра. Записи mailcap могут содержать именованные параметры, например, %{foo}, которые будут заменены значением параметра с именем ‘foo’. Например, если в файле mailcap была командная строка showpartial %{id} %{number} %{total}, а plist был установлен в значение ['id=1', 'number=2', 'total=3'], результирующая командная строка будет 'showpartial 1 2 3'.

В файле mailcap поле «test» может быть необязательно указано для проверки какого-либо внешнего условия (например, архитектуры машины или используемой оконной системы) для определения того, применяется ли строка mailcap. findmatch() автоматически проверит такие условия и пропустит запись, если проверка завершится неудачно.

mailcap.getcaps()

Возвращает словарь, сопоставляющий MIME-типы со списком записей файла mailcap. Этот словарь должен быть передан в функцию findmatch(). Запись хранится в виде списка словарей, но подробности этой структуры знать необязательно.

Информация извлекается из всех файлов mailcap, найденных в системе. Настройки в файле mailcap пользователя $HOME/.mailcap будут переопределять настройки в системных файлах mailcap /etc/mailcap, /usr/etc/mailcap, и /usr/local/etc/mailcap.

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

>>> import mailcap
>>> d = mailcap.getcaps()
>>> mailcap.findmatch(d, 'video/mpeg', filename='tmp1223')
('xmpeg tmp1223', {'view': 'xmpeg %s'})