pincer.middleware.error.error_middleware()   A
last analyzed

Complexity

Conditions 1

Size

Total Lines 22
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 3
dl 0
loc 22
rs 10
c 0
b 0
f 0
cc 1
nop 3
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 when there is an error,
6
including command responses
7
"""
8
from __future__ import annotations
9
10
from typing import TYPE_CHECKING
11
12
from ..objects.events.error import DiscordError
13
from ..utils.types import Coro
14
15
if TYPE_CHECKING:
16
    from typing import Tuple
17
    from ..client import Client
18
    from ..core.gateway import Gateway
19
    from ..core.gateway import GatewayDispatch
20
21
22
def error_middleware(
23
    self: Client, gateway: Gateway, payload: GatewayDispatch
0 ignored issues
show
Unused Code introduced by
The argument gateway seems to be unused.
Loading history...
Coding Style introduced by
Wrong hanging indentation before block (add 4 spaces).
Loading history...
Unused Code introduced by
The argument self seems to be unused.
Loading history...
24
) -> Tuple[str, DiscordError]:
25
    """|coro|
26
27
    Middleware for the ``on_error`` event.
28
29
    Parameters
30
    ----------
31
    payload : :class:`~pincer.core.gateway.GatewayDispatch`
32
        The data received from the ready event.
33
    gateway : :class:`~pincer.core.gateway.Gateway`
34
        The gateway for the current shard.
35
36
    Returns
37
    -------
38
    Tuple[:class:`str`, :class:`~pincer.objects.events.error.DiscordError`]
39
        ``on_error`` and a ``DiscordError``
40
    """
41
    # noqa: E501
42
43
    return ("on_error", DiscordError.from_dict(payload.data))
44
45
46
def export() -> Coro:
0 ignored issues
show
introduced by
Missing function or method docstring
Loading history...
47
    return error_middleware
48