pincer.middleware.channel

Complexity

Total Complexity

11

Size/Duplication

Total Lines	118
Duplicated Lines	43.22 %

Importance

Changes

0

5 Functions

Rating	Name	Duplication	Size	Complexity
A	channel_delete_middleware()	25	25	4
A	channel_update_middleware()	26	26	4
A	channel_pins_update_middleware()	0	17	1
A	export()	0	5	1
A	channel_create_middleware()	0	19	1

# Copyright Pincer 2021-Present

Missing module docstring

# Full MIT License can be found in `LICENSE` at the project root.
from __future__ import annotations

"""Channel Middlewares"""

This string statement has no effect and could be removed.

from typing import TYPE_CHECKING

Import "from typing import TYPE_CHECKING" should be placed at the top of the module

from ..core.dispatch import GatewayDispatch

Import "from ..core.dispatch import GatewayDispatch" should be placed at the top of the module

from ..objects.guild.channel import Channel

The name channel does not seem to exist in module pincer.objects.guild.

Cannot import 'objects.guild.channel' due to syntax error 'invalid syntax (<unknown>, line 249)'

Import "from ..objects.guild.channel import Channel" should be placed at the top of the module

from ..utils.conversion import construct_client_dict

Import "from ..utils.conversion import construct_client_dict" should be placed at the top of the module

from ..objects.events.channel import ChannelPinsUpdateEvent

Import "from ..objects.events.channel import ChannelPinsUpdateEvent" should be placed at the top of the module

if TYPE_CHECKING:
    from typing import List, Tuple

def channel_create_middleware(
    self, payload: GatewayDispatch

Wrong hanging indentation before block (add 4 spaces).

) -> Tuple[str, List[Channel]]:
    """|coro|

    Middleware for ``on_channel_creation`` event.

    Parameters
    ----------
    payload : :class:`~pincer.core.dispatch.GatewayDispatch`
        The data received from the ready event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.guild.channel.Channel`]]
        ``"on_channel_creation"`` and a channel.
    """
    return "on_channel_creation", [
        Channel.from_dict(construct_client_dict(self, payload.data))
    ]


async def channel_delete_middleware(self, payload: GatewayDispatch):

This code seems to be duplicated in your project.

    """|coro|

    Middleware for ``on_channel_delete``,

    Parameters
    ----------
    payload : :class:`pincer.core.dispatch.GatewayDispatch`
        The data received from the channel delete event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.guild.channel.Channel`]]
        ``on_channel_delete`` and a ``Channel``
    """

    channel = Channel.from_dict(construct_client_dict(self, payload.data))

    if channel.guild_id in self.guilds:
        guild = self.guilds[channel.guild_id]
        old = filter(lambda c: c.id == channel.id, guild.channels)
        if old:
            guild.channels.remove(old)

    return "on_channel_delete", [channel]


async def channel_pins_update_middleware(self, payload: GatewayDispatch):

The argument self seems to be unused.

    """|coro|

    Middleware for ``on_channel_pins_update``,

    Parameters
    ----------
    payload : :class:`pincer.core.dispatch.GatewayDispatch`
        The data received from the channel pins update event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.guild.channel.Channel`]]
        ``on_channel_pins_update`` and a ``Channel``
    """

    return "on_channel_pins_update", [ChannelPinsUpdateEvent.from_dict(payload.data)]


async def channel_update_middleware(self, payload: GatewayDispatch):

This code seems to be duplicated in your project.

    """|coro|

    Middleware for ``on_channel_update`` event.

    Parameters
    ----------
    payload : :class:`GatewayDispatch`
        The data received from the channel update event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.channel.channel.Channel`]]
        ``on_channel_update`` and a ``Channel``
    """

    channel = Channel.from_dict(construct_client_dict(self, payload.data))

    if channel.guild_id in self.guilds.keys():
        guild = self.guilds[channel.guild_id]
        old = filter(lambda c: c.id == channel.id, guild.channels)
        if old:
            guild.channels.remove(old)
        guild.channels.append(channel)

    return "on_channel_update", [channel]


def export():

Missing function or method docstring

    return (
        channel_create_middleware,
        channel_delete_middleware,
        channel_pins_update_middleware,
    )