pincer.middleware.thread_list_sync

Complexity

Total Complexity

2

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Importance

Changes

0

2 Functions

Rating	Name	Duplication	Size	Complexity
A	thread_list_sync()	0	33	1
A	export()	0	2	1

# Copyright Pincer 2021-Present
# Full MIT License can be found in `LICENSE` at the project root.

"""sent when the client gains access to a channel"""

from __future__ import annotations

from typing import List

from ..core.dispatch import GatewayDispatch
from ..objects import Channel, ThreadMember
from ..objects.events.thread import ThreadListSyncEvent
from ..utils.conversion import construct_client_dict


async def thread_list_sync(self, payload: GatewayDispatch):
    """|coro|

    Middleware for ``on_thread_list_sync`` event.

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

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


    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.guild.events.thread.ThreadListSyncEvent`]]
        ``on_thread_list_sync`` and an ``ThreadListSyncEvent``
    """

    threads: List[Channel] = [
        Channel.from_dict(construct_client_dict(self, thread))
        for thread in payload.data.pop("threads")
    ]

    members: List[ThreadMember] = [
        ThreadMember.from_dict(construct_client_dict(self, member))
        for member in payload.data.pop("members")
    ]

    return "on_thread_list_sync", [
        ThreadListSyncEvent.from_dict(
            {"threads": threads, "members": members, **payload.data}
        )
    ]


def export():

Missing function or method docstring

    return thread_list_sync