Passed
Pull Request — main (#163)
by
unknown
01:38
created

pincer.middleware.channel_pins_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 message in pinned/unpinned"""
5
6
from ..core.dispatch import GatewayDispatch
7
from ..objects.events.channel import ChannelPinsUpdateEvent
8
9
10
async def channel_pins_update_middleware(self, payload: GatewayDispatch):
0 ignored issues
show
Unused Code introduced by
The argument self seems to be unused.
Loading history...
11
    """|coro|
12
13
    Middleware for ``on_channel_pins_update``,
14
15
    Parameters
16
    ----------
17
    self : :class:`Client`
18
        The current client/bot.
19
20
    payload : :class:`pincer.core.dispatch.GatewayDispatch`
21
        The data received from the channel pins update event.
22
23
    Returns
24
    -------
25
    Tuple[:class:`str`, `~pincer.objects.guild.channel.Channel`]
26
        ``on_channel_pins_update`` and a ``Channel``
27
    """
28
29
    return "on_channel_pins_update", [
30
        ChannelPinsUpdateEvent.from_dict(payload.data)
31
    ]
32
33
34
def export():
0 ignored issues
show
introduced by
Missing function or method docstring
Loading history...
35
    return channel_pins_update_middleware
36