pincer.middleware.guild_ban_add.guild_ban_add_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

guild_ban_add_middleware() A

↳ Parent: pincer.middleware.guild_ban_add

Complexity

Conditions

Size

Total Lines	22
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	22
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 guild ban is add."""

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


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

    Middleware for ``on_guild_ban_add`` event.

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

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

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.events.guild.GuildBaAaddEvent`]]
        ``on_guild_ban_add_update`` and a ``GuildBanAddEvent`` object
    """

    return (
        "on_guild_ban_add",
        [GuildBanAddEvent.from_dict(construct_client_dict(self, payload.data))],
    )


def export() -> Coro:

    return guild_ban_add_middleware


1			# Copyright Pincer 2021-Present
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			"""sent when a guild ban is add."""
5
6			from ..core.dispatch import GatewayDispatch
7			from ..objects.events.guild import GuildBanAddEvent
8			from ..utils import Coro
9			from ..utils.conversion import construct_client_dict
10
11
12			async def guild_ban_add_middleware(self, payload: GatewayDispatch):
13			"""\|coro\|
14
15			Middleware for ``on_guild_ban_add`` 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 guild ban add event.
24
25			Returns
26			-------
27			Tuple[:class:`str`, List[:class:`~pincer.objects.events.guild.GuildBaAaddEvent`]]
28			``on_guild_ban_add_update`` and a ``GuildBanAddEvent`` object
29			"""
30
31			return (
32			"on_guild_ban_add",
33			[GuildBanAddEvent.from_dict(construct_client_dict(self, payload.data))],
34			)
35
36
37			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...
38			return guild_ban_add_middleware
39

Pincer-org / Pincer

Pull Request — main (#174)

guild_ban_add_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like