pincer.middleware.invite_create

Complexity

Total Complexity

2

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes

0

2 Functions

Rating	Name	Duplication	Size	Complexity
A	invite_create_middleware()	0	20	1
A	export()	0	2	1

# Copyright Pincer 2021-Present
# Full MIT License can be found in `LICENSE` at the project root.

"""sent when an invite was created"""

from pincer.utils.types import Coro
from ..core.dispatch import GatewayDispatch
from ..objects.events.invite import InviteCreateEvent
from ..utils.conversion import construct_client_dict


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

    Middleware for ``on_invite_create``,

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

    payload : :class:`GatewayDispatch`
        The data recieved from the invite create event

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.events.invite.InviteCreateEvent`]]
        ``on_invite_create`` and an ``InviteCreateEvent`` object
    """
    return "on_invite_create", [
        InviteCreateEvent.from_dict(construct_client_dict(self, payload.data))
    ]


def export() -> Coro:

Missing function or method docstring

    return invite_create_middleware