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)

docroot: /home/induvedam/public_html

curdir: /opt/alt/python38/lib64/python3.8/email

	.	4096
	..	8192
X	__init__.py	1766
	__pycache__	4096
X	_encoded_words.py	8524
X	_header_value_parser.py	108117
X	_parseaddr.py	17684
X	_policybase.py	15534
X	architecture.rst	9561
X	base64mime.py	3558
X	charset.py	17128
X	contentmanager.py	10699
X	encoders.py	1786
X	errors.py	3726
X	feedparser.py	22780
X	generator.py	21538
X	header.py	24102
X	headerregistry.py	20811
X	iterators.py	2135
X	message.py	47072
	mime	189
X	parser.py	5041
X	policy.py	10383
X	quoprimime.py	9858
X	utils.py	17278