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

Passed

Pull Request — main (#174)

unknown

created 2021-11-04 10:12 UTC

speaking_stop_middleware() A

↳ Parent: pincer.middleware.speaking_stop

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 a user in a subscribed voice channel stops speaking"""

from ..core.dispatch import GatewayDispatch
from ..objects.events.voice import SpeakingStopEvent
from ..utils.conversion import construct_client_dict
from ..utils.types import Coro


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

    Middleware for ``on_speaking_stop`` event.

    Parameters
    ----------
    payload : :class:`GatewayDispatch`
        The data received from the speaking stop event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`Snowflake`]]
        ``on_speaking_stop`` and a ``Snowflake`` (user_id)
    """
    return "on_speaking_stop", [
        SpeakingStopEvent.from_dict(construct_client_dict(self, payload.data))
    ]


def export() -> Coro:

    return speaking_stop_middleware


1			# Copyright Pincer 2021-Present
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			"""sent when a user in a subscribed voice channel stops speaking"""
5
6			from ..core.dispatch import GatewayDispatch
7			from ..objects.events.voice import SpeakingStopEvent
8			from ..utils.conversion import construct_client_dict
9			from ..utils.types import Coro
10
11
12			async def speaking_stop_middleware(self, payload: GatewayDispatch):
13			"""\|coro\|
14
15			Middleware for ``on_speaking_stop`` event.
16
17			Parameters
18			----------
19			payload : :class:`GatewayDispatch`
20			The data received from the speaking stop event.
21
22			Returns
23			-------
24			Tuple[:class:`str`, List[:class:`Snowflake`]]
25			``on_speaking_stop`` and a ``Snowflake`` (user_id)
26			"""
27			return "on_speaking_stop", [
28			SpeakingStopEvent.from_dict(construct_client_dict(self, payload.data))
29			]
30
31
32			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...
33			return speaking_stop_middleware
34

Pincer-org / Pincer

Pull Request — main (#174)

speaking_stop_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like