249 lines
7.8 KiB
Python
249 lines
7.8 KiB
Python
# SPDX-License-Identifier: MIT
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any, Iterator, List, Optional, Tuple, Union
|
|
|
|
from .asset import Asset, AssetMixin
|
|
from .partial_emoji import PartialEmoji, _EmojiTag
|
|
from .user import User
|
|
from .utils import MISSING, SnowflakeList, snowflake_time
|
|
|
|
__all__ = ("Emoji",)
|
|
|
|
if TYPE_CHECKING:
|
|
from datetime import datetime
|
|
|
|
from .abc import Snowflake
|
|
from .guild import Guild
|
|
from .guild_preview import GuildPreview
|
|
from .role import Role
|
|
from .state import ConnectionState
|
|
from .types.emoji import Emoji as EmojiPayload
|
|
|
|
|
|
class Emoji(_EmojiTag, AssetMixin):
|
|
"""Represents a custom emoji.
|
|
|
|
Depending on the way this object was created, some of the attributes can
|
|
have a value of ``None``.
|
|
|
|
.. container:: operations
|
|
|
|
.. describe:: x == y
|
|
|
|
Checks if two emoji are the same.
|
|
|
|
.. describe:: x != y
|
|
|
|
Checks if two emoji are not the same.
|
|
|
|
.. describe:: hash(x)
|
|
|
|
Return the emoji's hash.
|
|
|
|
.. describe:: iter(x)
|
|
|
|
Returns an iterator of ``(field, value)`` pairs. This allows this class
|
|
to be used as an iterable in list/dict/etc constructions.
|
|
|
|
.. describe:: str(x)
|
|
|
|
Returns the emoji rendered for Discord.
|
|
|
|
Attributes
|
|
----------
|
|
name: :class:`str`
|
|
The emoji's name.
|
|
id: :class:`int`
|
|
The emoji's ID.
|
|
require_colons: :class:`bool`
|
|
Whether colons are required to use this emoji in the client (:PJSalt: vs PJSalt).
|
|
animated: :class:`bool`
|
|
Whether the emoji is animated or not.
|
|
managed: :class:`bool`
|
|
Whether the emoji is managed by a Twitch integration.
|
|
guild_id: :class:`int`
|
|
The guild ID the emoji belongs to.
|
|
available: :class:`bool`
|
|
Whether the emoji is available for use.
|
|
user: Optional[:class:`User`]
|
|
The user that created this emoji. This can only be retrieved using
|
|
:meth:`Guild.fetch_emoji`/:meth:`Guild.fetch_emojis` while
|
|
having the :attr:`~Permissions.manage_guild_expressions` permission.
|
|
"""
|
|
|
|
__slots__: Tuple[str, ...] = (
|
|
"require_colons",
|
|
"animated",
|
|
"managed",
|
|
"id",
|
|
"name",
|
|
"_roles",
|
|
"guild_id",
|
|
"user",
|
|
"available",
|
|
)
|
|
|
|
def __init__(
|
|
self, *, guild: Union[Guild, GuildPreview], state: ConnectionState, data: EmojiPayload
|
|
) -> None:
|
|
self.guild_id: int = guild.id
|
|
self._state: ConnectionState = state
|
|
self._from_data(data)
|
|
|
|
def _from_data(self, emoji: EmojiPayload) -> None:
|
|
self.require_colons: bool = emoji.get("require_colons", False)
|
|
self.managed: bool = emoji.get("managed", False)
|
|
self.id: int = int(emoji["id"]) # type: ignore
|
|
self.name: str = emoji["name"] # type: ignore
|
|
self.animated: bool = emoji.get("animated", False)
|
|
self.available: bool = emoji.get("available", True)
|
|
self._roles: SnowflakeList = SnowflakeList(map(int, emoji.get("roles", [])))
|
|
user = emoji.get("user")
|
|
self.user: Optional[User] = User(state=self._state, data=user) if user else None
|
|
|
|
def _to_partial(self) -> PartialEmoji:
|
|
return PartialEmoji(name=self.name, animated=self.animated, id=self.id)
|
|
|
|
def __iter__(self) -> Iterator[Tuple[str, Any]]:
|
|
for attr in self.__slots__:
|
|
if attr[0] != "_":
|
|
value = getattr(self, attr, None)
|
|
if value is not None:
|
|
yield (attr, value)
|
|
|
|
def __str__(self) -> str:
|
|
if self.animated:
|
|
return f"<a:{self.name}:{self.id}>"
|
|
return f"<:{self.name}:{self.id}>"
|
|
|
|
def __repr__(self) -> str:
|
|
return f"<Emoji id={self.id} name={self.name!r} animated={self.animated} managed={self.managed}>"
|
|
|
|
def __eq__(self, other: Any) -> bool:
|
|
return isinstance(other, _EmojiTag) and self.id == other.id
|
|
|
|
def __ne__(self, other: Any) -> bool:
|
|
return not self.__eq__(other)
|
|
|
|
def __hash__(self) -> int:
|
|
return self.id >> 22
|
|
|
|
@property
|
|
def created_at(self) -> datetime:
|
|
""":class:`datetime.datetime`: Returns the emoji's creation time in UTC."""
|
|
return snowflake_time(self.id)
|
|
|
|
@property
|
|
def url(self) -> str:
|
|
""":class:`str`: Returns the URL of the emoji."""
|
|
fmt = "gif" if self.animated else "png"
|
|
return f"{Asset.BASE}/emojis/{self.id}.{fmt}"
|
|
|
|
@property
|
|
def roles(self) -> List[Role]:
|
|
"""List[:class:`Role`]: A :class:`list` of roles that are allowed to use this emoji.
|
|
|
|
If roles is empty, the emoji is unrestricted.
|
|
|
|
Emojis with :attr:`subscription roles <RoleTags.integration_id>` are considered premium emojis,
|
|
and count towards a separate limit of 25 emojis.
|
|
"""
|
|
guild = self.guild
|
|
if guild is None:
|
|
return []
|
|
|
|
return [role for role in guild.roles if self._roles.has(role.id)]
|
|
|
|
@property
|
|
def guild(self) -> Guild:
|
|
""":class:`Guild`: The guild this emoji belongs to."""
|
|
# this will most likely never return None but there's a possibility
|
|
return self._state._get_guild(self.guild_id) # type: ignore
|
|
|
|
def is_usable(self) -> bool:
|
|
"""Whether the bot can use this emoji.
|
|
|
|
.. versionadded:: 1.3
|
|
|
|
:return type: :class:`bool`
|
|
"""
|
|
if not self.available:
|
|
return False
|
|
if not self._roles:
|
|
return True
|
|
emoji_roles, my_roles = self._roles, self.guild.me._roles
|
|
return any(my_roles.has(role_id) for role_id in emoji_roles)
|
|
|
|
async def delete(self, *, reason: Optional[str] = None) -> None:
|
|
"""|coro|
|
|
|
|
Deletes the custom emoji.
|
|
|
|
You must have :attr:`~Permissions.manage_guild_expressions` permission to
|
|
do this.
|
|
|
|
Parameters
|
|
----------
|
|
reason: Optional[:class:`str`]
|
|
The reason for deleting this emoji. Shows up on the audit log.
|
|
|
|
Raises
|
|
------
|
|
Forbidden
|
|
You are not allowed to delete emojis.
|
|
HTTPException
|
|
An error occurred deleting the emoji.
|
|
"""
|
|
await self._state.http.delete_custom_emoji(self.guild.id, self.id, reason=reason)
|
|
|
|
async def edit(
|
|
self, *, name: str = MISSING, roles: List[Snowflake] = MISSING, reason: Optional[str] = None
|
|
) -> Emoji:
|
|
"""|coro|
|
|
|
|
Edits the custom emoji.
|
|
|
|
You must have :attr:`~Permissions.manage_guild_expressions` permission to
|
|
do this.
|
|
|
|
.. versionchanged:: 2.0
|
|
The newly updated emoji is returned.
|
|
|
|
Parameters
|
|
----------
|
|
name: :class:`str`
|
|
The new emoji name.
|
|
roles: Optional[List[:class:`~disnake.abc.Snowflake`]]
|
|
A list of roles that can use this emoji. An empty list can be passed to make it available to everyone.
|
|
|
|
An emoji cannot have both subscription roles (see :attr:`RoleTags.integration_id`) and
|
|
non-subscription roles, and emojis can't be converted between premium and non-premium
|
|
after creation.
|
|
reason: Optional[:class:`str`]
|
|
The reason for editing this emoji. Shows up on the audit log.
|
|
|
|
Raises
|
|
------
|
|
Forbidden
|
|
You are not allowed to edit emojis.
|
|
HTTPException
|
|
An error occurred editing the emoji.
|
|
|
|
Returns
|
|
-------
|
|
:class:`Emoji`
|
|
The newly updated emoji.
|
|
"""
|
|
payload = {}
|
|
if name is not MISSING:
|
|
payload["name"] = name
|
|
if roles is not MISSING:
|
|
payload["roles"] = [role.id for role in roles]
|
|
|
|
data = await self._state.http.edit_custom_emoji(
|
|
self.guild.id, self.id, payload=payload, reason=reason
|
|
)
|
|
return Emoji(guild=self.guild, data=data, state=self._state)
|