Total Complexity | 2 |
Total Lines | 49 |
Duplicated Lines | 0 % |
Changes | 0 |
1 | # Copyright Pincer 2021-Present |
||
2 | # Full MIT License can be found in `LICENSE` at the project root. |
||
3 | |||
4 | """ |
||
5 | Sent when a user is removed from a guild (leave/kick/ban). |
||
6 | """ |
||
7 | |||
8 | from __future__ import annotations |
||
9 | |||
10 | from typing import TYPE_CHECKING |
||
11 | |||
12 | from ..objects.events.guild import GuildMemberRemoveEvent |
||
13 | from ..utils import Coro |
||
14 | |||
15 | if TYPE_CHECKING: |
||
16 | from ..client import Client |
||
17 | from ..core.gateway import Gateway |
||
18 | from ..core.gateway import GatewayDispatch |
||
19 | |||
20 | |||
21 | async def guild_member_remove_middleware( |
||
22 | self: Client, gateway: Gateway, payload: GatewayDispatch |
||
23 | ): |
||
24 | """|coro| |
||
25 | |||
26 | Middleware for the ``on_guild_member_remove`` event. |
||
27 | |||
28 | Parameters |
||
29 | ---------- |
||
30 | payload : :class:`~pincer.core.gateway.GatewayDispatch` |
||
31 | The data received from the guild member remove event. |
||
32 | gateway : :class:`~pincer.core.gateway.Gateway` |
||
33 | The gateway for the current shard. |
||
34 | |||
35 | Returns |
||
36 | ------- |
||
37 | Tuple[:class:`str`, :class:`~pincer.objects.events.guild.GuildMemberRemoveEvent`] |
||
38 | ``on_guild_member_remove`` and a ``GuildMemberRemoveEvent`` |
||
39 | """ |
||
40 | |||
41 | return ( |
||
42 | "on_guild_member_remove", |
||
43 | GuildMemberRemoveEvent.from_dict(payload.data), |
||
44 | ) |
||
45 | |||
46 | |||
47 | def export() -> Coro: |
||
48 | return guild_member_remove_middleware |
||
49 |