`email.util.md`

121 строк · 16.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/library/email.util.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 19.1.12. [`email.utils`](https://python-all.ru/3.5/library/email.util.html#module-email.utils): Разные утилиты89**Исходный код:** [Lib/email/utils.py](https://python-all.ru/src/3.5/Lib/email/utils.py)1011---1213В модуле [`email.utils`](https://python-all.ru/3.5/library/email.util.html#module-email.utils) предоставляется несколько полезных утилит:1415#### `email.utils.quote(str)`1617Возвращает новую строку, в которой обратная косая черта в *str* заменена двумя обратными косыми чертами, а двойные кавычки – на обратную косую черту с двойной кавычкой.1819#### `email.utils.unquote(str)`2021Возвращает новую строку, которая является *расквотированной* версией *str*. Если *str* начинается и заканчивается двойными кавычками, они удаляются. Аналогично, если *str* начинается и заканчивается угловыми скобками, они удаляются.2223#### `email.utils.parseaddr(address)`2425Разбирает адрес – который должен быть значением какого-либо поля, содержащего адрес, такого как *To* или *Cc* – на составляющие части: *realname* и *адрес электронной почты*. Возвращает кортеж с этой информацией, если только разбор не завершится ошибкой; в этом случае возвращается кортеж из двух элементов `('', '')`.2627#### `email.utils.formataddr(pair, charset='utf-8')`2829Обратная функция к [`parseaddr()`](https://python-all.ru/3.5/library/email.util.html#email.utils.parseaddr), она принимает кортеж из двух элементов вида `(realname, email_address)` и возвращает строковое значение, подходящее для заголовка *To* или *Cc*. Если первый элемент *pair* равен false, то второй элемент возвращается без изменений.3031Необязательный *charset* – это набор символов, который будет использоваться в [**RFC 2047**](https://python-all.ru/3.5/library/email.util.html) кодировке `realname`, если `realname` содержит не-ASCII символы. Может быть экземпляром [`str`](https://python-all.ru/3.5/library/stdtypes.html#str) или [`Charset`](https://python-all.ru/3.5/library/email.charset.html#email.charset.Charset). По умолчанию равен `utf-8`.3233Изменено в версии 3.3: Добавлена опция *charset*.3435#### `email.utils.getaddresses(fieldvalues)`3637Этот метод возвращает список кортежей из двух элементов в том же формате, что и `parseaddr()`. *fieldvalues* – это последовательность значений полей заголовка, как она может быть возвращена функцией [`Message.get_all`](https://python-all.ru/3.5/library/email.message.html#email.message.Message.get_all). Ниже приведён простой пример, который получает всех получателей сообщения:3839```python40from email.utils import getaddresses4142tos = msg.get_all('to', [])43ccs = msg.get_all('cc', [])44resent_tos = msg.get_all('resent-to', [])45resent_ccs = msg.get_all('resent-cc', [])46all_recipients = getaddresses(tos + ccs + resent_tos + resent_ccs)47```4849#### `email.utils.parsedate(date)`5051Пытается разобрать дату в соответствии с правилами [**RFC 2822**](https://python-all.ru/3.5/library/email.util.html). Однако некоторые почтовые программы не следуют этому формату, поэтому [`parsedate()`](https://python-all.ru/3.5/library/email.util.html#email.utils.parsedate) пытается правильно угадать дату в таких случаях. *date* – это строка, содержащая дату в формате [**RFC 2822**](https://python-all.ru/3.5/library/email.util.html), например, `"Mon, 20 Nov 1995 19:12:08 -0500"`. Если разбор даты успешен, [`parsedate()`](https://python-all.ru/3.5/library/email.util.html#email.utils.parsedate) возвращает кортеж из 9 элементов, который можно напрямую передать в [`time.mktime()`](https://python-all.ru/3.5/library/time.html#time.mktime); в противном случае возвращается `None`. Обратите внимание, что индексы 6, 7 и 8 кортежа результата не пригодны для использования.5253#### `email.utils.parsedate_tz(date)`5455Выполняет ту же функцию, что и [`parsedate()`](https://python-all.ru/3.5/library/email.util.html#email.utils.parsedate), но возвращает либо `None`, либо кортеж из 10 элементов; первые 9 элементов составляют кортеж, который можно напрямую передать в [`time.mktime()`](https://python-all.ru/3.5/library/time.html#time.mktime), а десятый – это смещение часового пояса даты относительно UTC (официальное название среднего времени по Гринвичу) [\[1\]](https://python-all.ru/3.5/library/email.util.html#id2). Если входная строка не содержит часового пояса, последним элементом возвращаемого кортежа будет `None`. Обратите внимание, что индексы 6, 7 и 8 кортежа результата непригодны для использования.5657#### `email.utils.parsedate_to_datetime(date)`5859Обратная операция к [`format_datetime()`](https://python-all.ru/3.5/library/email.util.html#email.utils.format_datetime). Выполняет ту же функцию, что и [`parsedate()`](https://python-all.ru/3.5/library/email.util.html#email.utils.parsedate), но в случае успеха возвращает [`datetime`](https://python-all.ru/3.5/library/datetime.html#datetime.datetime). Если входная дата имеет часовой пояс `-0000`, то `datetime` будет наивным `datetime`, и если дата соответствует RFC, она будет представлять время в UTC, но без указания исходного часового пояса сообщения, из которого получена дата. Если входная дата имеет любое другое допустимое смещение часового пояса, то `datetime` будет осведомлённым `datetime` с соответствующим [`timezone`](https://python-all.ru/3.5/library/datetime.html#datetime.timezone) [`tzinfo`](https://python-all.ru/3.5/library/datetime.html#datetime.tzinfo).6061Новое в версии 3.3.6263#### `email.utils.mktime_tz(tuple)`6465Преобразует 10-элементный кортеж, возвращаемый функцией [`parsedate_tz()`](https://python-all.ru/3.5/library/email.util.html#email.utils.parsedate_tz), в метку времени UTC (секунды с начала эпохи). Если элемент часового пояса в кортеже равен `None`, предполагается местное время.6667#### `email.utils.formatdate(timeval=None, localtime=False, usegmt=False)`6869Возвращает строку даты в соответствии с [**RFC 2822**](https://python-all.ru/3.5/library/email.util.html), например:7071```python72Fri, 09 Nov 2001 01:08:47 -000073```7475Необязательный *timeval*, если задан, представляет собой вещественное значение времени, принимаемое [`time.gmtime()`](https://python-all.ru/3.5/library/time.html#time.gmtime) и [`time.localtime()`](https://python-all.ru/3.5/library/time.html#time.localtime); в противном случае используется текущее время.7677Необязательный флаг *localtime*: если `True`, интерпретирует *timeval* и возвращает дату относительно местного часового пояса вместо UTC, с учётом перехода на летнее время. По умолчанию `False`, то есть используется UTC.7879Необязательный флаг *usegmt*: если `True`, выводит строку даты с часовым поясом в виде ASCII-строки `GMT`, а не числового `-0000`. Это необходимо для некоторых протоколов (например, HTTP). Применяется только когда *localtime* равен `False`. По умолчанию `False`.8081#### `email.utils.format_datetime(dt, usegmt=False)`8283Как и `formatdate`, но ввод – это экземпляр [`datetime`](https://python-all.ru/3.5/library/datetime.html#module-datetime). Если это наивный datetime, считается, что это «UTC без информации об исходном часовом поясе», и для часового пояса используется стандартное `-0000`. Если это осознанный `datetime`, используется числовое смещение часового пояса. Если это осознанный часовой пояс с нулевым смещением, то *usegmt* может быть установлен в `True`, и в этом случае вместо числового смещения часового пояса используется строка `GMT`. Это даёт способ генерировать соответствующие стандартам HTTP-заголовки даты.8485Новое в версии 3.3.8687#### `email.utils.localtime(dt=None)`8889Возвращает местное время как осведомлённый объект datetime. При вызове без аргументов возвращает текущее время. В противном случае аргумент *dt* должен быть экземпляром [`datetime`](https://python-all.ru/3.5/library/datetime.html#datetime.datetime), и он преобразуется в местный часовой пояс согласно системной базе данных часовых поясов. Если *dt* наивный (то есть `dt.tzinfo` равно `None`), считается, что он задан в местном времени. В этом случае положительное или нулевое значение *isdst* заставляет `localtime` изначально предполагать, что летнее время (например, Daylight Saving Time) действует или не действует (соответственно) для указанного времени. Отрицательное значение *isdst* заставляет `localtime` пытаться определить, действует ли летнее время для указанного времени.9091Новое в версии 3.3.9293#### `email.utils.make_msgid(idstring=None, domain=None)`9495Возвращает строку, подходящую для [**RFC 2822**](https://python-all.ru/3.5/library/email.util.html)-совместимого *Message-ID* заголовка. Необязательный *idstring*, если задан, представляет собой строку, используемую для усиления уникальности идентификатора сообщения. Необязательный *domain*, если задан, указывает часть msgid после символа '@'. По умолчанию используется локальное имя хоста. Обычно нет необходимости переопределять это значение, но это может быть полезно в определенных случаях, например, при создании распределенной системы, которая использует единое доменное имя на нескольких хостах.9697Изменено в версии 3.2: Добавлен параметр *domain*.9899#### `email.utils.decode_rfc2231(s)`100101Декодирует строку *s* в соответствии с [**RFC 2231**](https://python-all.ru/3.5/library/email.util.html).102103#### `email.utils.encode_rfc2231(s, charset=None, language=None)`104105Кодирует строку *s* в соответствии с [**RFC 2231**](https://python-all.ru/3.5/library/email.util.html). Необязательные параметры *charset* и *language*, если заданы, указывают имя кодировки и язык. Если ни один не задан, *s* возвращается как есть. Если *charset* задан, а *language* нет, строка кодируется с пустой строкой для *language*.106107#### `email.utils.collapse_rfc2231_value(value, errors='replace', fallback_charset='us-ascii')`108109Когда параметр заголовка закодирован в формате [**RFC 2231**](https://python-all.ru/3.5/library/email.util.html), [`Message.get_param`](https://python-all.ru/3.5/library/email.message.html#email.message.Message.get_param) может вернуть 3-элементный кортеж, содержащий кодировку, язык и значение. [`collapse_rfc2231_value()`](https://python-all.ru/3.5/library/email.util.html#email.utils.collapse_rfc2231_value) преобразует это в строку Unicode. Необязательный параметр *errors* передаётся в аргумент *errors* метода [`str`](https://python-all.ru/3.5/library/stdtypes.html#str) [`encode()`](https://python-all.ru/3.5/library/stdtypes.html#str.encode); по умолчанию `'replace'`. Необязательный *fallback\_charset* указывает кодировку, используемую, если кодировка из [**RFC 2231**](https://python-all.ru/3.5/library/email.util.html) неизвестна Python; по умолчанию `'us-ascii'`.110111Для удобства, если *value*, переданное в [`collapse_rfc2231_value()`](https://python-all.ru/3.5/library/email.util.html#email.utils.collapse_rfc2231_value), не является кортежем, оно должно быть строкой и возвращается без кавычек.112113#### `email.utils.decode_params(params)`114115Декодирует список параметров в соответствии с [**RFC 2231**](https://python-all.ru/3.5/library/email.util.html). *params* – это последовательность 2-элементных кортежей, содержащих элементы вида `(content-type, string-value)`.116117Сноски118119| [\[1\]](https://python-all.ru/3.5/library/email.util.html#id1) | Обратите внимание, что знак смещения часового пояса противоположен знаку переменной `time.timezone` для того же часового пояса; последняя переменная следует стандарту POSIX, тогда как этот модуль следует [**RFC 2822**](https://python-all.ru/3.5/library/email.util.html). |120| --- | --- |121