pincer.middleware.guild_member_add.guild_member_add_middleware() - Code Metrics - Inspection of "✨ Implement Guild Member Middleware" - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#162)

unknown

created 2021-10-25 19:00 UTC

guild_member_add_middleware() A

↳ Parent: pincer.middleware.guild_member_add

Complexity

Conditions

Size

Total Lines	17
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	17
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 new user joins a guild. The inner payload is a guild member object
with an extra ``guild_id`` key.
"""

from ..core.dispatch import GatewayDispatch
from ..utils import Coro
from ..utils.conversion import construct_client_dict
from ..objects.events.guild import GuildMemberAddEvent


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

    Middleware for ``on_guild_member_add`` event.

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

    payload : :class:`GatewayDispatch`
        The data received from the guild member add event.
    """

    return "on_guild_member_add", [
        GuildMemberAddEvent.from_dict(
            construct_client_dict(self, payload.data)
        )
    ]


def export() -> Coro:

    return guild_member_add_middleware


1			# Copyright Pincer 2021-Present
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			"""
5			Sent when a new user joins a guild. The inner payload is a guild member object
6			with an extra ``guild_id`` key.
7			"""
8
9			from ..core.dispatch import GatewayDispatch
10			from ..utils import Coro
11			from ..utils.conversion import construct_client_dict
12			from ..objects.events.guild import GuildMemberAddEvent
13
14
15			async def guild_member_add_middleware(self, payload: GatewayDispatch):
16			"""\|coro\|
17
18			Middleware for ``on_guild_member_add`` event.
19
20			Parameters
21			----------
22			self : :class:`Client`
23			The current client/bot.
24
25			payload : :class:`GatewayDispatch`
26			The data received from the guild member add event.
27			"""
28
29			return "on_guild_member_add", [
30			GuildMemberAddEvent.from_dict(
31			construct_client_dict(self, payload.data)
32			)
33			]
34
35
36			def export() -> Coro:
			0 ignored issues – show introduced 2021-10-24 04:42 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
37			return guild_member_add_middleware
38

Pincer-org / Pincer

Pull Request — main (#162)

guild_member_add_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like