class documentation

class _IteratorBuffer: (source)

View In Hierarchy

An iterator which buffers the elements of a container and periodically passes them as input to a writer.
Method __init__
Method __iter__ Return an iterator.
Method __next__ Get the next string from the container, buffer it, and possibly send the buffer to the writer.
Instance Variable bufSize The number of bytes currently in the buffer.
Instance Variable iterator An iterator over a container of strings.
Instance Variable lines The buffer, which is a list of strings.
Instance Variable memoryBufferSize See __init__.
Instance Variable write See __init__.
def __init__(self, write, iterable, memoryBufferSize=None): (source)
Parameters
write:callable that takes list of bytesA writer which is a callable that takes a list of strings.
iterable:iterable which yields bytesAn iterable container of strings.
memoryBufferSize:int or NoneThe number of bytes to buffer before flushing the buffer to the writer.
def __iter__(self): (source)
Return an iterator.
Returns
iterator which yields bytesAn iterator over strings.
def __next__(self): (source)

Get the next string from the container, buffer it, and possibly send the buffer to the writer.

The contents of the buffer are written when it is full or when no further values are available from the container.

Raises
StopIterationWhen no further values are available from the container.
bufSize: int = (source)
The number of bytes currently in the buffer.
iterator: iterator which yields bytes = (source)
An iterator over a container of strings.
lines: list of bytes = (source)
The buffer, which is a list of strings.
memoryBufferSize = (source)
See __init__.