Skip to content

feat/fix: improve typehinting of wait_fors #1694

New issue

Have a question about this project? No Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

No Sign up for GitHub

By clicking “No Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? No Sign in to your account

Merged
merged 2 commits into from
Jun 20, 2024
Merged

feat/fix: improve typehinting of wait_fors #1694

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e06b50
feat/fix: improve typehinting of wait_fors
AstreaTSS Jun 8, 2024
b87addf
ci: correct from checks.
pre-commit-ci[bot] Jun 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 86 additions & 6 deletions interactions/client/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
Union,
Awaitable,
Tuple,
TypeVar,
overload,
)

from aiohttp import BasicAuth
Expand All @@ -40,6 +42,7 @@
from interactions.client import errors
from interactions.client.const import (
GLOBAL_SCOPE,
Missing,
MISSING,
Absent,
EMBED_MAX_DESC_LENGTH,
Expand Down Expand Up @@ -122,6 +125,8 @@
if TYPE_CHECKING:
from interactions.models import Snowflake_Type, TYPE_ALL_CHANNEL

EventT = TypeVar("EventT", bound=BaseEvent)

__all__ = ("Client",)

# see https://discord.com/developers/docs/topics/gateway#list-of-intents
Expand Down Expand Up @@ -1061,12 +1066,36 @@ async def wait_until_ready(self) -> None:
"""Waits for the client to become ready."""
await self._ready.wait()

@overload
def wait_for(
self,
event: type[EventT],
checks: Absent[Callable[[EventT], bool] | Callable[[EventT], Awaitable[bool]]] = MISSING,
timeout: Optional[float] = None,
) -> "Awaitable[EventT]": ...

@overload
def wait_for(
self,
event: Union[str, "BaseEvent"],
checks: Absent[Optional[Union[Callable[..., bool], Callable[..., Awaitable[bool]]]]] = MISSING,
event: str,
checks: Callable[[EventT], bool] | Callable[[EventT], Awaitable[bool]],
timeout: Optional[float] = None,
) -> Any:
) -> "Awaitable[EventT]": ...

@overload
def wait_for(
self,
event: str,
checks: Missing = MISSING,
timeout: Optional[float] = None,
) -> Awaitable[Any]: ...

def wait_for(
self,
event: Union[str, "type[BaseEvent]"],
checks: Absent[Callable[[BaseEvent], bool] | Callable[[BaseEvent], Awaitable[bool]]] = MISSING,
timeout: Optional[float] = None,
) -> Awaitable[Any]:
"""
Waits for a WebSocket event to be dispatched.

Expand Down Expand Up @@ -1112,17 +1141,68 @@ async def wait_for_modal(
"""
author = to_snowflake(author) if author else None

def predicate(event) -> bool:
def predicate(event: events.ModalCompletion) -> bool:
if modal.custom_id != event.ctx.custom_id:
return False
return author == to_snowflake(event.ctx.author) if author else True

resp = await self.wait_for("modal_completion", predicate, timeout)
return resp.ctx

@overload
async def wait_for_component(
self,
messages: Union[Message, int, list],
components: Union[
List[List[Union["BaseComponent", dict]]],
List[Union["BaseComponent", dict]],
"BaseComponent",
dict,
],
check: Optional[Callable[[events.Component], bool] | Callable[[events.Component], Awaitable[bool]]] = None,
timeout: Optional[float] = None,
) -> "events.Component": ...

@overload
async def wait_for_component(
self,
*,
components: Union[
List[List[Union["BaseComponent", dict]]],
List[Union["BaseComponent", dict]],
"BaseComponent",
dict,
],
check: Optional[Callable[[events.Component], bool] | Callable[[events.Component], Awaitable[bool]]] = None,
timeout: Optional[float] = None,
) -> "events.Component": ...

@overload
async def wait_for_component(
self,
messages: None,
components: Union[
List[List[Union["BaseComponent", dict]]],
List[Union["BaseComponent", dict]],
"BaseComponent",
dict,
],
check: Optional[Callable[[events.Component], bool] | Callable[[events.Component], Awaitable[bool]]] = None,
timeout: Optional[float] = None,
) -> "events.Component": ...

@overload
async def wait_for_component(
self,
messages: Union[Message, int, list],
components: None = None,
check: Optional[Callable[[events.Component], bool] | Callable[[events.Component], Awaitable[bool]]] = None,
timeout: Optional[float] = None,
) -> "events.Component": ...

async def wait_for_component(
self,
messages: Union[Message, int, list] = None,
messages: Optional[Union[Message, int, list]] = None,
components: Optional[
Union[
List[List[Union["BaseComponent", dict]]],
Expand All @@ -1131,7 +1211,7 @@ async def wait_for_component(
dict,
]
] = None,
check: Absent[Optional[Union[Callable[..., bool], Callable[..., Awaitable[bool]]]]] | None = None,
check: Optional[Callable[[events.Component], bool] | Callable[[events.Component], Awaitable[bool]]] = None,
timeout: Optional[float] = None,
) -> "events.Component":
"""
Expand Down
Loading