pincer.objects.guild.channel.TextChannel.mention() - Code Metrics - Inspection of "Upgrade docs" - Pincer-org/Pincer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#155)

by Oliver

created 2021-10-21 11:20 UTC

pincer.objects.guild.channel.TextChannel.mention() A

↳ Parent: pincer.objects.guild.channel

Complexity

Conditions

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nop	1

# Copyright Pincer 2021-Present

# Full MIT License can be found in `LICENSE` at the project root.

from __future__ import annotations

from enum import IntEnum
from dataclasses import dataclass
from typing import overload, TYPE_CHECKING

from ...utils.types import MISSING
from ..._config import GatewayConfig
from ...utils.api_object import APIObject

if TYPE_CHECKING:
    from typing import Dict, List, Optional, Union

    from ...client import Client

    from ..user.user import User
    from .member import GuildMember
    from .overwrite import Overwrite
    from .thread import ThreadMetadata
    from ...utils.types import APINullable
    from ...utils.snowflake import Snowflake
    from ...utils.timestamp import Timestamp



class ChannelType(IntEnum):
    """Represents a channel its type.

    Attributes
    ----------
    GUILD_TEXT:
        A text channel.
    DM:
        A DM channel.
    GUILD_VOICE:
        A voice channel.
    GROUP_DM:
        A group DM channel.
    GUILD_CATEGORY:
        A category channel.
    GUILD_NEWS:
        A news channel.
    GUILD_STORE:
        A store channel.
    GUILD_NEWS_THREAD:
        A news thread.
    GUILD_PUBLIC_THREAD:
        A public thread.
    GUILD_PRIVATE_THREAD:
        A private thread.
    GUILD_STAGE_VOICE:
        A stage channel.
    """
    GUILD_TEXT = 0
    DM = 1
    GUILD_VOICE = 2
    GROUP_DM = 3
    GUILD_CATEGORY = 4
    GUILD_NEWS = 5
    GUILD_STORE = 6

    if GatewayConfig.version >= 9:
        GUILD_NEWS_THREAD = 10
        GUILD_PUBLIC_THREAD = 11
        GUILD_PRIVATE_THREAD = 12

    GUILD_STAGE_VOICE = 13


@dataclass

class Channel(APIObject):  # noqa E501
    """Represents a Discord Channel Mention object

    Attributes
    ----------
    id: :class:`~pincer.utils.snowflake.Snowflake`
        The id of this channel
    type: :class:`~pincer.objects.guild.channel.ChannelType`
        The type of channel
    application_id: APInullable[:class:`~pincer.utils.snowflake.Snowflake`]
        Application id of the group DM creator if it is bot-created
    bitrate: APINullable[:class:`int`]
        The bitrate (in bits) of the voice channel
    default_auto_archive_duration: APINullable[:class:`int`]
        Default duration for newly created threads, in minutes, to
        automatically archive the thread after recent activity, can be set to:
        60, 1440, 4320, 10080
    guild_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
        The id of the guild (may be missing for some channel objects received
        over gateway guild dispatches)
    icon: APINullable[Optional[:class:`str`]]
        Icon hash
    last_message_id: APINullable[Optional[:class:`~pincer.utils.snowflake.Snowflake`]]
        The id of the last message sent in this channel (may not point to an
        existing or valid message)
    last_pin_timestamp: APINullable[Optional[:class:`~pincer.utils.timestamp.Timestamp`]]
        When the last pinned message was pinned. This may be null in events
        such as GUILD_CREATE when a message is not pinned.
    member: APINullable[:class:`~pincer.objects.guild.member.GuildMember`]
        Thread member object for the current user, if they have joined the
        thread, only included on certain API endpoints
    member_count: APINullable[:class:`int`]
        An approximate count of users in a thread, stops counting at 50
    message_count: :class:`int`
        An approximate count of messages in a thread, stops counting at 50
    name: APINullable[:class:`str`]
        The name of the channel (1-100 characters)
    nsfw: APINullable[:class:`bool`]
        Whether the channel is nsfw
    owner_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
        Id of the creator of the group DM or thread
    parent_id: APInullable[Optional[:class:`~pincer.utils.snowflake.Snowflake`]]
        For guild channels: id of the parent category for a channel (each
        parent category can contain up to 50 channels), for threads: id of the
        text channel this thread was created
    permissions: APINullable[:class:`str`]
        Computed permissions for the invoking user in the channel, including
        overwrites, only included when part of the resolved data received on a
        slash command interaction
    permission_overwrites: APINullable[List[:class:`~pincer.obects.guild.overwrite.Overwrite`]]
        Explicit permission overwrites for members and roles
    position: APINullable[:class:`int`]
        Sorting position of the channel
    rate_limit_per_user: APINullable[:class:`int`]
        Amount of seconds a user has to wait before sending another message
        (0-21600); bots, as well as users with the permission manage_messages
        or manage_channel, are unaffected
    recipients: APINullable[List[:class:`~pincer.objects.user.user.User`]]
        The recipients of the DM
    rtc_region: APINullable[Optional[:class:`str`]]
        Voice region id for the voice channel, automatic when set to null
    thread_metadata: APINullable[:class:`~pincer.objects.guild.thread.ThreadMetadata`]
        Thread-specific fields not needed by other channels
    topic: APINullable[Optional[:class:`str`]]
        The channel topic (0-1024 characters)
    user_limit: APINullable[:class:`int`]
        The user limit of the voice channel
    video_quality_mode: APINullable[:class:`int`]
        The camera video quality mode of the voice channel, 1 when not present
    """  # noqa: E501
    id: Snowflake
    type: ChannelType

    application_id: APINullable[Snowflake] = MISSING
    bitrate: APINullable[int] = MISSING
    default_auto_archive_duration: APINullable[int] = MISSING
    guild_id: APINullable[Snowflake] = MISSING
    icon: APINullable[Optional[str]] = MISSING

    last_message_id: APINullable[Optional[Snowflake]] = MISSING
    last_pin_timestamp: APINullable[Optional[Timestamp]] = MISSING
    member: APINullable[GuildMember] = MISSING

    member_count: APINullable[int] = MISSING

    message_count: APINullable[int] = MISSING

    name: APINullable[str] = MISSING
    nsfw: APINullable[bool] = MISSING
    owner_id: APINullable[Snowflake] = MISSING
    parent_id: APINullable[Optional[Snowflake]] = MISSING
    permissions: APINullable[str] = MISSING
    permission_overwrites: APINullable[List[Overwrite]] = MISSING
    position: APINullable[int] = MISSING
    rate_limit_per_user: APINullable[int] = MISSING
    recipients: APINullable[List[User]] = MISSING
    rtc_region: APINullable[Optional[str]] = MISSING
    thread_metadata: APINullable[ThreadMetadata] = MISSING
    topic: APINullable[Optional[str]] = MISSING
    user_limit: APINullable[int] = MISSING
    video_quality_mode: APINullable[int] = MISSING

    @property
    def mention(self):

        return f"<#{self.id}>"

    @classmethod
    async def from_id(cls, client: Client, channel_id: int) -> Channel:

        data = (await client.http.get(f"channels/{channel_id}")) or {}
        data.update(
            {
                "_client": client,
                "_http": client.http,
                "type": ChannelType(data.pop("type"))
            }
        )

        channel_cls = _channel_type_map.get(data["type"], Channel)
        return channel_cls.from_dict(data)

    @overload
    async def edit(
            self, *, name: str = None,
            type: ChannelType = None,

            position: int = None, topic: str = None, nsfw: bool = None,
            rate_limit_per_user: int = None, bitrate: int = None,
            user_limit: int = None,
            permissions_overwrites: List[Overwrite] = None,
            parent_id: Snowflake = None, rtc_region: str = None,
            video_quality_mod: int = None,
            default_auto_archive_duration: int = None
    ) -> Channel:
        ...

    async def edit(self, **kwargs):
        """Edit a channel with the given keyword arguments.

        Parameters
        ----------
        \\*\\*kwargs :
            The keyword arguments to edit the channel with.

        Returns
        -------
        :class:`~pincer.objects.guild.channel.Channel`
            The updated channel object.
        """
        data = await self._http.patch(f"channels/{self.id}", kwargs)

        data.update(
            {
                "_client": self._client,

                "_http": self._http,

                "type": ChannelType(data.pop("type"))
            }
        )
        channel_cls = _channel_type_map.get(data["type"], Channel)
        return channel_cls.from_dict(data)


def __str__(self):
    """return the discord tag when object gets used as a string."""
    return self.name or str(self.id)


class TextChannel(Channel):
    """A subclass of ``Channel`` for text channels with all the same attributes.
    """

    def __init__(self, *args, **kwargs):

        super().__init__(*args, **kwargs)

    @overload
    async def edit(

            self, name: str = None, type: ChannelType = None,

            position: int = None, topic: str = None, nsfw: bool = None,
            rate_limit_per_user: int = None,
            permissions_overwrites: List[Overwrite] = None,
            parent_id: Snowflake = None,
            default_auto_archive_duration: int = None
    ) -> Union[TextChannel, NewsChannel]:
        ...

    async def edit(self, **kwargs):
        """Edit a text channel with the given keyword arguments.

        Parameters
        ----------
        \\*\\*kwargs :
            The keyword arguments to edit the channel with.

        Returns
        -------
        :class:`~pincer.objects.guild.channel.Channel`
            The updated channel object.
        """
        return await super().edit(**kwargs)


class VoiceChannel(Channel):
    """A subclass of ``Channel`` for voice channels with all the same attributes.
    """

    def __init__(self, *args, **kwargs):

        super().__init__(*args, **kwargs)

    @overload
    async def edit(

            self, name: str = None, position: int = None, bitrate: int = None,
            user_limit: int = None,
            permissions_overwrites: List[Overwrite] = None,
            rtc_region: str = None, video_quality_mod: int = None
    ) -> VoiceChannel:
        ...

    async def edit(self, **kwargs):
        """Edit a text channel with the given keyword arguments.

        Parameters
        ----------
        \\*\\*kwargs :
            The keyword arguments to edit the channel with.

        Returns
        -------
        :class:`~pincer.objects.guild.channel.Channel`
            The updated channel object.
        """
        return await super().edit(**kwargs)


class CategoryChannel(Channel):
    """A subclass of ``Channel`` for categories channels
    with all the same attributes.
    """

    def __init__(self, *args, **kwargs):

        super().__init__(*args, **kwargs)


class NewsChannel(Channel):
    """A subclass of ``Channel`` for news channels with all the same attributes."""

    def __init__(self, *args, **kwargs):

        super().__init__(*args, **kwargs)

    @overload
    async def edit(

            self, name: str = None, type: ChannelType = None,

            position: int = None, topic: str = None, nsfw: bool = None,
            permissions_overwrites: List[Overwrite] = None,
            parent_id: Snowflake = None,
            default_auto_archive_duration: int = None
    ) -> Union[TextChannel, NewsChannel]:
        ...

    async def edit(self, **kwargs):
        """Edit a text channel with the given keyword arguments.

        Parameters
        ----------
        \\*\\*kwargs :
            The keyword arguments to edit the channel with.

        Returns
        -------
        :class:`~pincer.objects.guild.channel.Channel`
            The updated channel object.
        """
        return await super().edit(**kwargs)


@dataclass
class ChannelMention(APIObject):
    """Represents a Discord Channel Mention object

    Attributes
    ----------
    id: :class:`~pincer.utils.snowflake.Snowflake`
        Id of the channel
    guild_id: :class:`~pincer.utils.snowflake.Snowflake`
        Id of the guild containing the channel
    type: :class:`~pincer.objects.guild.channel.ChannelType`
        The type of channel
    name: :class:`str`
        The name of the channel
    """
    id: Snowflake
    guild_id: Snowflake
    type: ChannelType
    name: str


_channel_type_map: Dict[ChannelType, Channel] = {
    ChannelType.GUILD_TEXT: TextChannel,
    ChannelType.GUILD_VOICE: VoiceChannel,
    ChannelType.GUILD_CATEGORY: CategoryChannel,
    ChannelType.GUILD_NEWS: NewsChannel
}


1			# Copyright Pincer 2021-Present
			0 ignored issues – show introduced 2021-09-06 08:54 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# Full MIT License can be found in `LICENSE` at the project root.
3
4			from __future__ import annotations
5
6			from enum import IntEnum
7			from dataclasses import dataclass
8			from typing import overload, TYPE_CHECKING
9
10			from ...utils.types import MISSING
11			from ..._config import GatewayConfig
12			from ...utils.api_object import APIObject
13
14			if TYPE_CHECKING:
15			from typing import Dict, List, Optional, Union
16
17			from ...client import Client
			0 ignored issues – show introduced 2021-10-21 11:22 UTC by Report Bug Copy Issue Report Cannot import 'client' due to syntax error 'invalid syntax (<unknown>, line 346)' Loading history...
18			from ..user.user import User
19			from .member import GuildMember
20			from .overwrite import Overwrite
21			from .thread import ThreadMetadata
22			from ...utils.types import APINullable
23			from ...utils.snowflake import Snowflake
24			from ...utils.timestamp import Timestamp
			0 ignored issues – show Bug introduced 2021-10-18 18:08 UTC by Report Bug Copy Issue Report The name `timestamp` does not seem to exist in module `pincer.utils`. Loading history... introduced 2021-10-18 18:08 UTC by Report Bug Copy Issue Report Cannot import 'utils.timestamp' due to syntax error 'invalid syntax (<unknown>, line 99)' Loading history...
25
26
27			class ChannelType(IntEnum):
28			"""Represents a channel its type.
29
30			Attributes
31			----------
32			GUILD_TEXT:
33			A text channel.
34			DM:
35			A DM channel.
36			GUILD_VOICE:
37			A voice channel.
38			GROUP_DM:
39			A group DM channel.
40			GUILD_CATEGORY:
41			A category channel.
42			GUILD_NEWS:
43			A news channel.
44			GUILD_STORE:
45			A store channel.
46			GUILD_NEWS_THREAD:
47			A news thread.
48			GUILD_PUBLIC_THREAD:
49			A public thread.
50			GUILD_PRIVATE_THREAD:
51			A private thread.
52			GUILD_STAGE_VOICE:
53			A stage channel.
54			"""
55			GUILD_TEXT = 0
56			DM = 1
57			GUILD_VOICE = 2
58			GROUP_DM = 3
59			GUILD_CATEGORY = 4
60			GUILD_NEWS = 5
61			GUILD_STORE = 6
62
63			if GatewayConfig.version >= 9:
64			GUILD_NEWS_THREAD = 10
65			GUILD_PUBLIC_THREAD = 11
66			GUILD_PRIVATE_THREAD = 12
67
68			GUILD_STAGE_VOICE = 13
69
70
71			@dataclass
			0 ignored issues – show best-practice introduced 2021-09-06 08:54 UTC by Report Bug Copy Issue Report Too many instance attributes (26/7) Loading history...
72			class Channel(APIObject): # noqa E501
73			"""Represents a Discord Channel Mention object
74
75			Attributes
76			----------
77			id: :class:`~pincer.utils.snowflake.Snowflake`
78			The id of this channel
79			type: :class:`~pincer.objects.guild.channel.ChannelType`
80			The type of channel
81			application_id: APInullable[:class:`~pincer.utils.snowflake.Snowflake`]
82			Application id of the group DM creator if it is bot-created
83			bitrate: APINullable[:class:`int`]
84			The bitrate (in bits) of the voice channel
85			default_auto_archive_duration: APINullable[:class:`int`]
86			Default duration for newly created threads, in minutes, to
87			automatically archive the thread after recent activity, can be set to:
88			60, 1440, 4320, 10080
89			guild_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
90			The id of the guild (may be missing for some channel objects received
91			over gateway guild dispatches)
92			icon: APINullable[Optional[:class:`str`]]
93			Icon hash
94			last_message_id: APINullable[Optional[:class:`~pincer.utils.snowflake.Snowflake`]]
95			The id of the last message sent in this channel (may not point to an
96			existing or valid message)
97			last_pin_timestamp: APINullable[Optional[:class:`~pincer.utils.timestamp.Timestamp`]]
98			When the last pinned message was pinned. This may be null in events
99			such as GUILD_CREATE when a message is not pinned.
100			member: APINullable[:class:`~pincer.objects.guild.member.GuildMember`]
101			Thread member object for the current user, if they have joined the
102			thread, only included on certain API endpoints
103			member_count: APINullable[:class:`int`]
104			An approximate count of users in a thread, stops counting at 50
105			message_count: :class:`int`
106			An approximate count of messages in a thread, stops counting at 50
107			name: APINullable[:class:`str`]
108			The name of the channel (1-100 characters)
109			nsfw: APINullable[:class:`bool`]
110			Whether the channel is nsfw
111			owner_id: APINullable[:class:`~pincer.utils.snowflake.Snowflake`]
112			Id of the creator of the group DM or thread
113			parent_id: APInullable[Optional[:class:`~pincer.utils.snowflake.Snowflake`]]
114			For guild channels: id of the parent category for a channel (each
115			parent category can contain up to 50 channels), for threads: id of the
116			text channel this thread was created
117			permissions: APINullable[:class:`str`]
118			Computed permissions for the invoking user in the channel, including
119			overwrites, only included when part of the resolved data received on a
120			slash command interaction
121			permission_overwrites: APINullable[List[:class:`~pincer.obects.guild.overwrite.Overwrite`]]
122			Explicit permission overwrites for members and roles
123			position: APINullable[:class:`int`]
124			Sorting position of the channel
125			rate_limit_per_user: APINullable[:class:`int`]
126			Amount of seconds a user has to wait before sending another message
127			(0-21600); bots, as well as users with the permission manage_messages
128			or manage_channel, are unaffected
129			recipients: APINullable[List[:class:`~pincer.objects.user.user.User`]]
130			The recipients of the DM
131			rtc_region: APINullable[Optional[:class:`str`]]
132			Voice region id for the voice channel, automatic when set to null
133			thread_metadata: APINullable[:class:`~pincer.objects.guild.thread.ThreadMetadata`]
134			Thread-specific fields not needed by other channels
135			topic: APINullable[Optional[:class:`str`]]
136			The channel topic (0-1024 characters)
137			user_limit: APINullable[:class:`int`]
138			The user limit of the voice channel
139			video_quality_mode: APINullable[:class:`int`]
140			The camera video quality mode of the voice channel, 1 when not present
141			""" # noqa: E501
142			id: Snowflake
143			type: ChannelType
144
145			application_id: APINullable[Snowflake] = MISSING
146			bitrate: APINullable[int] = MISSING
147			default_auto_archive_duration: APINullable[int] = MISSING
148			guild_id: APINullable[Snowflake] = MISSING
149			icon: APINullable[Optional[str]] = MISSING
150
151			last_message_id: APINullable[Optional[Snowflake]] = MISSING
152			last_pin_timestamp: APINullable[Optional[Timestamp]] = MISSING
153			member: APINullable[GuildMember] = MISSING
154
155			member_count: APINullable[int] = MISSING
156
157			message_count: APINullable[int] = MISSING
158
159			name: APINullable[str] = MISSING
160			nsfw: APINullable[bool] = MISSING
161			owner_id: APINullable[Snowflake] = MISSING
162			parent_id: APINullable[Optional[Snowflake]] = MISSING
163			permissions: APINullable[str] = MISSING
164			permission_overwrites: APINullable[List[Overwrite]] = MISSING
165			position: APINullable[int] = MISSING
166			rate_limit_per_user: APINullable[int] = MISSING
167			recipients: APINullable[List[User]] = MISSING
168			rtc_region: APINullable[Optional[str]] = MISSING
169			thread_metadata: APINullable[ThreadMetadata] = MISSING
170			topic: APINullable[Optional[str]] = MISSING
171			user_limit: APINullable[int] = MISSING
172			video_quality_mode: APINullable[int] = MISSING
173
174			@property
175			def mention(self):
			0 ignored issues – show introduced 2021-10-03 07:58 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
176			return f"<#{self.id}>"
177
178			@classmethod
179			async def from_id(cls, client: Client, channel_id: int) -> Channel:
			0 ignored issues – show introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
180			data = (await client.http.get(f"channels/{channel_id}")) or {}
181			data.update(
182			{
183			"_client": client,
184			"_http": client.http,
185			"type": ChannelType(data.pop("type"))
186			}
187			)
188
189			channel_cls = _channel_type_map.get(data["type"], Channel)
190			return channel_cls.from_dict(data)
191
192			@overload
193			async def edit(
194			self, *, name: str = None,
195			type: ChannelType = None,
			0 ignored issues – show Bug Best Practice introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `type`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history...
196			position: int = None, topic: str = None, nsfw: bool = None,
197			rate_limit_per_user: int = None, bitrate: int = None,
198			user_limit: int = None,
199			permissions_overwrites: List[Overwrite] = None,
200			parent_id: Snowflake = None, rtc_region: str = None,
201			video_quality_mod: int = None,
202			default_auto_archive_duration: int = None
203			) -> Channel:
204			...
205
206			async def edit(self, **kwargs):
207			"""Edit a channel with the given keyword arguments.
208
209			Parameters
210			----------
211			\\\\kwargs :
212			The keyword arguments to edit the channel with.
213
214			Returns
215			-------
216			:class:`~pincer.objects.guild.channel.Channel`
217			The updated channel object.
218			"""
219			data = await self._http.patch(f"channels/{self.id}", kwargs)
			0 ignored issues – show Bug introduced 2021-10-14 09:19 UTC by Report Bug Copy Issue Report The Instance of `Channel` does not seem to have a member named `_http`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
220			data.update(
221			{
222			"_client": self._client,
			0 ignored issues – show Bug introduced 2021-10-14 09:19 UTC by Report Bug Copy Issue Report The Instance of `Channel` does not seem to have a member named `_client`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
223			"_http": self._http,
			0 ignored issues – show Bug introduced 2021-10-14 09:19 UTC by Report Bug Copy Issue Report The Instance of `Channel` does not seem to have a member named `_http`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
224			"type": ChannelType(data.pop("type"))
225			}
226			)
227			channel_cls = _channel_type_map.get(data["type"], Channel)
228			return channel_cls.from_dict(data)
229
230
231			def __str__(self):
232			"""return the discord tag when object gets used as a string."""
233			return self.name or str(self.id)
234
235
236			class TextChannel(Channel):
237			"""A subclass of ``Channel`` for text channels with all the same attributes.
238			"""
239
240			def __init__(self, args, *kwargs):
			0 ignored issues – show introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Useless super delegation in method '__init__' Loading history...
241			super().__init__(args, *kwargs)
242
243			@overload
244			async def edit(
			0 ignored issues – show best-practice introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Too many arguments (10/5) Loading history... Bug introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Parameters differ from overridden 'edit' method Loading history...
245			self, name: str = None, type: ChannelType = None,
			0 ignored issues – show Bug Best Practice introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `type`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history...
246			position: int = None, topic: str = None, nsfw: bool = None,
247			rate_limit_per_user: int = None,
248			permissions_overwrites: List[Overwrite] = None,
249			parent_id: Snowflake = None,
250			default_auto_archive_duration: int = None
251			) -> Union[TextChannel, NewsChannel]:
252			...
253
254			async def edit(self, **kwargs):
255			"""Edit a text channel with the given keyword arguments.
256
257			Parameters
258			----------
259			\\\\kwargs :
260			The keyword arguments to edit the channel with.
261
262			Returns
263			-------
264			:class:`~pincer.objects.guild.channel.Channel`
265			The updated channel object.
266			"""
267			return await super().edit(**kwargs)
268
269
270			class VoiceChannel(Channel):
271			"""A subclass of ``Channel`` for voice channels with all the same attributes.
272			"""
273
274			def __init__(self, args, *kwargs):
			0 ignored issues – show introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Useless super delegation in method '__init__' Loading history...
275			super().__init__(args, *kwargs)
276
277			@overload
278			async def edit(
			0 ignored issues – show best-practice introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Too many arguments (8/5) Loading history... Bug introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Parameters differ from overridden 'edit' method Loading history...
279			self, name: str = None, position: int = None, bitrate: int = None,
280			user_limit: int = None,
281			permissions_overwrites: List[Overwrite] = None,
282			rtc_region: str = None, video_quality_mod: int = None
283			) -> VoiceChannel:
284			...
285
286			async def edit(self, **kwargs):
287			"""Edit a text channel with the given keyword arguments.
288
289			Parameters
290			----------
291			\\\\kwargs :
292			The keyword arguments to edit the channel with.
293
294			Returns
295			-------
296			:class:`~pincer.objects.guild.channel.Channel`
297			The updated channel object.
298			"""
299			return await super().edit(**kwargs)
300
301
302			class CategoryChannel(Channel):
303			"""A subclass of ``Channel`` for categories channels
304			with all the same attributes.
305			"""
306
307			def __init__(self, args, *kwargs):
			0 ignored issues – show introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Useless super delegation in method '__init__' Loading history...
308			super().__init__(args, *kwargs)
309
310
311			class NewsChannel(Channel):
312			"""A subclass of ``Channel`` for news channels with all the same attributes."""
313
314			def __init__(self, args, *kwargs):
			0 ignored issues – show introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Useless super delegation in method '__init__' Loading history...
315			super().__init__(args, *kwargs)
316
317			@overload
318			async def edit(
			0 ignored issues – show best-practice introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Too many arguments (9/5) Loading history... Bug introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report Parameters differ from overridden 'edit' method Loading history...
319			self, name: str = None, type: ChannelType = None,
			0 ignored issues – show Bug Best Practice introduced 2021-10-04 03:03 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `type`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history...
320			position: int = None, topic: str = None, nsfw: bool = None,
321			permissions_overwrites: List[Overwrite] = None,
322			parent_id: Snowflake = None,
323			default_auto_archive_duration: int = None
324			) -> Union[TextChannel, NewsChannel]:
325			...
326
327			async def edit(self, **kwargs):
328			"""Edit a text channel with the given keyword arguments.
329
330			Parameters
331			----------
332			\\\\kwargs :
333			The keyword arguments to edit the channel with.
334
335			Returns
336			-------
337			:class:`~pincer.objects.guild.channel.Channel`
338			The updated channel object.
339			"""
340			return await super().edit(**kwargs)
341
342
343			@dataclass
344			class ChannelMention(APIObject):
345			"""Represents a Discord Channel Mention object
346
347			Attributes
348			----------
349			id: :class:`~pincer.utils.snowflake.Snowflake`
350			Id of the channel
351			guild_id: :class:`~pincer.utils.snowflake.Snowflake`
352			Id of the guild containing the channel
353			type: :class:`~pincer.objects.guild.channel.ChannelType`
354			The type of channel
355			name: :class:`str`
356			The name of the channel
357			"""
358			id: Snowflake
359			guild_id: Snowflake
360			type: ChannelType
361			name: str
362
363
364			_channel_type_map: Dict[ChannelType, Channel] = {
365			ChannelType.GUILD_TEXT: TextChannel,
366			ChannelType.GUILD_VOICE: VoiceChannel,
367			ChannelType.GUILD_CATEGORY: CategoryChannel,
368			ChannelType.GUILD_NEWS: NewsChannel
369			}
370

Pincer-org / Pincer

Pull Request — main (#155)

pincer.objects.guild.channel.TextChannel.mention() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like