Passed
Pull Request — main (#174)
by
unknown
02:24
created

pincer.middleware.guild_stickers_update.export()   A

Complexity

Conditions 1

Size

Total Lines 2
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 2
dl 0
loc 2
rs 10
c 0
b 0
f 0
cc 1
nop 0
1
# Copyright Pincer 2021-Present
2
# Full MIT License can be found in `LICENSE` at the project root.
3
4
"""sent when a guild sticker is updated."""
5
6
from ..core.dispatch import GatewayDispatch
7
from ..objects.events.guild import GuildStickersUpdateEvent
8
from ..utils import Coro
9
from ..utils.conversion import construct_client_dict
10
11
12
async def guild_stickers_update_middleware(self, payload: GatewayDispatch):
13
    """|coro|
14
15
    Middleware for ``on_guild_stickers_update`` event.
16
17
    Parameters
18
    ----------
19
    self : :class:`Client`
20
        The current client/bot.
21
22
    payload : :class:`GatewayDispatch`
23
        The data received from the guild stickers update event.
24
25
    Returns
26
    -------
27
    Tuple[:class:`str`, List[:class:`~pincer.objects.events.guild.GuildStickersUpdateEvent`]]
28
        ``on_guild_sticker_update`` and a ``GuildStickersUpdateEvent`` object
29
    """
30
31
    return (
32
        "on_guild_stickers_update",
33
        [
34
            GuildStickersUpdateEvent.from_dict(
35
                construct_client_dict(self, payload.data)
36
            )
37
        ],
38
    )
39
40
41
def export() -> Coro:
0 ignored issues
show
introduced by
Missing function or method docstring
Loading history...
42
    return guild_stickers_update_middleware
43