pincer.middleware.channel_pins_update.channel_pins_update_middleware() - Code Metrics - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

channel_pins_update_middleware() A
last analyzed 2022-12-26 13:13 UTC

↳ Parent: pincer.middleware.channel_pins_update

Complexity

Conditions

Size

Total Lines	26
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	7
dl	0
loc	26
rs	10
c	0
b	0
f	0
cc	1
nop	3

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

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

from __future__ import annotations

from typing import TYPE_CHECKING

from ..objects.events.channel import ChannelPinsUpdateEvent

if TYPE_CHECKING:
    from ..client import Client
    from ..core.gateway import Gateway
    from ..core.gateway import GatewayDispatch


async def channel_pins_update_middleware(
    self: Client, gateway: Gateway, payload: GatewayDispatch

):
    """|coro|

    Middleware for the ``on_channel_pins_update`` event.

    Parameters
    ----------
    payload : :class:`pincer.core.gateway.GatewayDispatch`
        The data received from the channel pins update event.
    gateway : :class:`~pincer.core.gateway.Gateway`
        The gateway for the current shard.

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

    event = ChannelPinsUpdateEvent.from_dict(payload.data)
    self.channels[
        event.channel_id
    ].last_pin_timestamp = event.last_pin_timestamp

    return ("on_channel_pins_update", event)


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 __future__ import annotations
7
8			from typing import TYPE_CHECKING
9
10			from ..objects.events.channel import ChannelPinsUpdateEvent
11
12			if TYPE_CHECKING:
13			from ..client import Client
14			from ..core.gateway import Gateway
15			from ..core.gateway import GatewayDispatch
16
17
18			async def channel_pins_update_middleware(
19			self: Client, gateway: Gateway, payload: GatewayDispatch
			0 ignored issues – show Coding Style introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history... Unused Code introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report The argument `gateway` seems to be unused. Loading history...
20			):
21			"""\|coro\|
22
23			Middleware for the ``on_channel_pins_update`` event.
24
25			Parameters
26			----------
27			payload : :class:`pincer.core.gateway.GatewayDispatch`
28			The data received from the channel pins update event.
29			gateway : :class:`~pincer.core.gateway.Gateway`
30			The gateway for the current shard.
31
32			Returns
33			-------
34			Tuple[:class:`str`, :class:`~pincer.objects.guild.channel.Channel`]
35			``on_channel_pins_update`` and a ``Channel``
36			"""
37
38			event = ChannelPinsUpdateEvent.from_dict(payload.data)
39			self.channels[
40			event.channel_id
41			].last_pin_timestamp = event.last_pin_timestamp
42
43			return ("on_channel_pins_update", event)
44
45
46			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...
47			return channel_pins_update_middleware
48

Pincer-org / Pincer

channel_pins_update_middleware() A last analyzed 2022-12-26 13:13 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

channel_pins_update_middleware() A
last analyzed 2022-12-26 13:13 UTC