pincer.middleware.typing_start

Complexity

Total Complexity

2

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes

0

2 Functions

Rating	Name	Duplication	Size	Complexity
A	typing_start_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 a user started typing in a channel"""

from ..core.dispatch import GatewayDispatch
from ..objects.events.typing_start import TypingStartEvent
from ..utils.conversion import construct_client_dict
from ..utils.types import Coro


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

Trailing whitespace

    Middleware for ``on_typing_start`` event.
    

Trailing whitespace

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

Trailing whitespace

    payload : :class:`GatewayDispatch`
        The data received from the typing start event.
        

Trailing whitespace

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.events.typing_start.TypingStartEvent`]]
        ``on_typing_start`` and a ``TypingStartEvent``
    """
    return "on_typing_start", [
        TypingStartEvent.from_dict(construct_client_dict(self, payload.data))
    ]


def export() -> Coro:

Missing function or method docstring

    return typing_start_middleware

Final newline missing