pincer.middleware.activity_spectate.activity_spectate_middleware() - Code Metrics - Inspection of ":sparkles: Add middleware" - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#174)

by Yohann

created 2021-11-10 17:09 UTC

activity_spectate_middleware() A

↳ Parent: pincer.middleware.activity_spectate

Complexity

Conditions

Size

Total Lines	17
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	17
rs	10
c	0
b	0
f	0
cc	1
nop	2

# 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 ..objects.events.activity import ActivitySpectateEvent
from ..utils.conversion import construct_client_dict
from ..core.dispatch import GatewayDispatch
from ..utils.types import Coro


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

    Middleware for ``on_activity_spectate`` event.

    Parameters
    ----------
    payload : :class:`GatewayDispatch`
        The data received from the activity spectate event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`ActivitySpectateEvent`]]
        ``on_activity_spectate`` and an ``ActivitySpectateEvent``
    """
    return "on_activity_spectate", [
        ActivitySpectateEvent.from_dict(construct_client_dict(self, 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 ..objects.events.activity import ActivitySpectateEvent
10			from ..utils.conversion import construct_client_dict
11			from ..core.dispatch import GatewayDispatch
12			from ..utils.types import Coro
13
14
15			async def activity_spectate_middleware(self, payload: GatewayDispatch):
16			"""\|coro\|
17
18			Middleware for ``on_activity_spectate`` event.
19
20			Parameters
21			----------
22			payload : :class:`GatewayDispatch`
23			The data received from the activity spectate event.
24
25			Returns
26			-------
27			Tuple[:class:`str`, List[:class:`ActivitySpectateEvent`]]
28			``on_activity_spectate`` and an ``ActivitySpectateEvent``
29			"""
30			return "on_activity_spectate", [
31			ActivitySpectateEvent.from_dict(construct_client_dict(self, payload.data))
32			]
33
34
35			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...
36			return activity_spectate_middleware
37

Pincer-org / Pincer

Pull Request — main (#174)

activity_spectate_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like