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

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

↳ Parent: pincer.middleware.presence_update

Complexity

Conditions

Size

Total Lines	20
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	20
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 user is updated"""

from __future__ import annotations

from typing import TYPE_CHECKING

from ..objects.events.presence import PresenceUpdateEvent
from ..utils.types import Coro

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


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

):
    """|coro|

    Middleware for the ``on_presence_update`` event.

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

    Returns
    -------
    Tuple[:class:`str`, :class:`~pincer.objects.user.voice_state.PresenceUpdateEvent`]
        ``on_presence_update`` and a ``PresenceUpdateEvent``
    """  # noqa: E501
    return ("on_presence_update", PresenceUpdateEvent.from_dict(payload.data))


def export() -> Coro:

    return presence_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 user is updated"""
5
6			from __future__ import annotations
7
8			from typing import TYPE_CHECKING
9
10			from ..objects.events.presence import PresenceUpdateEvent
11			from ..utils.types import Coro
12
13			if TYPE_CHECKING:
14			from ..client import Client
15			from ..core.gateway import Gateway
16			from ..core.gateway import GatewayDispatch
17
18
19			async def presence_update_middleware(
20			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... Unused Code introduced 2022-01-09 22:44 UTC by Report Bug Copy Issue Report The argument `self` seems to be unused. Loading history...
21			):
22			"""\|coro\|
23
24			Middleware for the ``on_presence_update`` event.
25
26			Parameters
27			----------
28			payload : :class:`~pincer.core.gateway.GatewayDispatch`
29			The data received from the presence update event.
30			gateway : :class:`~pincer.core.gateway.Gateway`
31			The gateway for the current shard.
32
33			Returns
34			-------
35			Tuple[:class:`str`, :class:`~pincer.objects.user.voice_state.PresenceUpdateEvent`]
36			``on_presence_update`` and a ``PresenceUpdateEvent``
37			""" # noqa: E501
38			return ("on_presence_update", PresenceUpdateEvent.from_dict(payload.data))
39
40
41			def export() -> Coro:
			0 ignored issues – show introduced 2021-11-03 20:47 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
42			return presence_update_middleware
43

Pincer-org / Pincer

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

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

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