REDROOM

Create

Preview: iterators.py Size: 2.08 KB

/lib64/python3.6/email/iterators.py

# Copyright (C) 2001-2006 Python Software Foundation
# Author: Barry Warsaw
# Contact: email-sig@python.org

"""Various types of useful iterators and generators."""

__all__ = [
    'body_line_iterator',
    'typed_subpart_iterator',
    'walk',
    # Do not include _structure() since it's part of the debugging API.
    ]

import sys
from io import StringIO



# This function will become a method of the Message class
def walk(self):
    """Walk over the message tree, yielding each subpart.

    The walk is performed in depth-first order.  This method is a
    generator.
    """
    yield self
    if self.is_multipart():
        for subpart in self.get_payload():
            yield from subpart.walk()



# These two functions are imported into the Iterators.py interface module.
def body_line_iterator(msg, decode=False):
    """Iterate over the parts, returning string payloads line-by-line.

    Optional decode (default False) is passed through to .get_payload().
    """
    for subpart in msg.walk():
        payload = subpart.get_payload(decode=decode)
        if isinstance(payload, str):
            yield from StringIO(payload)


def typed_subpart_iterator(msg, maintype='text', subtype=None):
    """Iterate over the subparts with a given MIME type.

    Use `maintype' as the main MIME type to match against; this defaults to
    "text".  Optional `subtype' is the MIME subtype to match against; if
    omitted, only the main type is matched.
    """
    for subpart in msg.walk():
        if subpart.get_content_maintype() == maintype:
            if subtype is None or subpart.get_content_subtype() == subtype:
                yield subpart



def _structure(msg, fp=None, level=0, include_default=False):
    """A handy debugging aid"""
    if fp is None:
        fp = sys.stdout
    tab = ' ' * (level * 4)
    print(tab + msg.get_content_type(), end='', file=fp)
    if include_default:
        print(' [%s]' % msg.get_default_type(), file=fp)
    else:
        print(file=fp)
    if msg.is_multipart():
        for subpart in msg.get_payload():
            _structure(subpart, fp, level+1, include_default)

Name	Size	Perms	Modified	Actions
mime DIR	-	drwxr-xr-x	2026-02-06 23:01:23	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2026-02-06 23:01:23	Edit Download recursive recursive
architecture.rst	9.34 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
base64mime.py	3.47 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
charset.py	16.75 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
contentmanager.py	10.42 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
encoders.py	1.74 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
errors.py	3.64 KB	lrw-r--r--	2026-02-05 20:00:12	Edit Download recursive recursive
feedparser.py	22.24 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
generator.py	20.96 KB	lrw-r--r--	2026-02-05 20:00:12	Edit Download recursive recursive
header.py	23.54 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
headerregistry.py	19.75 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
iterators.py	2.08 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
message.py	45.62 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
parser.py	4.92 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
policy.py	10.13 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
quoprimime.py	9.63 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
utils.py	18.70 KB	lrw-r--r--	2026-02-05 20:00:12	Edit Download recursive recursive
_encoded_words.py	8.32 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive
_header_value_parser.py	97.88 KB	lrw-r--r--	2026-02-05 20:00:12	Edit Download recursive recursive
_parseaddr.py	17.19 KB	lrw-r--r--	2026-02-05 20:00:12	Edit Download recursive recursive
_policybase.py	15.17 KB	lrw-r--r--	2026-02-05 20:00:12	Edit Download recursive recursive
__init__.py	1.72 KB	lrw-r--r--	2018-12-23 21:37:14	Edit Download recursive recursive

Directory Contents