projects
/
python_utils.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
53d8e09
)
Update docs.
author
Scott Gasch
<
[email protected]
>
Tue, 5 Jul 2022 18:25:35 +0000
(11:25 -0700)
committer
Scott Gasch
<
[email protected]
>
Tue, 5 Jul 2022 18:25:35 +0000
(11:25 -0700)
iter_utils.py
patch
|
blob
|
history
diff --git
a/iter_utils.py
b/iter_utils.py
index b1a137c33a7c83c0c221492511240b803a1684ad..85c2749246b0e599bbba8d7134b960d267ec6b47 100644
(file)
--- a/
iter_utils.py
+++ b/
iter_utils.py
@@
-1,14
+1,25
@@
#!/usr/bin/env python3
#!/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):
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__()
>>> p = PeekingIterator(iter(range(3)))
>>> p.__next__()
@@
-27,6
+38,7
@@
class PeekingIterator(Iterator):
Traceback (most recent call last):
...
StopIteration
Traceback (most recent call last):
...
StopIteration
+
"""
def __init__(self, source_iter: Iterator):
"""
def __init__(self, source_iter: Iterator):
@@
-88,7
+100,7
@@
class PushbackIterator(Iterator):
return self
def __next__(self) -> Any:
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__()
return self.pushed_back.pop()
return self.source_iter.__next__()