Nadir Chowdhury
4 years ago
committed by
GitHub
GitHub
10 changed files with 502 additions and 15 deletions
@ -0,0 +1,168 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
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 typing import Optional, TYPE_CHECKING |
|||
|
|||
from .utils import MISSING, cached_slot_property |
|||
from .mixins import Hashable |
|||
from .errors import InvalidArgument |
|||
from .enums import StagePrivacyLevel, try_enum |
|||
|
|||
__all__ = ( |
|||
'StageInstance', |
|||
) |
|||
|
|||
if TYPE_CHECKING: |
|||
from .types.channel import StageInstance as StageInstancePayload |
|||
from .state import ConnectionState |
|||
from .channel import StageChannel |
|||
from .guild import Guild |
|||
|
|||
|
|||
class StageInstance(Hashable): |
|||
"""Represents a stage instance of a stage channel in a guild. |
|||
|
|||
.. versionadded:: 2.0 |
|||
|
|||
.. container:: operations |
|||
|
|||
.. describe:: x == y |
|||
|
|||
Checks if two stagea instances are equal. |
|||
|
|||
.. describe:: x != y |
|||
|
|||
Checks if two stage instances are not equal. |
|||
|
|||
.. describe:: hash(x) |
|||
|
|||
Returns the stage instance's hash. |
|||
|
|||
Attributes |
|||
----------- |
|||
id: :class:`int` |
|||
The stage instance's ID. |
|||
guild: :class:`Guild` |
|||
The guild that the stage instance is running in. |
|||
channel_id: :class:`int` |
|||
The ID of the channel that the stage instance is running in. |
|||
topic: :class:`str` |
|||
The topic of the stage instance. |
|||
privacy_level: :class:`StagePrivacyLevel` |
|||
The privacy level of the stage instance. |
|||
discoverable_disabled: :class:`bool` |
|||
Whether the stage instance is discoverable. |
|||
""" |
|||
|
|||
__slots__ = ( |
|||
'_state', |
|||
'id', |
|||
'guild', |
|||
'channel_id', |
|||
'topic', |
|||
'privacy_level', |
|||
'discoverable_disabled', |
|||
'_cs_channel', |
|||
) |
|||
|
|||
def __init__(self, *, state: ConnectionState, guild: Guild, data: StageInstancePayload) -> None: |
|||
self._state = state |
|||
self.guild = guild |
|||
self._update(data) |
|||
|
|||
def _update(self, data: StageInstancePayload): |
|||
self.id: int = int(data['id']) |
|||
self.channel_id: int = int(data['channel_id']) |
|||
self.topic: str = data['topic'] |
|||
self.privacy_level = try_enum(StagePrivacyLevel, data['privacy_level']) |
|||
self.discoverable_disabled = data['discoverable_disabled'] |
|||
|
|||
def __repr__(self) -> str: |
|||
return f'<StageInstance id={self.id} guild={self.guild!r} channel_id={self.channel_id} topic={self.topic!r}>' |
|||
|
|||
@cached_slot_property('_cs_channel') |
|||
def channel(self) -> Optional[StageChannel]: |
|||
"""Optional[:class:`StageChannel`: The guild that stage instance is running in.""" |
|||
return self._state.get_channel(self.channel_id) |
|||
|
|||
def is_public(self) -> bool: |
|||
return self.privacy_level is StagePrivacyLevel.public |
|||
|
|||
async def edit(self, *, topic: str = MISSING, privacy_level: StagePrivacyLevel = MISSING) -> None: |
|||
"""|coro| |
|||
|
|||
Edits the stage instance. |
|||
|
|||
You must have the :attr:`~Permissions.manage_channels` permission to |
|||
use this. |
|||
|
|||
Parameters |
|||
----------- |
|||
topic: :class:`str` |
|||
The stage instance's new topic. |
|||
privacy_level: :class:`StagePrivacyLevel` |
|||
The stage instance's new privacy level. |
|||
|
|||
Raises |
|||
------ |
|||
InvalidArgument |
|||
If the ``privacy_level`` parameter is not the proper type. |
|||
Forbidden |
|||
You do not have permissions to edit the stage instance. |
|||
HTTPException |
|||
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, StagePrivacyLevel): |
|||
raise InvalidArgument('privacy_level field must be of type PrivacyLevel') |
|||
|
|||
payload['privacy_level'] = privacy_level.value |
|||
|
|||
if payload: |
|||
await self._state.http.edit_stage_instance(self.channel_id, **payload) |
|||
|
|||
async def delete(self) -> None: |
|||
"""|coro| |
|||
|
|||
Deletes the stage instance. |
|||
|
|||
You must have the :attr:`~Permissions.manage_channels` permission to |
|||
use this. |
|||
|
|||
Raises |
|||
------ |
|||
Forbidden |
|||
You do not have permissions to delete the stage instance. |
|||
HTTPException |
|||
Deleting the stage instance failed. |
|||
""" |
|||
await self._state.http.delete_stage_instance(self.channel_id) |
|||
Loading…
Reference in new issue