pincer.middleware.guild_member_add

Complexity

Total Complexity

2

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Importance

Changes

0

2 Functions

Rating	Name	Duplication	Size	Complexity
A	export()	0	2	1
A	guild_member_add_middleware()	0	21	1

# 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 __future__ import annotations

from typing import TYPE_CHECKING

from ..objects.events.guild import GuildMemberAddEvent
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_add_middleware(
    self: Client, gateway: Gateway, payload: GatewayDispatch

Wrong hanging indentation before block (add 4 spaces).

The argument gateway seems to be unused.

The argument self seems to be unused.

):
    """|coro|

    Middleware for the ``on_guild_member_add`` event.

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

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

    return ("on_guild_member_add", GuildMemberAddEvent.from_dict(payload.data))


def export() -> Coro:

Missing function or method docstring

    return guild_member_add_middleware