apoor.ibuff()

Complexity

Conditions

6

Size

Total Lines	43
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

"""A small personal package created to store code and data I often reuse. 
def ibuff(itr: Iterable, bsize: int = 1) -> Iterable[List]:
    """Creates an iterable that yields elements
    from ``itr`` grouped into lists of size ``bsize``.

    If ``itr`` can't evenly be grouped into lists of size
    ``bsize``, the final list will have the remaining
    elements.

    :param itr: The interable to be buffered.
    :param bsize: Positive integer, representing the number of
        values from ``itr`` to be yielded together.

        The final list yielded may not be of size ``bsize`` if
        ``len(itr)`` doesn't evenly divide into groups of ``bsize``.
    :yields: Buffered elements from ``itr``, grouped into lists
        of size up to ``bsize``.
    :raises TypeError: If ``bsize`` isn't an integer.
    :raises ValueError: If ``bsize`` isn't positive.
    

Trailing whitespace

    Examples:
        >>> for b in apoor.ibuff(range(10),3):
        ...     print(b)
        [0, 1, 2]
        [3, 4, 5]
        [6, 7, 8]
        [9]
    """
    # Perform checks
    if not isinstance(bsize,int):

Exactly one space required after comma

        raise TypeError("bsize needs to be a positive integer.")
    if bsize < 1:
        raise ValueError("bsize needs to be a positive integer.")
    # Initialize the buffer
    buff = []
    for v in itr:

Variable name "v" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        if len(buff) < bsize: # If buff not full, append
            buff.append(v)
        else:                 # Otherwise yield and reinit
            yield buff
            buff = [v]
    # Check if there's anything left in the buffer
    if len(buff) > 0:
        yield buff