pincer.objects.guild.stage

Complexity

Total Complexity

2

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	StageInstance.from_id()	0	3	1
A	StageInstance.modify()	0	21	1

# Copyright Pincer 2021-Present

Missing module docstring

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

from __future__ import annotations

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

from ...utils.api_object import APIObject, ChannelProperty, GuildProperty

if TYPE_CHECKING:
    from ...client import Client
    from ...utils.snowflake import Snowflake


class PrivacyLevel(IntEnum):
    """Represents the level of publicity of a stage.

    Attributes
    ----------
    PUBLIC:
        The stage is public.
    GUILD_ONLY:
        The stage of for guild members only.
    """

    PUBLIC = 1
    GUILD_ONLY = 2


@dataclass(repr=False)
class StageInstance(APIObject, ChannelProperty, GuildProperty):
    """Represents a Stage Instance object

    Attributes
    ----------
    id: :class:`~pincer.utils.snowflake.Snowflake`
        Id of this Stage instance
    guild_id: :class:`~pincer.utils.snowflake.Snowflake`
        Guild id of the associated Stage channel
    channel_id: :class:`~pincer.utils.snowflake.Snowflake`
        Id of the associated Stage channel
    topic: :class:`str`
        Topic of the Stage instance (1-120 characters)
    privacy_level: :class:`~pincer.objects.guild.stage.PrivacyLevel`
        Privacy level of the Stage instance
    discoverable: :class:`bool`
        Is Stage Discovery enabled
    """

    id: Snowflake
    guild_id: Snowflake
    channel_id: Snowflake
    topic: str
    privacy_level: PrivacyLevel
    discoverable: bool

    @classmethod
    async def from_id(cls, client: Client, _id: int) -> StageInstance:

Missing function or method docstring

        return client.http.get(f"stage-instance/{_id}")

    async def modify(
        self,

Wrong hanging indentation before block (add 4 spaces).

        topic: Optional[str] = None,

Wrong hanging indentation before block (add 4 spaces).

        privacy_level: Optional[PrivacyLevel] = None,

Wrong hanging indentation before block (add 4 spaces).

        reason: Optional[str] = None,

Wrong hanging indentation before block (add 4 spaces).

    ):
        """|coro|
        Updates fields of an existing Stage instance.
        Requires the user to be a moderator of the Stage channel.

        Parameters
        ----------
        topic : Optional[:class:`str`]
            The topic of the Stage instance (1-120 characters)
        privacy_level : Optional[:class:`~pincer.objects.guild.stage.PrivacyLevel`]
            The privacy level of the Stage instance
        reason : Optional[:class:`str`]
            The reason for the modification
        """

        await self._client.modify_stage(self.id, topic, privacy_level, reason)