From d54d91ddfb14821ce1e1d878a96faec090ff31b9 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Tue, 5 Jul 2022 11:25:35 -0700 Subject: [PATCH] Update docs. --- iter_utils.py | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/iter_utils.py b/iter_utils.py index b1a137c..85c2749 100644 --- a/iter_utils.py +++ b/iter_utils.py @@ -1,14 +1,25 @@ #!/usr/bin/env python3 +# © Copyright 2021-2022, Scott Gasch + +"""A collection if :class:`Iterator` subclasses that can be composed +with another iterator and provide extra functionality. e.g. + + + :class:`PeekingIterator` + + :class:`PushbackIterator` + + :class:`SamplingIterator` + +""" + import random from collections.abc import Iterator from typing import Any, List, Optional class PeekingIterator(Iterator): - """An iterator that lets you peek() at the next item on deck. - Returns None when there is no next item (i.e. when __next__() - will produce a StopIteration exception). + """An iterator that lets you :method:`peek` at the next item on deck. + Returns None when there is no next item (i.e. when + :method:`__next__` will produce a StopIteration exception). >>> p = PeekingIterator(iter(range(3))) >>> p.__next__() @@ -27,6 +38,7 @@ class PeekingIterator(Iterator): Traceback (most recent call last): ... StopIteration + """ def __init__(self, source_iter: Iterator): @@ -88,7 +100,7 @@ class PushbackIterator(Iterator): return self def __next__(self) -> Any: - if len(self.pushed_back): + if len(self.pushed_back) > 0: return self.pushed_back.pop() return self.source_iter.__next__() -- 2.45.2