pincer.middleware.resumed.on_resumed() - Code Metrics - Inspection of ":bug: :sparkles: Added VERY basic sharding support..." - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#329)

unknown

created 2021-12-27 02:21 UTC

pincer.middleware.resumed.on_resumed() A

↳ Parent: pincer.middleware.resumed

Complexity

Conditions

Size

Total Lines	29
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	9
dl	0
loc	29
rs	9.95
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.

"""
non-subscription event sent immediately after connecting,
contains server information
"""
from __future__ import annotations

from typing import TYPE_CHECKING
import logging

if TYPE_CHECKING:
    from typing import Tuple

    from ..utils.types import Coro
    from ..client import Client
    from ..core.gateway import Gateway
    from ..core.gateway import GatewayDispatch

_log = logging.getLogger(__package__)


async def on_resumed(
    self: Client,

    gateway: Gateway,

    payload: GatewayDispatch

) -> Tuple[str]:
    """|coro|

    Middleware for the ``on_resumed`` event.

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

    Returns
    -------
    Tuple[:class:`str`]
        ``on_ready``
    """

    _log.debug(
        "%s Successfully reconnected to Discord gateway. Restarting heartbeat.",
        gateway.shard_key
    )
    gateway.start_heartbeat()

    return ("on_resumed",)


def export() -> Coro:

    return on_resumed


1			# Copyright Pincer 2021-Present
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			"""
5			non-subscription event sent immediately after connecting,
6			contains server information
7			"""
8			from __future__ import annotations
9
10			from typing import TYPE_CHECKING
11			import logging
12
13			if TYPE_CHECKING:
14			from typing import Tuple
			0 ignored issues – show introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report Imports from package typing are not grouped Loading history...
15			from ..utils.types import Coro
16			from ..client import Client
17			from ..core.gateway import Gateway
18			from ..core.gateway import GatewayDispatch
19
20			_log = logging.getLogger(__package__)
21
22
23			async def on_resumed(
24			self: Client,
			0 ignored issues – show Unused Code introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report The argument `self` seems to be unused. Loading history... Coding Style introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
25			gateway: Gateway,
			0 ignored issues – show Coding Style introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
26			payload: GatewayDispatch
			0 ignored issues – show 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 2021-12-26 23:24 UTC by Report Bug Copy Issue Report The argument `payload` seems to be unused. Loading history...
27			) -> Tuple[str]:
28			"""\|coro\|
29
30			Middleware for the ``on_resumed`` event.
31
32			Parameters
33			----------
34			payload : :class:`~pincer.core.gateway.GatewayDispatch`
35			The data received from the stage instance create event
36			gateway : :class:`~pincer.core.gateway.Gateway`
37			The gateway for the current shard.
38
39			Returns
40			-------
41			Tuple[:class:`str`]
42			``on_ready``
43			"""
44
45			_log.debug(
46			"%s Successfully reconnected to Discord gateway. Restarting heartbeat.",
47			gateway.shard_key
48			)
49			gateway.start_heartbeat()
50
51			return ("on_resumed",)
52
53
54			def export() -> Coro:
			0 ignored issues – show introduced 2021-12-26 23:24 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
55			return on_resumed
56

Pincer-org / Pincer

Pull Request — main (#329)

pincer.middleware.resumed.on_resumed() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like