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

email.iterators: Итераторыemail.iterators: Iterators

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

Обход дерева объектов сообщения довольно прост с помощью метода Message.walk. Модуль email.iterators предоставляет несколько полезных итераций более высокого уровня по деревьям объектов сообщения.

email.iterators.body_line_iterator(msg, decode=False)

Эта функция обходит все полезные нагрузки во всех подчастях msg, возвращая строковые полезные нагрузки строка за строкой. Она пропускает все заголовки подчастей, а также пропускает любую подчасть, полезная нагрузка которой не является строкой Python. Это примерно эквивалентно чтению плоского текстового представления сообщения из файла с помощью readline(), с пропуском всех промежуточных заголовков.

Необязательный параметр decode передаётся в Message.get_payload.

email.iterators.typed_subpart_iterator(msg, maintype='text', subtype=None)

Эта функция обходит все подчасти msg, возвращая только те подчасти, которые соответствуют MIME-типу, заданному параметрами maintype и subtype.

Обратите внимание, что subtype необязателен; если он опущен, то сопоставление MIME-типа подчасти выполняется только по основному типу. maintype также необязателен; по умолчанию он равен text.

Таким образом, по умолчанию typed_subpart_iterator() возвращает каждую подчасть, имеющую MIME-тип text/*.

Следующая функция добавлена как полезный инструмент отладки. Она должна не считаться частью поддерживаемого публичного интерфейса пакета.

email.iterators._structure(msg, fp=None, level=0, include_default=False)

Выводит представление типов содержимого структуры объекта сообщения с отступами. Например:

>>> msg = email.message_from_file(somefile)
>>> _structure(msg)
multipart/mixed
    text/plain
    text/plain
    multipart/digest
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
    text/plain

Необязательный параметр fp – это файлоподобный объект, в который выводится результат. Он должен быть пригоден для функции print() в Python. level используется внутри. include_default, если равен true, также выводит тип по умолчанию.