pincer.middleware.message_delete.message_delete_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-03 21:50 UTC

message_delete_middleware() A

↳ Parent: pincer.middleware.message_delete

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	2

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

"""sent when a message is deleted in a subscribed text channel"""

from ..core.dispatch import GatewayDispatch
from ..objects.events.message import MessageDeleteEvent
from ..utils.conversion import construct_client_dict


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

    Middleware for ``on_message_delete`` event.

    Parameters
    ----------
    self : :class:`Client`
        The current client/bot

    payload : :class:`GatewayDispatch`
        The data recieved from the message delete event

    Returns
    -------
    Tuple[:class:`str`, :class:`~pincer.objects.events.message.MessageDeleteEvent`]
        ``on_message_delete`` and a ``MessageDeleteEvent`` object
    """
    return "on_message_delete", [
        MessageDeleteEvent.from_dict(construct_client_dict(self, payload.data))
    ]


def export():

    return message_delete_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 deleted in a subscribed text channel"""
5
6			from ..core.dispatch import GatewayDispatch
7			from ..objects.events.message import MessageDeleteEvent
8			from ..utils.conversion import construct_client_dict
9
10
11			async def message_delete_middleware(self, payload: GatewayDispatch):
12			"""\|coro\|
13
14			Middleware for ``on_message_delete`` event.
15
16			Parameters
17			----------
18			self : :class:`Client`
19			The current client/bot
20
21			payload : :class:`GatewayDispatch`
22			The data recieved from the message delete event
23
24			Returns
25			-------
26			Tuple[:class:`str`, :class:`~pincer.objects.events.message.MessageDeleteEvent`]
27			``on_message_delete`` and a ``MessageDeleteEvent`` object
28			"""
29			return "on_message_delete", [
30			MessageDeleteEvent.from_dict(construct_client_dict(self, payload.data))
31			]
32
33
34			def export():
			0 ignored issues – show introduced 2021-09-24 16:23 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
35			return message_delete_middleware
36

Pincer-org / Pincer

Pull Request — main (#174)

message_delete_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like