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

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

↳ Parent: pincer.middleware.message_create

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 a message is created in a subscribed text channel"""
from __future__ import annotations

from typing import TYPE_CHECKING

from ..objects.message.user_message import UserMessage

if TYPE_CHECKING:
    from typing import Tuple

    from ..client import Client
    from ..core.gateway import Gateway
    from ..core.gateway import GatewayDispatch


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

) -> Tuple[str, UserMessage]:  # noqa: E501
    """|coro|

    Middleware for the ``on_message`` event.

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

    Returns
    -------
    Tuple[:class:`str`, :class:`~pincer.objects.message.user_message.UserMessage`]
        ``on_message`` and a ``UserMessage``
    """  # noqa: E501
    return ("on_message", UserMessage.from_dict(payload.data))


def export():

    return message_create_middleware


1			# Copyright Pincer 2021-Present
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			"""sent when a message is created in a subscribed text channel"""
5			from __future__ import annotations
6
7			from typing import TYPE_CHECKING
8
9			from ..objects.message.user_message import UserMessage
10
11			if TYPE_CHECKING:
12			from typing import Tuple
13
14			from ..client import Client
15			from ..core.gateway import Gateway
16			from ..core.gateway import GatewayDispatch
17
18
19			async def message_create_middleware(
20			self: Client, gateway: Gateway, payload: GatewayDispatch
			0 ignored issues – show Unused Code introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report The argument `gateway` seems to be unused. Loading history... Coding Style introduced 2021-10-18 18:08 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). 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...
21			) -> Tuple[str, UserMessage]: # noqa: E501
22			"""\|coro\|
23
24			Middleware for the ``on_message`` event.
25
26			Parameters
27			----------
28			payload : :class:`pincer.core.gateway.GatewayDispatch`
29			The data received from the message creation event.
30			gateway : :class:`~pincer.core.gateway.Gateway`
31			The gateway for the current shard.
32
33			Returns
34			-------
35			Tuple[:class:`str`, :class:`~pincer.objects.message.user_message.UserMessage`]
36			``on_message`` and a ``UserMessage``
37			""" # noqa: E501
38			return ("on_message", UserMessage.from_dict(payload.data))
39
40
41			def export():
			0 ignored issues – show introduced 2021-09-14 09:00 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
42			return message_create_middleware
43

Pincer-org / Pincer

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

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

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