Документация Python неофициальный перевод

email.charset.md

212 строк · 13.1 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.1/library/email.charset.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 18.1.6. [`email`](https://python-all.ru/3.1/library/email.html#module-email): Представление наборов символов89Этот модуль предоставляет класс [`Charset`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset) для представления кодировок и преобразования кодировок в email-сообщениях, а также реестр кодировок и несколько удобных методов для работы с этим реестром. Экземпляры [`Charset`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset) используются в нескольких других модулях пакета [`email`](https://python-all.ru/3.1/library/email.html#module-email).1011Импортируйте этот класс из модуля `email.charset`.1213#### `class email.charset.Charset(input_charset=DEFAULT_CHARSET)`1415Сопоставляет наборы символов с их почтовыми свойствами.1617Этот класс предоставляет информацию о требованиях, предъявляемых к электронной почте для конкретного набора символов. Он также предоставляет удобные процедуры для преобразования между наборами символов при наличии соответствующих кодеков. Для заданного набора символов он делает всё возможное, чтобы предоставить информацию о том, как использовать этот набор символов в сообщении электронной почты в соответствии с RFC.1819Некоторые наборы символов должны быть закодированы с помощью quoted-printable или base64 при использовании в заголовках или телах писем. Некоторые наборы символов должны быть преобразованы полностью и не допускаются в электронной почте.2021Необязательный параметр *input\_charset* описан ниже; он всегда приводится к нижнему регистру. После нормализации псевдонимов он также используется для поиска в реестре кодировок, чтобы определить кодировку заголовка, кодировку тела и кодек выходного преобразования, которые будут использоваться для данной кодировки. Например, если *input\_charset* равен `iso-8859-1`, то заголовки и тела будут кодироваться с помощью quoted-printable, и никакой кодек выходного преобразования не требуется. Если *input\_charset* равен `euc-jp`, то заголовки будут кодироваться с помощью base64, тела не будут кодироваться, но выходной текст будет преобразован из кодировки `euc-jp` в кодировку `iso-2022-jp`.2223Экземпляры [`Charset`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset) имеют следующие атрибуты данных:2425#### `input_charset`2627Указанная исходная кодировка. Распространённые псевдонимы преобразуются в их2829*официальные*3031email-имена (например,3233`latin_1`3435преобразуется в3637`iso-8859-1`3839). По умолчанию – 7-битная4041`us-ascii`4243.4445#### `header_encoding`4647Если кодировку необходимо закодировать перед использованием в заголовке email, этот атрибут будет установлен в4849`Charset.QP`5051(для quoted-printable),5253`Charset.BASE64`5455(для кодирования base64) или5657`Charset.SHORTEST`5859для наикратчайшего из QP или BASE64. В противном случае он будет равен6061`None`6263.6465#### `body_encoding`6667Аналогично6869*header\_encoding*7071, но описывает кодировку для тела почтового сообщения, которая может отличаться от кодировки заголовка.7273`Charset.SHORTEST`7475не допускается для7677*body\_encoding*7879.8081#### `output_charset`8283Некоторые кодировки необходимо преобразовать перед использованием в заголовках или телах email. Если8485*input\_charset*8687является одной из них, этот атрибут будет содержать имя кодировки, в которую будет преобразован вывод. В противном случае он будет равен8889`None`9091.9293#### `input_codec`9495Имя кодека Python, используемого для преобразования9697*input\_charset*9899в Unicode. Если кодек преобразования не требуется, этот атрибут будет равен100101`None`102103.104105#### `output_codec`106107Имя кодека Python, используемого для преобразования Unicode в108109*output\_charset*110111. Если кодек преобразования не требуется, этот атрибут будет иметь то же значение, что и112113*input\_codec*114115.116117Экземпляры [`Charset`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset) также имеют следующие методы:118119#### `get_body_encoding()`120121Возвращает кодировку передачи содержимого, используемую для кодирования тела.122123Это может быть строка `quoted-printable` или `base64` в зависимости от используемой кодировки, или же функция, в этом случае следует вызвать эту функцию с одним аргументом – объектом Message, который кодируется. Затем функция должна самостоятельно установить заголовок *Content-Transfer-Encoding* в соответствующее значение.124125Возвращает строку `quoted-printable`, если *body\_encoding* равен `QP`, возвращает строку `base64`, если *body\_encoding* равен `BASE64`, и возвращает строку `7bit` в противном случае.126127#### `get_output_charset()`128129Возвращает выходную кодировку.130131Это атрибут *output\_charset*, если он не равен `None`; в противном случае это *input\_charset*.132133#### `header_encode(string)`134135Кодирует строку *string* для заголовка.136137Тип кодирования (base64 или quoted-printable) будет определяться атрибутом *header\_encoding*.138139#### `header_encode_lines(string, maxlengths)`140141Кодирует строку *string* для заголовка, предварительно преобразуя её в байты.142143Это аналогично [`header_encode()`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset.header_encode), за исключением того, что строка подгоняется под максимальную длину строк, задаваемую аргументом *maxlengths*, который должен быть итератором: каждый элемент, возвращаемый этим итератором, будет предоставлять следующую максимальную длину строки.144145#### `body_encode(string)`146147Кодирует строку *string* для тела сообщения.148149Тип кодирования (base64 или quoted-printable) будет определяться атрибутом *body\_encoding*.150151Класс [`Charset`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset) также предоставляет ряд методов для поддержки стандартных операций и встроенных функций.152153#### `__str__()`154155Возвращает156157*input\_charset*158159в виде строки, приведённой к нижнему регистру.160161[`__repr__()`](https://python-all.ru/3.1/reference/datamodel.html#object.__repr__)162163является псевдонимом для164165[`__str__()`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset.__str__)166167.168169#### `__eq__(other)`170171Этот метод позволяет сравнивать два экземпляра172173[`Charset`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset)174175на равенство.176177#### `__ne__(other)`178179Этот метод позволяет сравнивать два экземпляра180181[`Charset`](https://python-all.ru/3.1/library/email.charset.html#email.charset.Charset)182183на неравенство.184185Модуль `email.charset` также предоставляет следующие функции для добавления новых записей в глобальные реестры наборов символов, псевдонимов и кодеков:186187#### `email.charset.add_charset(charset, header_enc=None, body_enc=None, output_charset=None)`188189Добавляет свойства кодировки в глобальный реестр.190191*charset* – это входная кодировка, и она должна быть каноническим именем набора символов.192193Необязательные параметры *header\_enc* и *body\_enc* могут быть `Charset.QP` для quoted-printable, `Charset.BASE64` для кодировки base64, `Charset.SHORTEST` для кратчайшей из quoted-printable или base64, или `None` без кодировки. `SHORTEST` допустим только для *header\_enc*. По умолчанию `None` без кодировки.194195Необязательный *output\_charset* – это набор символов, в котором должен быть вывод. Преобразования будут выполняться от входного набора символов к Unicode, затем к выходному набору, когда вызывается метод `Charset.convert()`. По умолчанию вывод осуществляется в том же наборе символов, что и входной.196197И *input\_charset*, и *output\_charset* должны иметь записи кодеков Unicode в отображении наборов символов на кодеки модуля; используйте [`add_codec()`](https://python-all.ru/3.1/library/email.charset.html#email.charset.add_codec) для добавления кодеков, о которых модуль не знает. Подробнее см. документацию модуля [`codecs`](https://python-all.ru/3.1/library/codecs.html#module-codecs).198199Глобальный реестр наборов символов хранится в глобальном словаре модуля `CHARSETS`.200201#### `email.charset.add_alias(alias, canonical)`202203Добавляет псевдоним набора символов. *alias* – это имя псевдонима, например `latin-1`. *canonical* – это каноническое имя набора символов, например `iso-8859-1`.204205Глобальный реестр псевдонимов наборов символов хранится в глобальном словаре модуля `ALIASES`.206207#### `email.charset.add_codec(charset, codecname)`208209Добавляет кодек, который преобразует символы из заданной кодировки в Unicode и обратно.210211*charset* – это каноническое имя набора символов. *codecname* – это имя кодека Python, которое используется в качестве второго аргумента метода [`str`](https://python-all.ru/3.1/library/functions.html#str) `decode()`.212