pincer.objects.channel

Complexity

Total Complexity

1

Size/Duplication

Total Lines	208
Duplicated Lines	0 %

Importance

Changes

0

1 Function

Rating	Name	Duplication	Size	Complexity
A	__str__()	0	3	1

# -*- coding: utf-8 -*-

Missing module docstring

# MIT License

#

# Copyright (c) 2021 Pincer

#

# Permission is hereby granted, free of charge, to any person obtaining

# a copy of this software and associated documentation files

# (the "Software"), to deal in the Software without restriction,

# including without limitation the rights to use, copy, modify, merge,

# publish, distribute, sublicense, and/or sell copies of the Software,

# and to permit persons to whom the Software is furnished to do so,

# subject to the following conditions:

#

# The above copyright notice and this permission notice shall be

# included in all copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

from __future__ import annotations


from dataclasses import dataclass

from enum import Enum

from typing import Optional, List


from pincer._config import GatewayConfig

from pincer.objects.guild_member import GuildMember

from pincer.objects.user import User

from pincer.objects.thread import ThreadMetadata

from pincer.utils.api_object import APIObject

from pincer.utils.constants import APINullable, MISSING

from pincer.utils.snowflake import Snowflake

from pincer.utils.timestamp import Timestamp

The name timestamp does not seem to exist in module pincer.utils.

Cannot import 'pincer.utils.timestamp' due to syntax error 'invalid syntax (<unknown>, line 91)'

class ChannelType(Enum):

    """Represents a channel its type."""

    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

Too many instance attributes (26/7)

class Channel(APIObject):

    """

    Represents a Discord Channel Mention object


    :param id:

        the id of this channel


    :param type:

        the type of channel


    :param application_id:

        application id of the group DM creator if it is bot-created


    :param bitrate:

        the bitrate (in bits) of the voice channel


    :param default_auto_archive_duration:

        default duration for newly created threads, in minutes, to

        automatically archive the thread after recent activity, can be set to:

        60, 1440, 4320, 10080


    :param guild_id:

        the id of the guild (may be missing for some channel objects received

        over gateway guild dispatches)


    :param icon:

        icon hash

    :param last_message_id:

        the id of the last message sent in this channel (may not point to an

        existing or valid message)


    :param last_pin_timestamp:

        when the last pinned message was pinned. This may be null in events

        such as GUILD_CREATE when a message is not pinned.


    :param member:

        thread member object for the current user, if they have joined the

        thread, only included on certain API endpoints


    :param member_count:

        an approximate count of users in a thread, stops counting at 50


    :param message_count:

        an approximate count of messages in a thread, stops counting at 50


    :param name:

        the name of the channel (1-100 characters)


    :param nsfw:

        whether the channel is nsfw


    :param owner_id:

        id of the creator of the group DM or thread


    :param parent_id:

        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


    :param permissions:

        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


    :param permission_overwrites:

        explicit permission overwrites for members and roles


    :param position:

        sorting position of the channel


    :param rate_limit_per_user:

        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


    :param recipients:

        the recipients of the DM


    :param rtc_region:

        voice region id for the voice channel, automatic when set to null


    :param thread_metadata:

        thread-specific fields not needed by other channels


    :param topic:

        the channel topic (0-1024 characters)


    :param user_limit:

        the user limit of the voice channel


    :param video_quality_mode:

        the camera video quality mode of the voice channel, 1 when not present

    """


    id: Snowflake

Attribute name "id" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

    type: ChannelType


    application_id: APINullable[Snowflake] = MISSING

Value 'APINullable' is unsubscriptable

    bitrate: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    default_auto_archive_duration: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    guild_id: APINullable[Snowflake] = MISSING

Value 'APINullable' is unsubscriptable

    icon: APINullable[Optional[str]] = MISSING

Value 'APINullable' is unsubscriptable

    last_message_id: APINullable[Optional[Snowflake]] = MISSING

Value 'APINullable' is unsubscriptable

    last_pin_timestamp: APINullable[Optional[Timestamp]] = MISSING

Value 'APINullable' is unsubscriptable

    member: APINullable[GuildMember] = MISSING

Value 'APINullable' is unsubscriptable

    member_count: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    message_count: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    name: APINullable[str] = MISSING

Value 'APINullable' is unsubscriptable

    nsfw: APINullable[bool] = MISSING

Value 'APINullable' is unsubscriptable

    owner_id: APINullable[Snowflake] = MISSING

Value 'APINullable' is unsubscriptable

    parent_id: APINullable[Optional[Snowflake]] = MISSING

Value 'APINullable' is unsubscriptable

    permissions: APINullable[str] = MISSING

Value 'APINullable' is unsubscriptable

    permission_overwrites: APINullable[List[...]] = MISSING

Value 'APINullable' is unsubscriptable

    position: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    rate_limit_per_user: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    recipients: APINullable[List[User]] = MISSING

Value 'APINullable' is unsubscriptable

    rtc_region: APINullable[Optional[str]] = MISSING

Value 'APINullable' is unsubscriptable

    thread_metadata: APINullable[ThreadMetadata] = MISSING

Value 'APINullable' is unsubscriptable

    topic: APINullable[Optional[str]] = MISSING

Value 'APINullable' is unsubscriptable

    user_limit: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    video_quality_mode: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

def __str__(self):

    """return the discord tag when object gets used as a string."""

    return self.name or str(self.id)



@dataclass

class ChannelMention(APIObject):

    """

    Represents a Discord Channel Mention object


    :param id:

        id of the channel


    :param guild_id:

        id of the guild containing the channel


    :param type:

        the type of channel


    :param name:

        the name of the channel

    """

    id: Snowflake

Attribute name "id" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

    guild_id: Snowflake

    type: ChannelType

    name: str