CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix sleeping and improve documentation for AsyncIter (#3776)

Browse Source 
* welp

Signed-off-by: Drapersniper <27962761+drapersniper@users.noreply.github.com>

* moar docs

Signed-off-by: Drapersniper <27962761+drapersniper@users.noreply.github.com>

* moar docs

Signed-off-by: Drapersniper <27962761+drapersniper@users.noreply.github.com>

* Remove unnecessary items in `:exclude-members:`

* Make whitespace in docstrings consistent

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
This commit is contained in:
Draper 2020-04-21 12:45:03 +01:00 committed by GitHub
parent b08a950c37
commit a2c0e4ca2e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 77 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/framework_utils.rst
View File

@ -12,6 +12,7 @@ General Utility
.. autoclass:: AsyncIter .. autoclass:: AsyncIter
:members: :members:
:special-members: __await__
:exclude-members: enumerate, filter :exclude-members: enumerate, filter
.. automethod:: enumerate .. automethod:: enumerate

113
redbot/core/utils/__init__.py
View File

@ -260,21 +260,39 @@ def bounded_gather(
class AsyncIter(AsyncIterator[_T], Awaitable[List[_T]]): # pylint: disable=duplicate-bases class AsyncIter(AsyncIterator[_T], Awaitable[List[_T]]): # pylint: disable=duplicate-bases
"""Asynchronous iterator yielding items from ``iterable`` that sleeps for ``delay`` seconds every ``steps`` items. """Asynchronous iterator yielding items from ``iterable``
that sleeps for ``delay`` seconds every ``steps`` items.
Parameters Parameters
---------- ----------
iterable : Iterable iterable: Iterable
The iterable to make async. The iterable to make async.
delay: Union[float, int] delay: Union[float, int]
The amount of time in seconds to sleep. The amount of time in seconds to sleep.
steps: int steps: int
The number of iterations between sleeps. The number of iterations between sleeps.
Raises
------
ValueError
When ``steps`` is lower than 1.
Examples
--------
>>> from redbot.core.utils import AsyncIter
>>> async for value in AsyncIter(range(3)):
... print(value)
0
1
2
""" """
def __init__( def __init__(
self, iterable: Iterable[_T], delay: Union[float, int] = 0, steps: int = 1 self, iterable: Iterable[_T], delay: Union[float, int] = 0, steps: int = 1
) -> None: ) -> None:
if steps < 1:
raise ValueError("Steps must be higher than or equals to 1")
self._delay = delay self._delay = delay
self._iterator = iter(iterable) self._iterator = iter(iterable)
self._i = 0 self._i = 0
@ -288,16 +306,36 @@ class AsyncIter(AsyncIterator[_T], Awaitable[List[_T]]): # pylint: disable=dupl
item = next(self._iterator) item = next(self._iterator)
except StopIteration: except StopIteration:
raise StopAsyncIteration raise StopAsyncIteration
self._i += 1 if self._i == self._steps:
if self._i % self._steps == 0: self._i = 0
await asyncio.sleep(self._delay) await asyncio.sleep(self._delay)
self._i += 1
return item return item
def __await__(self) -> Generator[Any, None, List[_T]]: def __await__(self) -> Generator[Any, None, List[_T]]:
"""Returns a list of the iterable.
Examples
--------
>>> from redbot.core.utils import AsyncIter
>>> iterator = AsyncIter(range(5))
>>> await iterator
[0, 1, 2, 3, 4]
"""
return self.flatten().__await__() return self.flatten().__await__()
async def flatten(self) -> List[_T]: async def flatten(self) -> List[_T]:
"""Returns a list of the iterable.""" """Returns a list of the iterable.
Examples
--------
>>> from redbot.core.utils import AsyncIter
>>> iterator = AsyncIter(range(5))
>>> await iterator.flatten()
[0, 1, 2, 3, 4]
"""
return [item async for item in self] return [item async for item in self]
def filter(self, function: Callable[[_T], Union[bool, Awaitable[bool]]]) -> AsyncFilter[_T]: def filter(self, function: Callable[[_T], Union[bool, Awaitable[bool]]]) -> AsyncFilter[_T]:
@ -306,7 +344,7 @@ class AsyncIter(AsyncIterator[_T], Awaitable[List[_T]]): # pylint: disable=dupl
Parameters Parameters
---------- ----------
function : Callable[[T], Union[bool, Awaitable[bool]]] function: Callable[[T], Union[bool, Awaitable[bool]]]
A function or coroutine function which takes one item of ``iterable`` A function or coroutine function which takes one item of ``iterable``
as an argument, and returns ``True`` or ``False``. as an argument, and returns ``True`` or ``False``.
@ -318,21 +356,21 @@ class AsyncIter(AsyncIterator[_T], Awaitable[List[_T]]): # pylint: disable=dupl
Examples Examples
-------- --------
>>> from redbot.core.utils import AsyncIter >>> from redbot.core.utils import AsyncIter
>>> def predicate(value): >>> def predicate(value):
... return value <= 5 ... return value <= 5
>>> iterator = AsyncIter([1, 10, 5, 100]) >>> iterator = AsyncIter([1, 10, 5, 100])
>>> async for i in iterator.filter(predicate): >>> async for i in iterator.filter(predicate):
... print(i) ... print(i)
1 1
5 5
>>> from redbot.core.utils import AsyncIter >>> from redbot.core.utils import AsyncIter
>>> def predicate(value): >>> def predicate(value):
... return value <= 5 ... return value <= 5
>>> iterator = AsyncIter([1, 10, 5, 100]) >>> iterator = AsyncIter([1, 10, 5, 100])
>>> await iterator.filter(predicate) >>> await iterator.filter(predicate)
[1, 5] [1, 5]
""" """
return async_filter(function, self) return async_filter(function, self)
@ -342,7 +380,7 @@ class AsyncIter(AsyncIterator[_T], Awaitable[List[_T]]): # pylint: disable=dupl
Parameters Parameters
---------- ----------
start : int start: int
The index to start from. Defaults to 0. The index to start from. Defaults to 0.
Returns Returns
@ -352,13 +390,13 @@ class AsyncIter(AsyncIterator[_T], Awaitable[List[_T]]): # pylint: disable=dupl
Examples Examples
-------- --------
>>> from redbot.core.utils import AsyncIter >>> from redbot.core.utils import AsyncIter
>>> iterator = AsyncIter(['one', 'two', 'three']) >>> iterator = AsyncIter(['one', 'two', 'three'])
>>> async for i in iterator.enumerate(start=10): >>> async for i in iterator.enumerate(start=10):
... print(i) ... print(i)
(10, 'one') (10, 'one')
(11, 'two') (11, 'two')
(12, 'three') (12, 'three')
""" """
return async_enumerate(self, start) return async_enumerate(self, start)
@ -369,15 +407,16 @@ class AsyncIter(AsyncIterator[_T], Awaitable[List[_T]]): # pylint: disable=dupl
Examples Examples
-------- --------
>>> from redbot.core.utils import AsyncIter >>> from redbot.core.utils import AsyncIter
>>> iterator = AsyncIter([1,2,3,3,4,4,5]) >>> iterator = AsyncIter([1,2,3,3,4,4,5])
>>> async for i in iterator.without_duplicates(): >>> async for i in iterator.without_duplicates():
... print(i) ... print(i)
1 1
2 2
3 3
4 4
5 5
""" """
_temp = set() _temp = set()
async for item in self: async for item in self: