pincer.middleware.notification_create.notification_create_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

notification_create_middleware() A

↳ Parent: pincer.middleware.notification_create

Complexity

Conditions

Size

Total Lines	19
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
dl	0
loc	19
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 client receives a notification
(mention or new message in eligible channels)
"""

from ..core.dispatch import GatewayDispatch
from ..objects.events.notification import NotificationCreateEvent
from ..utils.conversion import construct_client_dict
from ..utils.types import Coro


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

    Middleware for ``on_notification_create`` event.

    Parameters
    ----------
    payload : :class:`GatewayDispatch`
        The data received from the notification create event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.events.notification.NotificationCreateEvent`]]
        ``on_notification_create`` and a ``NotificationCreateEvent``
    """
    channel_id: int = payload.data.get("channel_id")
    payload.data["message"]["channel_id"] = channel_id
    return "on_notification_create", [
        NotificationCreateEvent.from_dict(construct_client_dict(self, payload.data))
    ]


def export() -> Coro:

    return notification_create_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 client receives a notification
6			(mention or new message in eligible channels)
7			"""
8
9			from ..core.dispatch import GatewayDispatch
10			from ..objects.events.notification import NotificationCreateEvent
11			from ..utils.conversion import construct_client_dict
12			from ..utils.types import Coro
13
14
15			async def notification_create_middleware(self, payload: GatewayDispatch):
16			"""\|coro\|
17
18			Middleware for ``on_notification_create`` event.
19
20			Parameters
21			----------
22			payload : :class:`GatewayDispatch`
23			The data received from the notification create event.
24
25			Returns
26			-------
27			Tuple[:class:`str`, List[:class:`~pincer.objects.events.notification.NotificationCreateEvent`]]
28			``on_notification_create`` and a ``NotificationCreateEvent``
29			"""
30			channel_id: int = payload.data.get("channel_id")
31			payload.data["message"]["channel_id"] = channel_id
32			return "on_notification_create", [
33			NotificationCreateEvent.from_dict(construct_client_dict(self, payload.data))
34			]
35
36
37			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...
38			return notification_create_middleware
39

Pincer-org / Pincer

Pull Request — main (#174)

notification_create_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like