`email.parser.md`

133 строк · 23.1 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.2/library/email.parser.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 18.1.2. [`email.parser`](https://python-all.ru/3.2/library/email.parser.html#module-email.parser): Разбор сообщений электронной почты89Структуры объектов сообщений можно создать одним из двух способов: либо создать с нуля, создав экземпляры объектов [`Message`](https://python-all.ru/3.2/library/email.message.html#email.message.Message) и соединив их с помощью вызовов `attach()` и `set_payload()`, либо разобрать плоское текстовое представление сообщения.1011Пакет [`email`](https://python-all.ru/3.2/library/email.html#module-email) предоставляет стандартный парсер, который понимает большинство структур документов электронной почты, включая MIME-документы. Можно передать парсеру строку или файловый объект, и он вернет корневой экземпляр [`Message`](https://python-all.ru/3.2/library/email.message.html#email.message.Message) структуры объекта. Для простых сообщений, не являющихся MIME, полезная нагрузка этого корневого объекта, скорее всего, будет строкой, содержащей текст сообщения. Для MIME-сообщений корневой объект вернет `True` из своего метода `is_multipart()`, а подчасти можно получить с помощью методов `get_payload()` и `walk()`.1213На самом деле доступны два интерфейса парсера: классический API [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser) и инкрементальный API [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser). Классический API [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser) подходит, если весь текст сообщения находится в памяти в виде строки или если всё сообщение хранится в файле в файловой системе. [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser) больше подходит для ситуаций, когда сообщение читается из потока, который может блокироваться в ожидании дополнительных данных (например, чтение сообщения электронной почты из сокета). [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser) может потреблять и анализировать сообщение инкрементально, возвращая корневой объект только после закрытия парсера [\[1\]](https://python-all.ru/3.2/library/email.parser.html#id2).1415Обратите внимание, что парсер можно расширять ограниченными способами, и, конечно, можно реализовать собственный парсер полностью с нуля. Нет никакой магической связи между встроенным парсером пакета [`email`](https://python-all.ru/3.2/library/email.html#module-email) и классом [`Message`](https://python-all.ru/3.2/library/email.message.html#email.message.Message), поэтому ваш собственный парсер может создавать деревья объектов сообщений любым способом, который сочтёт необходимым.1617## 18.1.2.1. API FeedParser1819[`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser), импортируемый из модуля `email.feedparser`, предоставляет API, подходящий для инкрементального разбора сообщений электронной почты, например, когда текст сообщения читается из источника, который может блокироваться (например, сокет). [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser), конечно, можно использовать для разбора сообщения, полностью содержащегося в строке или файле, но для таких случаев может быть удобнее классический API [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser). Семантика и результаты работы двух парсеров API идентичны.2021API [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser) прост: создаёте экземпляр, подаёте ему текст, пока есть что подавать, затем закрываете парсер, чтобы получить корневой объект сообщения. [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser) чрезвычайно точен при разборе сообщений, соответствующих стандартам, и очень хорошо справляется с сообщениями, не соответствующими стандартам, предоставляя информацию о том, как сообщение было признано некорректным. Он заполняет атрибут *defects* объекта сообщения списком всех проблем, найденных в сообщении. Список дефектов, которые можно найти, приведён в модуле [`email.errors`](https://python-all.ru/3.2/library/email.errors.html#module-email.errors).2223Вот API для [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser):2425#### `class email.parser.FeedParser(_factory=email.message.Message)`2627Создаёт экземпляр [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser). Необязательный параметр *\_factory* – это вызываемый объект без аргументов, который будет вызываться всякий раз, когда потребуется новый объект сообщения. По умолчанию используется класс [`email.message.Message`](https://python-all.ru/3.2/library/email.message.html#email.message.Message).2829#### `feed(data)`3031Передаёт парсеру [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser) дополнительные данные. *data* должна быть строкой, содержащей одну или несколько строк. Строки могут быть неполными, и [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser) правильно склеит такие неполные строки. Строки в строке могут иметь любой из трёх распространённых концевых символов: возврат каретки, перевод строки или возврат каретки с переводом строки (они могут даже быть смешаны).3233#### `close()`3435Закрытие [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser) завершает разбор всех ранее переданных данных и возвращает корневой объект сообщения. Поведение при попытке передать дополнительные данные закрытому [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser) не определено.3637#### `class email.parser.BytesFeedParser(_factory=email.message.Message)`3839Работает точно так же, как [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser), за исключением того, что входные данные для метода [`feed()`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser.feed) должны быть байтами, а не строкой.4041Новое в версии 3.2.4243## 18.1.2.2. API класса Parser4445Класс [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser), импортируемый из модуля [`email.parser`](https://python-all.ru/3.2/library/email.parser.html#module-email.parser), предоставляет API, который можно использовать для разбора сообщения, когда все содержимое сообщения доступно в виде строки или файла. Модуль [`email.parser`](https://python-all.ru/3.2/library/email.parser.html#module-email.parser) также предоставляет второй класс, называемый `HeaderParser`, который можно использовать, если интересуют только заголовки сообщения. `HeaderParser` в таких ситуациях может работать значительно быстрее, поскольку он не пытается разбирать тело сообщения, а вместо этого устанавливает в качестве полезной нагрузки необработанное тело в виде строки. `HeaderParser` имеет тот же API, что и класс [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser).4647#### `class email.parser.Parser(_class=email.message.Message, strict=None)`4849Конструктор класса [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser) принимает необязательный аргумент *\_class*. Это должна быть вызываемая фабрика (например, функция или класс), которая используется всякий раз, когда необходимо создать объект вложенного сообщения. По умолчанию используется [`Message`](https://python-all.ru/3.2/library/email.message.html#email.message.Message) (см. [`email.message`](https://python-all.ru/3.2/library/email.message.html#module-email.message)). Фабрика будет вызываться без аргументов.5051Необязательный флаг *strict* игнорируется.5253Устарело с версии 2.4: Поскольку класс [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser) является обратно совместимой оберткой API вокруг появившегося в Python 2.4 [`FeedParser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.FeedParser), *весь* разбор фактически является нестрогим. Следует просто перестать передавать флаг *strict* конструктору [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser).5455Другие публичные методы [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser):5657#### `parse(fp, headersonly=False)`5859Читает все данные из файлоподобного объекта *fp*, разбирает полученный текст и возвращает корневой объект сообщения. *fp* должен поддерживать как метод [`readline()`](https://python-all.ru/3.2/library/readline.html#module-readline), так и метод `read()` для файлоподобных объектов.6061Текст, содержащийся в *fp*, должен быть отформатирован как блок заголовков в стиле [**RFC 2822**](https://python-all.ru/3.2/library/email.parser.html) и строк продолжения заголовков, возможно, с предшествующим заголовком конверта. Блок заголовков завершается либо концом данных, либо пустой строкой. За блоком заголовков следует тело сообщения (которое может содержать MIME-кодированные подчасти).6263Необязательный параметр *headersonly* – это флаг, указывающий, нужно ли остановить разбор после чтения заголовков. Значение по умолчанию – `False`, то есть разбирается всё содержимое файла.6465#### `parsestr(text, headersonly=False)`6667Аналогичен методу [`parse()`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser.parse), но принимает строковый объект вместо объекта, подобного файлу. Вызов этого метода для строки полностью эквивалентен тому, чтобы сначала обернуть *text* в экземпляр [`StringIO`](https://python-all.ru/3.2/library/io.html#io.StringIO), а затем вызвать [`parse()`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser.parse).6869Необязательный параметр *headersonly* работает так же, как в методе [`parse()`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser.parse).7071#### `class email.parser.BytesParser(_class=email.message.Message, strict=None)`7273Этот класс полностью аналогичен [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser), но работает с байтовым вводом. Аргументы *\_class* и *strict* интерпретируются так же, как и для конструктора [`Parser`](https://python-all.ru/3.2/library/email.parser.html#email.parser.Parser). *strict* поддерживается только для упрощения переноса кода; он устарел.7475#### `parse(fp, headeronly=False)`7677Читает все данные из двоичного файлоподобного объекта *fp*, разбирает полученные байты и возвращает объект сообщения. *fp* должен поддерживать как метод [`readline()`](https://python-all.ru/3.2/library/readline.html#module-readline), так и метод `read()` для файлоподобных объектов.7879Байты, содержащиеся в *fp*, должны быть отформатированы как блок заголовков в стиле [**RFC 2822**](https://python-all.ru/3.2/library/email.parser.html) и строк продолжения заголовков, возможно, с предшествующим заголовком конверта. Блок заголовков завершается либо концом данных, либо пустой строкой. За блоком заголовков следует тело сообщения (которое может содержать MIME-кодированные подчасти, включая подчасти с *Content-Transfer-Encoding* равным `8bit`).8081Необязательный параметр *headersonly* – это флаг, указывающий, нужно ли остановить разбор после чтения заголовков. Значение по умолчанию – `False`, то есть разбирается всё содержимое файла.8283#### `parsebytes(bytes, headersonly=False)`8485Аналогичен методу [`parse()`](https://python-all.ru/3.2/library/email.parser.html#email.parser.BytesParser.parse), но принимает объект байтовой строки вместо файлоподобного объекта. Вызов этого метода для байтовой строки полностью эквивалентен тому, чтобы сначала обернуть *text* в экземпляр [`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO), а затем вызвать [`parse()`](https://python-all.ru/3.2/library/email.parser.html#email.parser.BytesParser.parse).8687Необязательный параметр *headersonly* работает так же, как в методе [`parse()`](https://python-all.ru/3.2/library/email.parser.html#email.parser.BytesParser.parse).8889Новое в версии 3.2.9091Поскольку создание структуры объекта сообщения из строки или файлового объекта является довольно распространённой задачей, для удобства предоставлены четыре функции. Они доступны в пространстве имён пакета верхнего уровня [`email`](https://python-all.ru/3.2/library/email.html#module-email).9293#### `email.message_from_string(s, _class=email.message.Message, strict=None)`9495Возвращает структуру объекта сообщения из строки. Это полностью эквивалентно `Parser().parsestr(s)`. Необязательные аргументы *\_class* и *strict* интерпретируются так же, как в конструкторе класса `Parser`.9697#### `email.message_from_bytes(s, _class=email.message.Message, strict=None)`9899Возвращает структуру объекта сообщения из байтовой строки. Это полностью эквивалентно `BytesParser().parsebytes(s)`. Необязательные аргументы *\_class* и *strict* интерпретируются так же, как в конструкторе класса `Parser`.100101Новое в версии 3.2.102103#### `email.message_from_file(fp, _class=email.message.Message, strict=None)`104105Возвращает дерево структуры объекта сообщения из открытого [*файлового объекта*](https://python-all.ru/3.2/glossary.html#term-file-object). Это полностью эквивалентно `Parser().parse(fp)`. Необязательные аргументы *\_class* и *strict* интерпретируются так же, как в конструкторе класса `Parser`.106107#### `email.message_from_binary_file(fp, _class=email.message.Message, strict=None)`108109Возвращает дерево структуры объекта сообщения из открытого двоичного [*файлового объекта*](https://python-all.ru/3.2/glossary.html#term-file-object). Это полностью эквивалентно `BytesParser().parse(fp)`. Необязательные аргументы *\_class* и *strict* интерпретируются так же, как в конструкторе класса `Parser`.110111Новое в версии 3.2.112113Вот пример использования этого в интерактивном приглашении Python:114115```python116>>> import email117>>> msg = email.message_from_string(myString)118```119120## 18.1.2.3. Дополнительные примечания121122Вот некоторые замечания по семантике разбора:123124- Большинство сообщений, не являющихся *multipart*, разбираются как одно сообщение со строковой полезной нагрузкой. Такие объекты будут возвращать `False` для `is_multipart()`. Их метод `get_payload()` будет возвращать строковый объект.125- Все сообщения типа *multipart* разбираются как контейнерное сообщение со списком вложенных сообщений в качестве полезной нагрузки. Внешнее контейнерное сообщение будет возвращать `True` для `is_multipart()`, а его метод `get_payload()` будет возвращать список подчастей [`Message`](https://python-all.ru/3.2/library/email.message.html#email.message.Message).126- Большинство сообщений с типом содержимого *message/\** (например,\\n*message/delivery-status* и *message/rfc822*) также будут\\nразобраны как объект-контейнер, содержащий полезную нагрузку в виде списка длиной 1. Их\\nметод `is_multipart()` будет возвращать `True`. Единственный элемент в\\nсписке полезной нагрузки будет объектом подсообщения.127- Некоторые сообщения, не соответствующие стандартам, могут быть внутренне непоследовательны в отношении\\nсвоей *многокомпонентности*. Такие сообщения могут иметь\\nзаголовок *Content-Type* типа *multipart*, но их\\nметод `is_multipart()` может возвращать `False`. Если такие сообщения были разобраны\\nс помощью `FeedParser`, они будут содержать экземпляр класса\\n`MultipartInvariantViolationDefect` в своем списке атрибутов *defects*.\\nПодробнее см. [`email.errors`](https://python-all.ru/3.2/library/email.errors.html#module-email.errors).128129Сноски130131| [\[1\]](https://python-all.ru/3.2/library/email.parser.html#id1) | Начиная с версии 3.0 пакета email, представленной в Python 2.4, классический\\n`Parser` был перереализован на основе `FeedParser`, поэтому\\nсемантика и результаты двух анализаторов идентичны. |132| --- | --- |133