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

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

↳ Parent: pincer.middleware.guild_ban_add

Complexity

Conditions

Size

Total Lines	21
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

from __future__ import annotations

from typing import TYPE_CHECKING

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

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


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

):
    """|coro|

    Middleware for the ``on_guild_ban_add`` event.

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

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

    return ("on_guild_ban_add", GuildBanAddEvent.from_dict(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 __future__ import annotations
7
8			from typing import TYPE_CHECKING
9
10			from ..objects.events.guild import GuildBanAddEvent
11			from ..utils 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 guild_ban_add_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_guild_ban_add`` event.
25
26			Parameters
27			----------
28			payload : :class:`~pincer.core.gateway.GatewayDispatch`
29			The data received from the guild ban add 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.events.guild.GuildBaAddEvent`]
36			``on_guild_ban_add_update`` and a ``GuildBanAddEvent``
37			"""
38
39			return ("on_guild_ban_add", GuildBanAddEvent.from_dict(payload.data))
40
41
42			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...
43			return guild_ban_add_middleware
44

Pincer-org / Pincer

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

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

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