pincer.middleware.thread_create.thread_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)

unknown

created 2021-11-03 21:50 UTC

thread_create_middleware() A

↳ Parent: pincer.middleware.thread_create

Complexity

Conditions

Size

Total Lines	21
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	21
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 thread is created/joined on the client."""

from ..core.dispatch import GatewayDispatch
from ..objects import Channel
from ..utils.conversion import construct_client_dict


def thread_create_middleware(self, payload: GatewayDispatch):
    """|coro|

    Middleware for ``on_thread_create`` event.

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

    payload : :class:`GatewayDispatch`
        The data received from the thread create event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.guild.channel.Channel`]]
        ``on_thread_create`` and an ``Channel``
    """

    return "on_thread_create", [
        Channel.from_dict(construct_client_dict(self, payload.data))
    ]


def export():

    return thread_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 thread is created/joined on the client."""
5
6			from ..core.dispatch import GatewayDispatch
7			from ..objects import Channel
8			from ..utils.conversion import construct_client_dict
9
10
11			def thread_create_middleware(self, payload: GatewayDispatch):
12			"""\|coro\|
13
14			Middleware for ``on_thread_create`` event.
15
16			Parameters
17			----------
18			self : :class:`Client`
19			The current client/bot.
20
21			payload : :class:`GatewayDispatch`
22			The data received from the thread create event.
23
24			Returns
25			-------
26			Tuple[:class:`str`, List[:class:`~pincer.objects.guild.channel.Channel`]]
27			``on_thread_create`` and an ``Channel``
28			"""
29
30			return "on_thread_create", [
31			Channel.from_dict(construct_client_dict(self, payload.data))
32			]
33
34
35			def export():
			0 ignored issues – show introduced 2021-10-24 05:26 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
36			return thread_create_middleware
37

Pincer-org / Pincer

Pull Request — main (#174)

thread_create_middleware() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like