pincer.middleware.activity_join

Complexity

Total Complexity

2

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Importance

Changes

0

2 Functions

Rating	Name	Duplication	Size	Complexity
A	activity_join_middleware()	0	22	1
A	export()	0	2	1

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

"""
Sent when the user clicks a Rich Presence join invite in chat
to join a game.
"""

from __future__ import annotations

from typing import TYPE_CHECKING

from ..objects.events.activity import ActivityJoinEvent
from ..utils.types import Coro

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


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

The argument gateway seems to be unused.

Wrong hanging indentation before block (add 4 spaces).

The argument self seems to be unused.

):
    """|coro|

    Middleware for the ``on_activity_join`` event.

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

    Returns
    -------
    Tuple[:class:`str`, :class:`~pincer.objects.events.activity.ActivityJoinEvent`]
        ``on_activity_join`` and an ``ActivityJoinEvent``
    """  # noqa: E501
    return (
        "on_activity_join",
        ActivityJoinEvent.from_dict(payload.data),
    )


def export() -> Coro:

Missing function or method docstring

    return activity_join_middleware