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

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

↳ Parent: pincer.middleware.activity_spectate

Complexity

Conditions

Size

Total Lines	20
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	20
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 the user clicks a Rich Presence spectate invite in chat to
spectate a game
"""

from __future__ import annotations

from typing import TYPE_CHECKING

from ..objects.events.activity import ActivitySpectateEvent
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_spectate_middleware(
    self: Client, gateway: Gateway, payload: GatewayDispatch

):
    """|coro|

    Middleware for the ``on_activity_spectate`` event.

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

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


def export() -> Coro:

    return activity_spectate_middleware


1			# Copyright Pincer 2021-Present
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			"""
5			sent when the user clicks a Rich Presence spectate invite in chat to
6			spectate a game
7			"""
8
9			from __future__ import annotations
10
11			from typing import TYPE_CHECKING
12
13			from ..objects.events.activity import ActivitySpectateEvent
14			from ..utils.types import Coro
15
16			if TYPE_CHECKING:
17			from ..client import Client
18			from ..core.gateway import Gateway
19			from ..core.gateway import GatewayDispatch
20
21
22			async def activity_spectate_middleware(
23			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...
24			):
25			"""\|coro\|
26
27			Middleware for the ``on_activity_spectate`` event.
28
29			Parameters
30			----------
31			payload : :class:`~pincer.core.gateway.GatewayDispatch`
32			The data received from the activity spectate event.
33			gateway : :class:`~pincer.core.gateway.Gateway`
34			The gateway for the current shard.
35
36			Returns
37			-------
38			Tuple[:class:`str`, :class:`~pincer.objects.event.activity.ActivitySpectateEvent`]
39			``on_activity_spectate`` and an ``ActivitySpectateEvent``
40			""" # noqa: E501
41			return "on_activity_spectate", ActivitySpectateEvent.from_dict(payload.data)
42
43
44			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...
45			return activity_spectate_middleware
46

Pincer-org / Pincer

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

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

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