pincer.middleware.user_update.user_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

user_update_middleware() A

↳ Parent: pincer.middleware.user_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	2

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

"""sent when properties about a user changes"""

from ..core.dispatch import GatewayDispatch
from ..objects.user import User
from ..utils.conversion import construct_client_dict
from ..utils.types import Coro


async def user_update_middleware(self, payload: GatewayDispatch):
    """|coro|

    Middleware for ``on_user_update`` event.

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

    payload : :class:`GatewayDispatch`
        The data received from the user update event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.user.user.User`]]
        ``on_user_update`` and a ``User``
    """
    return "on_voice_state_create", [
        User.from_dict(construct_client_dict(self, payload.data))
    ]


def export() -> Coro:

    return user_update_middleware


1			# Copyright Pincer 2021-Present
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			"""sent when properties about a user changes"""
5
6			from ..core.dispatch import GatewayDispatch
7			from ..objects.user import User
8			from ..utils.conversion import construct_client_dict
9			from ..utils.types import Coro
10
11
12			async def user_update_middleware(self, payload: GatewayDispatch):
13			"""\|coro\|
14
15			Middleware for ``on_user_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 user update event.
24
25			Returns
26			-------
27			Tuple[:class:`str`, List[:class:`~pincer.objects.user.user.User`]]
28			``on_user_update`` and a ``User``
29			"""
30			return "on_voice_state_create", [
31			User.from_dict(construct_client_dict(self, payload.data))
32			]
33
34
35			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...
36			return user_update_middleware
37

Pincer-org / Pincer

Pull Request — main (#174)

user_update_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like