pincer.objects.guild

Complexity

Total Complexity

2

Size/Duplication

Total Lines	282
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	Guild.from_dict()	0	17	2

# -*- 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 typing import Optional, List

from pincer.exceptions import UnavailableGuildError
from pincer.objects.channel import Channel
from pincer.objects.emoji import Emoji
from pincer.objects.guild_member import GuildMember
from pincer.objects.role import Role
from pincer.objects.stage import StageInstance
from pincer.objects.sticker import Sticker
from pincer.objects.welcome_screen import WelcomeScreen
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)'

@dataclass

Too many instance attributes (50/7)

class Guild(APIObject):
    """
    Represents a Discord guild/server in which your client resides.

    :param afk_channel_id:
        id of afk channel

    :param afk_timeout:
        afk timeout in seconds

    :param application_id:
        application id of the guild creator if it is bot-created

    :param banner:
        banner hash

    :param default_message_notifications:
        default message notifications level

    :param description:
        the description of a Community guild

    :param discovery_splash:
        discovery splash hash; only present for guilds with the "DISCOVERABLE"
        feature

    :param emojis:
        custom guild emojis

    :param explicit_content_filter:
        explicit content filter level

    :param features:
        enabled guild features

    :param id:
        guild id

    :param icon:
        icon hash

    :param mfa_level:
        required MFA level for the guild

    :param name:
        guild name (2-100 characters, excluding trailing and leading
        whitespace)

    :param nsfw_level:
        guild NSFW level

    :param owner_id:
        id of owner

    :param preferred_locale:
        the preferred locale of a Community guild; used in server discovery and
        notices from Discord; defaults to "en-US"

    :param premium_tier:
        premium tier (Server Boost level)

    :param public_updates_channel_id:
        the id of the channel where admins and moderators of Community guilds
        receive notices from Discord

    :param roles:
        roles in the guild

    :param rules_channel_id:
        the id of the channel where Community guilds can display rules and/or
        guidelines

    :param splash:
        splash hash

    :param system_channel_flags:
        system channel flags

    :param system_channel_id:
        the id of the channel where guild notices such as welcome messages and
        boost events are posted

    :param vanity_url_code:
        the vanity url code for the guild

    :param verification_level:
        verification level required for the guild

    :param approximate_member_count:
        approximate number of members in this guild, returned from the
        `GET /guilds/<id>` endpoint when with_counts is true

    :param approximate_presence_count:
        approximate number of non-offline members in this guild, returned from
        the `GET /guilds/<id>` endpoint when with_counts is true

    :param channels:
        channels in the guild

    :param icon_hash:
        icon hash, returned when in the template object

    :param joined_at:
        when this guild was joined at

    :param large:
        true if this is considered a large guild

    :param max_members:
        the maximum number of members for the guild

    :param max_presences:
        the maximum number of presences for the guild (null is always returned,
        apart from the largest of guilds)

    :param max_video_channel_users:
        the maximum amount of users in a video channel

    :param members:
        users in the guild

    :param member_count:
        total number of members in this guild

    :param owner:
        true if the user is the owner of the guild

    :param permissions:
        total permissions for the user in the guild (excludes overwrites)

    :param premium_subscription_count:
        the number of boosts this guild currently has

    :param presences:
        presences of the members in the guild, will only include non-offline
        members if the size is greater than large threshold

    :param stage_instances:
        Stage instances in the guild

    :param stickers:
        custom guild stickers

    :param region:
        voice region id for the guild (deprecated)

    :param threads:
        all active threads in the guild that current user has permission to
        view

    :param unavailable:
        true if this guild is unavailable due to an outage

    :param voice_states:
        states of members currently in voice channels; lacks the guild_id key

    :param widget_enabled:
        true if the server widget is enabled

    :param widget_channel_id:
        the channel id that the widget will generate an invite to, or null if
        set to no invite

    :param welcome_screen:
        the welcome screen of a Community guild, shown to new members, returned
        in an Invite's guild object
    """

    afk_channel_id: Optional[Snowflake]
    afk_timeout: int
    application_id: Optional[int]
    banner: Optional[str]
    default_message_notifications: int
    description: Optional[str]
    discovery_splash: Optional[str]
    emojis: List[Emoji]
    explicit_content_filter: int
    features: List[...]
    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)

    icon: Optional[str]
    mfa_level: int
    name: str
    nsfw_level: int
    owner_id: Snowflake
    preferred_locale: str
    premium_tier: int
    public_updates_channel_id: Optional[Snowflake]
    roles: List[Role]
    rules_channel_id: Optional[int]
    splash: Optional[str]
    system_channel_flags: int
    system_channel_id: Optional[int]
    vanity_url_code: Optional[str]
    verification_level: int

    approximate_member_count: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    approximate_presence_count: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    channels: APINullable[List[Channel]] = MISSING

Value 'APINullable' is unsubscriptable

    icon_hash: APINullable[Optional[str]] = MISSING

Value 'APINullable' is unsubscriptable

    joined_at: APINullable[Timestamp] = MISSING

Value 'APINullable' is unsubscriptable

    large: APINullable[bool] = MISSING

Value 'APINullable' is unsubscriptable

    max_members: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    max_presences: APINullable[Optional[int]] = MISSING

Value 'APINullable' is unsubscriptable

    max_video_channel_users: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

    members: APINullable[List[GuildMember]] = MISSING

Value 'APINullable' is unsubscriptable

    member_count: APINullable[bool] = MISSING

Value 'APINullable' is unsubscriptable

    owner: APINullable[bool] = MISSING

Value 'APINullable' is unsubscriptable

    permissions: APINullable[str] = MISSING

Value 'APINullable' is unsubscriptable

    premium_subscription_count: APINullable[int] = MISSING

Value 'APINullable' is unsubscriptable

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

Value 'APINullable' is unsubscriptable

    stage_instances: APINullable[List[StageInstance]] = MISSING

Value 'APINullable' is unsubscriptable

    stickers: APINullable[List[Sticker]] = MISSING

Value 'APINullable' is unsubscriptable

    region: APINullable[Optional[str]] = MISSING

Value 'APINullable' is unsubscriptable

    threads: APINullable[List[Channel]] = MISSING

Value 'APINullable' is unsubscriptable

    # Guilds are considered available unless otherwise specified
    unavailable: APINullable[bool] = False

Value 'APINullable' is unsubscriptable

    voice_states: APINullable[bool] = MISSING

Value 'APINullable' is unsubscriptable

    widget_enabled: APINullable[bool] = MISSING

Value 'APINullable' is unsubscriptable

    widget_channel_id: APINullable[Optional[Snowflake]] = MISSING

Value 'APINullable' is unsubscriptable

    welcome_screen: APINullable[WelcomeScreen] = MISSING

Value 'APINullable' is unsubscriptable

    @classmethod
    def from_dict(cls, data) -> Guild:
        """
        Instantiate a new guild from a dictionary.

        Also handles it if the guild isn't available.

        :raises UnavailableGuildError:
            Exception gets raised when guild is unavailable.
        """
        if data.get("unavailable", False):
            raise UnavailableGuildError(
                f"Guild \"{data['id']}\" is unavailable due"
                " to a discord outage."
            )

        return cls.from_dict(data)