1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
|
"""
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 TYPE_CHECKING, Optional
from . import utils
from .mixins import Hashable
from .partial_emoji import PartialEmoji, _EmojiTag
from .user import User
from .utils import MISSING
from .asset import Asset, AssetMixin
if TYPE_CHECKING:
import datetime
from typing import Dict, Any
from .types.soundboard import (
BaseSoundboardSound as BaseSoundboardSoundPayload,
SoundboardDefaultSound as SoundboardDefaultSoundPayload,
SoundboardSound as SoundboardSoundPayload,
)
from .state import ConnectionState
from .guild import Guild
from .message import EmojiInputType
__all__ = ('BaseSoundboardSound', 'SoundboardDefaultSound', 'SoundboardSound')
class BaseSoundboardSound(Hashable, AssetMixin):
"""Represents a generic Discord soundboard sound.
.. versionadded:: 2.5
.. container:: operations
.. describe:: x == y
Checks if two sounds are equal.
.. describe:: x != y
Checks if two sounds are not equal.
.. describe:: hash(x)
Returns the sound's hash.
Attributes
------------
id: :class:`int`
The ID of the sound.
volume: :class:`float`
The volume of the sound as floating point percentage (e.g. ``1.0`` for 100%).
"""
__slots__ = ('_state', 'id', 'volume')
def __init__(self, *, state: ConnectionState, data: BaseSoundboardSoundPayload):
self._state: ConnectionState = state
self.id: int = int(data['sound_id'])
self._update(data)
def __eq__(self, other: object) -> bool:
if isinstance(other, self.__class__):
return self.id == other.id
return NotImplemented
def __ne__(self, other: object) -> bool:
return not self.__eq__(other)
def _update(self, data: BaseSoundboardSoundPayload):
self.volume: float = data['volume']
@property
def url(self) -> str:
""":class:`str`: Returns the URL of the sound."""
return f'{Asset.BASE}/soundboard-sounds/{self.id}'
class SoundboardDefaultSound(BaseSoundboardSound):
"""Represents a Discord soundboard default sound.
.. versionadded:: 2.5
.. container:: operations
.. describe:: x == y
Checks if two sounds are equal.
.. describe:: x != y
Checks if two sounds are not equal.
.. describe:: hash(x)
Returns the sound's hash.
Attributes
------------
id: :class:`int`
The ID of the sound.
volume: :class:`float`
The volume of the sound as floating point percentage (e.g. ``1.0`` for 100%).
name: :class:`str`
The name of the sound.
emoji: :class:`PartialEmoji`
The emoji of the sound.
"""
__slots__ = ('name', 'emoji')
def __init__(self, *, state: ConnectionState, data: SoundboardDefaultSoundPayload):
self.name: str = data['name']
self.emoji: PartialEmoji = PartialEmoji(name=data['emoji_name'])
super().__init__(state=state, data=data)
def __repr__(self) -> str:
attrs = [
('id', self.id),
('name', self.name),
('volume', self.volume),
('emoji', self.emoji),
]
inner = ' '.join('%s=%r' % t for t in attrs)
return f"<{self.__class__.__name__} {inner}>"
class SoundboardSound(BaseSoundboardSound):
"""Represents a Discord soundboard sound.
.. versionadded:: 2.5
.. container:: operations
.. describe:: x == y
Checks if two sounds are equal.
.. describe:: x != y
Checks if two sounds are not equal.
.. describe:: hash(x)
Returns the sound's hash.
Attributes
------------
id: :class:`int`
The ID of the sound.
volume: :class:`float`
The volume of the sound as floating point percentage (e.g. ``1.0`` for 100%).
name: :class:`str`
The name of the sound.
emoji: Optional[:class:`PartialEmoji`]
The emoji of the sound. ``None`` if no emoji is set.
guild: :class:`Guild`
The guild in which the sound is uploaded.
available: :class:`bool`
Whether this sound is available for use.
"""
__slots__ = ('_state', 'name', 'emoji', '_user', 'available', '_user_id', 'guild')
def __init__(self, *, guild: Guild, state: ConnectionState, data: SoundboardSoundPayload):
super().__init__(state=state, data=data)
self.guild = guild
self._user_id = utils._get_as_snowflake(data, 'user_id')
self._user = data.get('user')
self._update(data)
def __repr__(self) -> str:
attrs = [
('id', self.id),
('name', self.name),
('volume', self.volume),
('emoji', self.emoji),
('user', self.user),
]
inner = ' '.join('%s=%r' % t for t in attrs)
return f"<{self.__class__.__name__} {inner}>"
def _update(self, data: SoundboardSoundPayload):
super()._update(data)
self.name: str = data['name']
self.emoji: Optional[PartialEmoji] = None
emoji_id = utils._get_as_snowflake(data, 'emoji_id')
emoji_name = data['emoji_name']
if emoji_id is not None or emoji_name is not None:
self.emoji = PartialEmoji(id=emoji_id, name=emoji_name) # type: ignore # emoji_name cannot be None here
self.available: bool = data['available']
@property
def created_at(self) -> datetime.datetime:
""":class:`datetime.datetime`: Returns the snowflake's creation time in UTC."""
return utils.snowflake_time(self.id)
@property
def user(self) -> Optional[User]:
"""Optional[:class:`User`]: The user who uploaded the sound."""
if self._user is None:
if self._user_id is None:
return None
return self._state.get_user(self._user_id)
return User(state=self._state, data=self._user)
async def edit(
self,
*,
name: str = MISSING,
volume: Optional[float] = MISSING,
emoji: Optional[EmojiInputType] = MISSING,
reason: Optional[str] = None,
):
"""|coro|
Edits the soundboard sound.
You must have :attr:`~Permissions.manage_expressions` to edit the sound.
If the sound was created by the client, you must have either :attr:`~Permissions.manage_expressions`
or :attr:`~Permissions.create_expressions`.
Parameters
----------
name: :class:`str`
The new name of the sound. Must be between 2 and 32 characters.
volume: Optional[:class:`float`]
The new volume of the sound. Must be between 0 and 1.
emoji: Optional[Union[:class:`Emoji`, :class:`PartialEmoji`, :class:`str`]]
The new emoji of the sound.
reason: Optional[:class:`str`]
The reason for editing this sound. Shows up on the audit log.
Raises
-------
Forbidden
You do not have permissions to edit the soundboard sound.
HTTPException
Editing the soundboard sound failed.
Returns
-------
:class:`SoundboardSound`
The newly updated soundboard sound.
"""
payload: Dict[str, Any] = {}
if name is not MISSING:
payload['name'] = name
if volume is not MISSING:
payload['volume'] = volume
if emoji is not MISSING:
if emoji is None:
payload['emoji_id'] = None
payload['emoji_name'] = None
else:
if isinstance(emoji, _EmojiTag):
partial_emoji = emoji._to_partial()
elif isinstance(emoji, str):
partial_emoji = PartialEmoji.from_str(emoji)
else:
partial_emoji = None
if partial_emoji is not None:
if partial_emoji.id is None:
payload['emoji_name'] = partial_emoji.name
else:
payload['emoji_id'] = partial_emoji.id
data = await self._state.http.edit_soundboard_sound(self.guild.id, self.id, reason=reason, **payload)
return SoundboardSound(guild=self.guild, state=self._state, data=data)
async def delete(self, *, reason: Optional[str] = None) -> None:
"""|coro|
Deletes the soundboard sound.
You must have :attr:`~Permissions.manage_expressions` to delete the sound.
If the sound was created by the client, you must have either :attr:`~Permissions.manage_expressions`
or :attr:`~Permissions.create_expressions`.
Parameters
-----------
reason: Optional[:class:`str`]
The reason for deleting this sound. Shows up on the audit log.
Raises
-------
Forbidden
You do not have permissions to delete the soundboard sound.
HTTPException
Deleting the soundboard sound failed.
"""
await self._state.http.delete_soundboard_sound(self.guild.id, self.id, reason=reason)
|