`email.parser.md`

110 строк · 19.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/2.7/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/2.7/library/email.parser.html#module-email.parser): Разбор сообщений электронной почты89Структуры объектов сообщений можно создать двумя способами: создать с нуля, создавая объекты [`Message`](https://python-all.ru/2.7/library/email.message.html#email.message.Message) и соединяя их вызовами [`attach()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.attach) и [`set_payload()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.set_payload), или разобрать плоское текстовое представление сообщения электронной почты.1011Пакет [`email`](https://python-all.ru/2.7/library/email.html#module-email) предоставляет стандартный анализатор, который понимает большинство структур документов электронной почты, включая MIME-документы. Анализатору можно передать строку или файловый объект, и он вернёт корневой экземпляр [`Message`](https://python-all.ru/2.7/library/email.message.html#email.message.Message) объектной структуры. Для простых не-MIME сообщений полезная нагрузка этого корневого объекта, скорее всего, будет строкой, содержащей текст сообщения. Для MIME-сообщений корневой объект вернёт `True` из своего метода [`is_multipart()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.is_multipart), а вложенные части можно получить через методы [`get_payload()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.get_payload) и [`walk()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.walk).1213Фактически доступны два интерфейса анализатора: классический API [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser) и инкрементальный API [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser). Классический API [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser) подходит, если всё текстовое сообщение находится в памяти в виде строки или хранится в файле файловой системы. [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser) лучше подходит при чтении сообщения из потока, который может блокироваться в ожидании новых данных (например, при чтении из сокета). [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser) может потреблять и анализировать сообщение инкрементально, возвращая корневой объект только после закрытия анализатора [1](https://python-all.ru/2.7/library/email.parser.html#id2).1415Обратите внимание, что анализатор можно ограниченно расширять, и, конечно, вы можете полностью реализовать свой собственный анализатор с нуля. Между встроенным анализатором пакета [`email`](https://python-all.ru/2.7/library/email.html#module-email) и классом [`Message`](https://python-all.ru/2.7/library/email.message.html#email.message.Message) нет никакой магической связи, поэтому ваш собственный анализатор может создавать деревья объектов сообщений любым подходящим ему способом.1617## 18.1.2.1. FeedParser API1819Новое в версии 2.4.2021[`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser), импортируемый из модуля `email.feedparser`, предоставляет API, удобный для инкрементального разбора сообщений электронной почты, например при чтении текста сообщения из источника, который может блокироваться (например, сокета). [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser), конечно, можно использовать и для разбора сообщения, полностью содержащегося в строке или файле, но классический API [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser) может быть удобнее в таких случаях. Семантика и результаты обоих API анализаторов идентичны.2223API [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser) прост: создайте экземпляр, подавайте на вход текст, пока не закончится, затем закройте анализатор, чтобы получить корневой объект сообщения. [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser) чрезвычайно точен при разборе сообщений, соответствующих стандартам, и отлично справляется с несоответствующими сообщениями, предоставляя информацию о том, почему сообщение было признано некорректным. Он заполняет атрибут *defects* объекта сообщения списком всех найденных проблем. Список дефектов, которые он может найти, см. в модуле [`email.errors`](https://python-all.ru/2.7/library/email.errors.html#module-email.errors).2425Вот API для [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser):2627#### `class email.parser.FeedParser([_factory])`2829Создаёт экземпляр [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser). Необязательный параметр *\_factory* – это вызываемый объект без аргументов, который будет вызываться при необходимости создания нового объекта сообщения. По умолчанию используется класс [`email.message.Message`](https://python-all.ru/2.7/library/email.message.html#email.message.Message).3031#### `feed(data)`3233Передаёт дополнительные данные анализатору [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser). *data* должна быть строкой, содержащей одну или несколько строк. Строки могут быть неполными, и [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser) правильно соберёт такие части строк. Строки могут иметь любые из трёх распространённых окончаний: возврат каретки, перевод строки или возврат каретки и перевод строки (допускается смешивание).3435#### `close()`3637Закрытие [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser) завершает разбор всех ранее переданных данных и возвращает корневой объект сообщения. Что произойдёт при передаче дополнительных данных закрытому [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser), не определено.3839## 18.1.2.2. API класса Parser4041Класс [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser), импортированный из модуля [`email.parser`](https://python-all.ru/2.7/library/email.parser.html#module-email.parser), предоставляет API, который можно использовать для разбора сообщения, когда полное содержимое сообщения доступно в строке или файле. Модуль [`email.parser`](https://python-all.ru/2.7/library/email.parser.html#module-email.parser) также предоставляет второй класс, называемый `HeaderParser`, который можно использовать, если интересуют только заголовки сообщения. `HeaderParser` может быть намного быстрее в таких ситуациях, поскольку он не пытается разобрать тело сообщения, а вместо этого устанавливает полезную нагрузку в виде необработанного тела как строку. `HeaderParser` имеет тот же API, что и класс [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser).4243#### `class email.parser.Parser([_class])`4445Конструктор класса [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser) принимает необязательный аргумент *\_class*. Это должен быть вызываемый объект-фабрика (например, функция или класс), используемый при необходимости создания подобъекта сообщения. По умолчанию используется [`Message`](https://python-all.ru/2.7/library/email.message.html#email.message.Message) (см. [`email.message`](https://python-all.ru/2.7/library/email.message.html#module-email.message)). Фабрика вызывается без аргументов.4647Необязательный флаг *strict* игнорируется.4849Устарело с версии 2.4: Поскольку класс [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser) является обратно совместимой оберткой API вокруг нового в Python 2.4 [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser), *весь* разбор фактически является нестрогим. Следует просто прекратить передавать флаг *strict* конструктору [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser).5051Изменено в версии 2.2.2: Флаг *strict* был добавлен.5253Изменено в версии 2.4: Флаг *strict* был объявлен устаревшим.5455Другие открытые методы [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser):5657#### `parse(fp[, headersonly])`5859Читает все данные из файлоподобного объекта *fp*, разбирает полученный текст и возвращает корневой объект сообщения. *fp* должен поддерживать как метод [`readline()`](https://python-all.ru/2.7/library/io.html#io.TextIOBase.readline), так и метод [`read()`](https://python-all.ru/2.7/library/io.html#io.TextIOBase.read), характерные для файлоподобных объектов.6061Текст, содержащийся в *fp*, должен быть отформатирован как блок заголовков и строк продолжения заголовков в стиле [**RFC 2822**](https://python-all.ru/2.7/library/email.parser.html), при необходимости перед которым может идти конвертный заголовок. Блок заголовков завершается либо концом данных, либо пустой строкой. После блока заголовков следует тело сообщения (которое может содержать MIME-кодированные вложенные части).6263Необязательный параметр *headersonly* – флаг, указывающий, следует ли остановить разбор после чтения заголовков. По умолчанию `False`, то есть разбирается всё содержимое файла.6465Изменено в версии 2.2.2: Флаг *headersonly* был добавлен.6667#### `parsestr(text[, headersonly])`6869Аналогичен методу [`parse()`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser.parse), за исключением того, что принимает строковый объект вместо файлоподобного. Вызов этого метода для строки эквивалентен предварительной обёртке *text* в экземпляр [`StringIO`](https://python-all.ru/2.7/library/stringio.html#StringIO.StringIO) с последующим вызовом [`parse()`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser.parse).7071Необязательный параметр *headersonly* действует так же, как в методе [`parse()`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser.parse).7273Изменено в версии 2.2.2: Флаг *headersonly* был добавлен.7475Поскольку создание структуры объекта сообщения из строки или файлового объекта является такой распространенной задачей, для удобства предоставляются две функции. Они доступны в пространстве имен пакета верхнего уровня [`email`](https://python-all.ru/2.7/library/email.html#module-email).7677#### `email.message_from_string(s[, _class[, strict]])`7879Возвращает структуру объекта сообщения из строки. Это полностью эквивалентно `Parser().parsestr(s)`. Необязательные параметры *\_class* и *strict* интерпретируются так же, как в конструкторе класса [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser).8081Изменено в версии 2.2.2: Флаг *strict* был добавлен.8283#### `email.message_from_file(fp[, _class[, strict]])`8485Возвращает древовидную структуру объекта сообщения из открытого файлового объекта. Это полностью эквивалентно `Parser().parse(fp)`. Необязательные параметры *\_class* и *strict* интерпретируются так же, как в конструкторе класса [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser).8687Изменено в версии 2.2.2: Флаг *strict* был добавлен.8889Вот пример использования этого в интерактивном приглашении Python:9091```python92>>> import email93>>> msg = email.message_from_string(myString)94```9596## 18.1.2.3. Дополнительные примечания9798Вот некоторые замечания по семантике разбора:99100- Большинство сообщений, не являющихся *multipart*, разбираются как одиночный объект сообщения со строковым содержимым. Такие объекты будут возвращать `False` для [`is_multipart()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.is_multipart). Их метод [`get_payload()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.get_payload) будет возвращать строковый объект.101- Все сообщения типа *multipart* будут разбираться как объект-контейнер со списком объектов-подсообщений в качестве содержимого. Внешний контейнер будет возвращать `True` для [`is_multipart()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.is_multipart), а его метод [`get_payload()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.get_payload) вернёт список из [`Message`](https://python-all.ru/2.7/library/email.message.html#email.message.Message) подчастей.102- Большинство сообщений с типом содержимого *message/\** (например, *message/delivery-status* и *message/rfc822*) также будут разбираться как объект-контейнер, содержащий полезную нагрузку в виде списка длиной 1. Их метод [`is_multipart()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.is_multipart) вернёт `True`. Единственный элемент в списке будет объектом-подсообщением.103- Некоторые сообщения, не соответствующие стандартам, могут быть внутренне несогласованы относительно своей *multipart*-ности. Такие сообщения могут иметь заголовок *Content-Type* типа *multipart*, но их метод [`is_multipart()`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.is_multipart) может возвращать `False`. Если такие сообщения были разобраны с помощью [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser), они будут содержать экземпляр класса `MultipartInvariantViolationDefect` в списке атрибутов *defects*. Подробнее см. [`email.errors`](https://python-all.ru/2.7/library/email.errors.html#module-email.errors).104105Сноски106107**[1](https://python-all.ru/2.7/library/email.parser.html#id1)**108109Начиная с версии 3.0 пакета email, представленной в Python 2.4, классический [`Parser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.Parser) был перереализован на основе [`FeedParser`](https://python-all.ru/2.7/library/email.parser.html#email.parser.FeedParser), поэтому семантика и результаты двух парсеров идентичны.110