Passed
Pull Request — main (#174)
by
unknown
02:24
created

pincer.middleware.voice_channel_select.export()   A

Complexity

Conditions 1

Size

Total Lines 2
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 2
dl 0
loc 2
rs 10
c 0
b 0
f 0
cc 1
nop 0
1
# Copyright Pincer 2021-Present
2
# Full MIT License can be found in `LICENSE` at the project root.
3
4
"""sent when the client joins a voice channel"""
5
6
from ..core.dispatch import GatewayDispatch
7
from ..objects.events.voice import VoiceChannelSelectEvent
8
from ..utils.conversion import construct_client_dict
9
from ..utils.types import Coro
10
11
12
async def voice_channel_select_middleware(self, payload: GatewayDispatch):
13
    """|coro|
14
    
0 ignored issues
show
Coding Style introduced by
Trailing whitespace
Loading history...
15
    Middleware for ``on_voice_channel_select`` event.
16
    
0 ignored issues
show
Coding Style introduced by
Trailing whitespace
Loading history...
17
    Parameters
18
    ----------
19
    self : :class:`Client`
20
        The current client/bot.
21
        
0 ignored issues
show
Coding Style introduced by
Trailing whitespace
Loading history...
22
    payload : :class:`GatewayDispatch`
23
        The data received from the voice channel select event.
24
        
0 ignored issues
show
Coding Style introduced by
Trailing whitespace
Loading history...
25
    Returns
26
    -------
27
    Tuple[:class:`str`, List[:class:`~pincer.objects.events.voice.VoiceChannelSelectEvent`]]
28
        ``on_voice_channel_select`` and a ``VoiceChannelSelectEvent`` object
29
    """
30
    return "on_voice_channel_select", [
31
        VoiceChannelSelectEvent.from_dict(construct_client_dict(self, payload.data))
32
    ]
33
34
35
def export() -> Coro:
0 ignored issues
show
introduced by
Missing function or method docstring
Loading history...
36
    return voice_channel_select_middleware
37