voice_server_update_middleware()   A
last analyzed

Complexity

Conditions 1

Size

Total Lines 22
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 5
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
"""sent when a guild's voice server is updated"""
5
6
from __future__ import annotations
7
8
from typing import TYPE_CHECKING
9
10
from ..objects.events.voice import VoiceServerUpdateEvent
11
from ..utils.types import Coro
12
13
if TYPE_CHECKING:
14
    from ..client import Client
15
    from ..core.gateway import Gateway
16
    from ..core.gateway import GatewayDispatch
17
18
19
async def voice_server_update_middleware(
20
    self: Client, gateway: Gateway, payload: GatewayDispatch
0 ignored issues
show
Coding Style introduced by
Wrong hanging indentation before block (add 4 spaces).
Loading history...
Unused Code introduced by
The argument gateway seems to be unused.
Loading history...
Unused Code introduced by
The argument self seems to be unused.
Loading history...
21
):
22
    """|coro|
23
24
    Middleware for the ``on_voice_server_update`` event.
25
26
    Parameters
27
    ----------
28
    payload : :class:`~pincer.core.gateway.GatewayDispatch`
29
        The data received from the voice server update event.
30
    gateway : :class:`~pincer.core.gateway.Gateway`
31
        The gateway for the current shard.
32
33
    Returns
34
    -------
35
    Tuple[:class:`str`, :class:`~pincer.objects.events.voice.VoiceServerUpdateEvent`]
36
        ``on_voice_server_update`` and a ``VoiceServerUpdateEvent``
37
    """  # noqa: E501
38
    return (
39
        "on_voice_server_update",
40
        VoiceServerUpdateEvent.from_dict(payload.data),
41
    )
42
43
44
def export() -> Coro:
0 ignored issues
show
introduced by
Missing function or method docstring
Loading history...
45
    return voice_server_update_middleware
46