|
|
|
@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE. |
|
|
|
|
|
|
|
from __future__ import annotations |
|
|
|
|
|
|
|
from typing import Optional, TYPE_CHECKING |
|
|
|
from typing import List, Optional, TYPE_CHECKING |
|
|
|
|
|
|
|
from .utils import MISSING, cached_slot_property, _get_as_snowflake |
|
|
|
from .mixins import Hashable |
|
|
|
@ -37,11 +37,15 @@ __all__ = ( |
|
|
|
# fmt: on |
|
|
|
|
|
|
|
if TYPE_CHECKING: |
|
|
|
from .types.channel import StageInstance as StageInstancePayload |
|
|
|
from typing_extensions import Self |
|
|
|
|
|
|
|
from .types.channel import StageInstance as StageInstancePayload, InviteStageInstance as InviteStageInstancePayload |
|
|
|
from .state import ConnectionState |
|
|
|
from .channel import StageChannel |
|
|
|
from .guild import Guild |
|
|
|
from .scheduled_event import ScheduledEvent |
|
|
|
from .invite import Invite |
|
|
|
from .member import Member |
|
|
|
|
|
|
|
|
|
|
|
class StageInstance(Hashable): |
|
|
|
@ -77,8 +81,12 @@ class StageInstance(Hashable): |
|
|
|
The privacy level of the stage instance. |
|
|
|
discoverable_disabled: :class:`bool` |
|
|
|
Whether discoverability for the stage instance is disabled. |
|
|
|
invite_code: Optional[:class:`str`] |
|
|
|
The invite code of the stage instance, if public. |
|
|
|
|
|
|
|
.. versionadded:: 2.1 |
|
|
|
scheduled_event_id: Optional[:class:`int`] |
|
|
|
The ID of scheduled event that belongs to the stage instance if any. |
|
|
|
The ID of the scheduled event that belongs to the stage instance, if any. |
|
|
|
|
|
|
|
.. versionadded:: 2.0 |
|
|
|
""" |
|
|
|
@ -91,44 +99,104 @@ class StageInstance(Hashable): |
|
|
|
'topic', |
|
|
|
'privacy_level', |
|
|
|
'discoverable_disabled', |
|
|
|
'invite_code', |
|
|
|
'scheduled_event_id', |
|
|
|
'_cs_channel', |
|
|
|
'_cs_scheduled_event', |
|
|
|
'_members', |
|
|
|
'_participant_count', |
|
|
|
) |
|
|
|
|
|
|
|
def __init__(self, *, state: ConnectionState, guild: Guild, data: StageInstancePayload) -> None: |
|
|
|
self._state: ConnectionState = state |
|
|
|
self.guild: Guild = guild |
|
|
|
self._members: Optional[List[Member]] = None |
|
|
|
self._participant_count: Optional[int] = None |
|
|
|
self._update(data) |
|
|
|
|
|
|
|
def _update(self, data: StageInstancePayload) -> None: |
|
|
|
def _update(self, data: StageInstancePayload, /) -> None: |
|
|
|
self.id: int = int(data['id']) |
|
|
|
self.channel_id: int = int(data['channel_id']) |
|
|
|
self.topic: str = data['topic'] |
|
|
|
self.privacy_level: PrivacyLevel = try_enum(PrivacyLevel, data['privacy_level']) |
|
|
|
self.discoverable_disabled: bool = data.get('discoverable_disabled', False) |
|
|
|
self.invite_code: Optional[str] = data.get('invite_code') |
|
|
|
self.scheduled_event_id: Optional[int] = _get_as_snowflake(data, 'guild_scheduled_event_id') |
|
|
|
|
|
|
|
@staticmethod |
|
|
|
def _resolve_stage_instance_id(invite: Invite) -> int: |
|
|
|
try: |
|
|
|
return invite.channel.instance.id # type: ignore |
|
|
|
except AttributeError: |
|
|
|
# This is a lie, but it doesn't matter |
|
|
|
return invite.channel.id # type: ignore |
|
|
|
|
|
|
|
@classmethod |
|
|
|
def from_invite(cls, invite: Invite, data: InviteStageInstancePayload, /) -> Self: |
|
|
|
state = invite._state |
|
|
|
payload: StageInstancePayload = { |
|
|
|
'id': cls._resolve_stage_instance_id(invite), |
|
|
|
'guild_id': invite.guild.id, # type: ignore # Will always be defined |
|
|
|
'channel_id': invite.channel.id, # type: ignore # Will always be defined |
|
|
|
'topic': data['topic'], |
|
|
|
'privacy_level': PrivacyLevel.public.value, |
|
|
|
'discoverable_disabled': False, |
|
|
|
'invite_code': invite.code, |
|
|
|
'guild_scheduled_event_id': invite.scheduled_event.id if invite.scheduled_event else None, |
|
|
|
} |
|
|
|
self = cls(state=state, guild=invite.guild, data=payload) # type: ignore # Guild may be wrong type |
|
|
|
self._members = [Member(data=mdata, state=state, guild=invite.guild) for mdata in data['members']] # type: ignore # Guild may be wrong type |
|
|
|
self._participant_count = data.get('participant_count', len(self._members)) |
|
|
|
return self |
|
|
|
|
|
|
|
def __repr__(self) -> str: |
|
|
|
return f'<StageInstance id={self.id} guild={self.guild!r} channel_id={self.channel_id} topic={self.topic!r}>' |
|
|
|
|
|
|
|
@property |
|
|
|
def invite_url(self) -> Optional[str]: |
|
|
|
"""Optional[:class:`str`]: The stage instance's invite URL, if public. |
|
|
|
|
|
|
|
.. versionadded:: 2.1 |
|
|
|
""" |
|
|
|
if self.invite_code is None: |
|
|
|
return None |
|
|
|
return f'https://discord.gg/{self.invite_code}' |
|
|
|
|
|
|
|
@property |
|
|
|
def discoverable(self) -> bool: |
|
|
|
""":class:`bool`: Whether the stage instance is discoverable.""" |
|
|
|
return not self.discoverable_disabled |
|
|
|
|
|
|
|
@cached_slot_property('_cs_channel') |
|
|
|
@property |
|
|
|
def channel(self) -> Optional[StageChannel]: |
|
|
|
"""Optional[:class:`StageChannel`]: The channel that stage instance is running in.""" |
|
|
|
# The returned channel will always be a StageChannel or None |
|
|
|
return self._state.get_channel(self.channel_id) # type: ignore |
|
|
|
return self.guild._resolve_channel(self.channel_id) # type: ignore |
|
|
|
|
|
|
|
@cached_slot_property('_cs_scheduled_event') |
|
|
|
@property |
|
|
|
def scheduled_event(self) -> Optional[ScheduledEvent]: |
|
|
|
"""Optional[:class:`ScheduledEvent`]: The scheduled event that belongs to the stage instance.""" |
|
|
|
# Guild.get_scheduled_event() expects an int, we are passing Optional[int] |
|
|
|
return self.guild.get_scheduled_event(self.scheduled_event_id) # type: ignore |
|
|
|
|
|
|
|
@property |
|
|
|
def speakers(self) -> List[Member]: |
|
|
|
"""List[:class:`Member`]: The members that are speaking in the stage instance. |
|
|
|
|
|
|
|
.. versionadded:: 2.1 |
|
|
|
""" |
|
|
|
if self._members is not None or self.channel is None: |
|
|
|
return self._members or [] |
|
|
|
return self.channel.speakers |
|
|
|
|
|
|
|
@property |
|
|
|
def participant_count(self) -> int: |
|
|
|
""":class:`int`: The number of participants in the stage instance. |
|
|
|
|
|
|
|
.. versionadded:: 2.1 |
|
|
|
""" |
|
|
|
if self._participant_count is not None or self.channel is None: |
|
|
|
return self._participant_count or 0 |
|
|
|
return len(self.channel.voice_states) |
|
|
|
|
|
|
|
async def edit( |
|
|
|
self, |
|
|
|
*, |
|
|
|
@ -161,10 +229,8 @@ class StageInstance(Hashable): |
|
|
|
Editing a stage instance failed. |
|
|
|
""" |
|
|
|
payload = {} |
|
|
|
|
|
|
|
if topic is not MISSING: |
|
|
|
payload['topic'] = topic |
|
|
|
|
|
|
|
if privacy_level is not MISSING: |
|
|
|
if not isinstance(privacy_level, PrivacyLevel): |
|
|
|
raise TypeError('privacy_level field must be of type PrivacyLevel') |
|
|
|
|
dolfies
2 years ago