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

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

↳ Parent: pincer.middleware.guild_member_remove

Complexity

Conditions

Size

Total Lines	23
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
dl	0
loc	23
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 removed from a guild (leave/kick/ban).
"""

from __future__ import annotations

from typing import TYPE_CHECKING

from ..objects.events.guild import GuildMemberRemoveEvent
from ..utils import Coro

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


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

):
    """|coro|

    Middleware for the ``on_guild_member_remove`` event.

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

    Returns
    -------
    Tuple[:class:`str`, :class:`~pincer.objects.events.guild.GuildMemberRemoveEvent`]
        ``on_guild_member_remove`` and a ``GuildMemberRemoveEvent``
    """

    return (
        "on_guild_member_remove",
        GuildMemberRemoveEvent.from_dict(payload.data),
    )


def export() -> Coro:

    return guild_member_remove_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 user is removed from a guild (leave/kick/ban).
6			"""
7
8			from __future__ import annotations
9
10			from typing import TYPE_CHECKING
11
12			from ..objects.events.guild import GuildMemberRemoveEvent
13			from ..utils import Coro
14
15			if TYPE_CHECKING:
16			from ..client import Client
17			from ..core.gateway import Gateway
18			from ..core.gateway import GatewayDispatch
19
20
21			async def guild_member_remove_middleware(
22			self: Client, gateway: Gateway, payload: GatewayDispatch
			0 ignored issues – show Unused Code introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report The argument `gateway` seems to be unused. Loading history... 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 2022-01-09 22:44 UTC by Report Bug Copy Issue Report The argument `self` seems to be unused. Loading history...
23			):
24			"""\|coro\|
25
26			Middleware for the ``on_guild_member_remove`` event.
27
28			Parameters
29			----------
30			payload : :class:`~pincer.core.gateway.GatewayDispatch`
31			The data received from the guild member remove event.
32			gateway : :class:`~pincer.core.gateway.Gateway`
33			The gateway for the current shard.
34
35			Returns
36			-------
37			Tuple[:class:`str`, :class:`~pincer.objects.events.guild.GuildMemberRemoveEvent`]
38			``on_guild_member_remove`` and a ``GuildMemberRemoveEvent``
39			"""
40
41			return (
42			"on_guild_member_remove",
43			GuildMemberRemoveEvent.from_dict(payload.data),
44			)
45
46
47			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...
48			return guild_member_remove_middleware
49

Pincer-org / Pincer

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

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

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