pylav.utils.vendor.redbot package#

Module contents#

This module contains various utilities for working with asyncio taken from https://github.com/Cog-Creators/Red-DiscordBot/blob/V3/develop/redbot/core/utils/predicates.py https://github.com/Cog-Creators/Red-DiscordBot/blob/V3/develop/redbot/core/utils/__init__.py

Original license can be found at: https://github.com/Cog-Creators/Red-DiscordBot/blob/V3/develop/LICENSE

class pylav.utils.vendor.redbot.AsyncFilter(func, iterable)[source]#

Bases: AsyncIterator[_T], Awaitable[list[_T]]

Class returned by async_filter. See that function for details.

We do not recommend instantiating this class directly.

class pylav.utils.vendor.redbot.AsyncIter(iterable, delay=0, steps=100)[source]#

Bases: AsyncIterator[_T], Awaitable[list[_T]]

Asynchronous iterator yielding items from iterable that sleeps for delay seconds every steps items.

Parameters:

iterable (Iterable) – The iterable to make async.
delay (Union[float, int]) – The amount of time in seconds to sleep.
steps (int) – The number of iterations between sleeps.

Raises:

ValueError – When steps is lower than 1.

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> async for value in AsyncIter(range(3)):
...     print(value)
0
1
2

__await__()[source]#

Returns a list of the iterable.

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> iterator = AsyncIter(range(5))
>>> await iterator
[0, 1, 2, 3, 4]

enumerate(start=0)[source]#

Async iterable version of enumerate.

Parameters:: start (int) – The index to start from. Defaults to 0.
Returns:: An async iterator of tuples in the form of (index, item).
Return type:: AsyncIterator[Tuple[int, T]]

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> iterator = AsyncIter(['one', 'two', 'three'])
>>> async for i in iterator.enumerate(start=10):
...     print(i)
(10, 'one')
(11, 'two')
(12, 'three')

filter(function)[source]#

Filter the iterable with an (optionally async) predicate.

Parameters:: function (Callable[[T], Union[bool, Awaitable[bool]]]) – A function or coroutine function which takes one item of iterable as an argument, and returns True or False.
Returns:: An object which can either be awaited to yield a list of the filtered items, or can also act as an async iterator to yield items one by one.
Return type:: AsyncFilter[T]

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> def predicate(value):
...     return value <= 5
>>> iterator = AsyncIter([1, 10, 5, 100])
>>> async for i in iterator.filter(predicate):
...     print(i)
1
5

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> def predicate(value):
...     return value <= 5
>>> iterator = AsyncIter([1, 10, 5, 100])
>>> await iterator.filter(predicate)
[1, 5]

async find(predicate, default=None)[source]#

Calls predicate over items in iterable and return first value to match.

Parameters:

predicate (Union[Callable, Coroutine]) – A function that returns a boolean-like result. The predicate provided can be a coroutine.
default (Optional[Any]) – The value to return if there are no matches.

Raises:

TypeError – When predicate is not a callable.

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> await AsyncIter(range(3)).find(lambda x: x == 1)
1

async flatten()[source]#

Returns a list of the iterable.

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> iterator = AsyncIter(range(5))
>>> await iterator.flatten()
[0, 1, 2, 3, 4]

map(func)[source]#

Set the mapping callable for this instance of AsyncIter.

Important

This should be called after AsyncIter initialization and before any other of its methods.

Parameters:: func (Union[Callable, Coroutine]) – The function to map values to. The function provided can be a coroutine.
Raises:: TypeError – When func is not a callable.

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> async for value in AsyncIter(range(3)).map(bool):
...     print(value)
False
True
True

async next(default=Ellipsis)[source]#

Returns a next entry of the iterable.

Parameters:: default (Optional[Any]) – The value to return if the iterator is exhausted.
Raises:: StopAsyncIteration – When default is not specified and the iterator has been exhausted.

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> iterator = AsyncIter(range(5))
>>> await iterator.next()
0
>>> await iterator.next()
1

async without_duplicates()[source]#

Iterates while omitting duplicated entries.

Examples

>>> from pylav.utils.vendor.redbot import AsyncIter
>>> iterator = AsyncIter([1,2,3,3,4,4,5])
>>> async for i in iterator.without_duplicates():
...     print(i)
1
2
3
4
5

class pylav.utils.vendor.redbot.MessagePredicate(predicate)[source]#

Bases: Callable[Message, bool]

A simple collection of predicates for message events.

These predicates intend to help simplify checks in message events and reduce boilerplate code.

This class should be created through the provided classmethods. Instances of this class are callable message predicates, i.e. they return True if a message matches the criteria.

All predicates are combined with MessagePredicate.same_context().

Examples

Waiting for a response in the same channel and from the same author:

await bot.wait_for("message", check=MessagePredicate.same_context(ctx))

Waiting for a response to a yes or no question:

pred = MessagePredicate.yes_or_no(ctx)
await bot.wait_for("message", check=pred)
if pred.result is True:
    # User responded "yes"
    ...

Getting a member object from a user’s response:

pred = MessagePredicate.valid_member(ctx)
await bot.wait_for("message", check=pred)
member = pred.result

result#

The object which the message content matched with. This is dependent on the predicate used - see each predicate’s documentation for details, not every method will assign this attribute. Defaults to None.

Type:: Any

classmethod cancelled(ctx=None, channel=None, user=None)[source]#

Match if the message is [p]cancel.

Parameters:

ctx (Optional[Context]) – Same as ctx in same_context().
channel (Optional[Union[`discord.TextChannel`, discord.Thread, discord.DMChannel]]) – Same as channel in same_context().
user (Optional[discord.abc.User]) – Same as user in same_context().

Returns:

The event predicate.

Return type: