pincer.middleware.channel_pins_update.channel_pins_update_middleware() - Code Metrics - Inspection of ":sparkles: Add middleware" - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#174)

unknown

created 2021-11-03 21:50 UTC

channel_pins_update_middleware() A

↳ Parent: pincer.middleware.channel_pins_update

Complexity

Conditions

Size

Total Lines	21
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	21
rs	10
c	0
b	0
f	0
cc	1
nop	2

# Copyright Pincer 2021-Present
# Full MIT License can be found in `LICENSE` at the project root.

"""sent when a message in pinned/unpinned"""

from ..core.dispatch import GatewayDispatch
from ..objects.events.channel import ChannelPinsUpdateEvent


async def channel_pins_update_middleware(self, payload: GatewayDispatch):

    """|coro|

    Middleware for ``on_channel_pins_update``,

    Parameters
    ----------
    self : :class:`Client`
        The current client/bot.

    payload : :class:`pincer.core.dispatch.GatewayDispatch`
        The data received from the channel pins update event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.guild.channel.Channel`]]
        ``on_channel_pins_update`` and a ``Channel``
    """

    return "on_channel_pins_update", [
        ChannelPinsUpdateEvent.from_dict(payload.data)
    ]


def export():

    return channel_pins_update_middleware


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 2021-10-24 05:26 UTC by Report Bug Copy Issue Report 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`, List[:class:`~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 2021-10-24 05:26 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
35			return channel_pins_update_middleware
36

Pincer-org / Pincer

Pull Request — main (#174)

channel_pins_update_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like