|
| 1 | +from typing import TYPE_CHECKING, List, Optional, Union |
| 2 | + |
| 3 | +from ..error import LibraryException |
| 4 | +from .attrs_utils import ClientSerializerMixin, convert_list, define, field |
| 5 | +from .misc import Snowflake |
| 6 | +from .user import User |
| 7 | + |
| 8 | +if TYPE_CHECKING: |
| 9 | + from ..http import HTTPClient |
| 10 | + from .guild import Guild |
| 11 | + |
| 12 | +__all__ = ("Emoji",) |
| 13 | + |
| 14 | + |
| 15 | +@define() |
| 16 | +class Emoji(ClientSerializerMixin): |
| 17 | + """ |
| 18 | + A class objecting representing an emoji. |
| 19 | +
|
| 20 | + :ivar Optional[Snowflake] id?: Emoji id |
| 21 | + :ivar Optional[str] name?: Emoji name. |
| 22 | + :ivar Optional[List[int]] roles?: Roles allowed to use this emoji |
| 23 | + :ivar Optional[User] user?: User that created this emoji |
| 24 | + :ivar Optional[bool] require_colons?: Status denoting of this emoji must be wrapped in colons |
| 25 | + :ivar Optional[bool] managed?: Status denoting if this emoji is managed (by an integration) |
| 26 | + :ivar Optional[bool] animated?: Status denoting if this emoji is animated |
| 27 | + :ivar Optional[bool] available?: Status denoting if this emoji can be used. (Can be false via server boosting) |
| 28 | + """ |
| 29 | + |
| 30 | + id: Optional[Snowflake] = field(converter=Snowflake, default=None) |
| 31 | + name: Optional[str] = field(default=None) |
| 32 | + roles: Optional[List[int]] = field(converter=convert_list(int), default=None) |
| 33 | + user: Optional[User] = field(converter=User, default=None) |
| 34 | + require_colons: Optional[bool] = field(default=None) |
| 35 | + managed: Optional[bool] = field(default=None) |
| 36 | + animated: Optional[bool] = field(default=None) |
| 37 | + available: Optional[bool] = field(default=None) |
| 38 | + |
| 39 | + def __str__(self): |
| 40 | + return ( |
| 41 | + f"<{'a' if self.animated else ''}:{self.name}:{self.id}>" |
| 42 | + if self.id is not None |
| 43 | + else self.name |
| 44 | + ) |
| 45 | + |
| 46 | + @classmethod |
| 47 | + async def get( |
| 48 | + cls, |
| 49 | + guild_id: Union[int, Snowflake, "Guild"], |
| 50 | + emoji_id: Union[int, Snowflake], |
| 51 | + client: "HTTPClient", |
| 52 | + ) -> "Emoji": |
| 53 | + """ |
| 54 | + Gets an emoji. |
| 55 | +
|
| 56 | + :param guild_id: The id of the guild of the emoji |
| 57 | + :type guild_id: Union[int, Snowflake, "Guild"] |
| 58 | + :param emoji_id: The id of the emoji |
| 59 | + :type emoji_id: Union[int, Snowflake] |
| 60 | + :param client: The HTTPClient of your bot. Equals to ``bot._http`` |
| 61 | + :type client: HTTPClient |
| 62 | + :return: The Emoji as object |
| 63 | + :rtype: Emoji |
| 64 | + """ |
| 65 | + |
| 66 | + _guild_id = int(guild_id) if isinstance(guild_id, (int, Snowflake)) else int(guild_id.id) |
| 67 | + |
| 68 | + res = await client.get_guild_emoji(guild_id=_guild_id, emoji_id=int(emoji_id)) |
| 69 | + return cls(**res, _client=client) |
| 70 | + |
| 71 | + @classmethod |
| 72 | + async def get_all_of_guild( |
| 73 | + cls, |
| 74 | + guild_id: Union[int, Snowflake, "Guild"], |
| 75 | + client: "HTTPClient", |
| 76 | + ) -> List["Emoji"]: |
| 77 | + """ |
| 78 | + Gets all emoji of a guild. |
| 79 | +
|
| 80 | + :param guild_id: The id of the guild to get the emojis of |
| 81 | + :type guild_id: Union[int, Snowflake, "Guild"] |
| 82 | + :param client: The HTTPClient of your bot. Equals to ``bot._http`` |
| 83 | + :type client: HTTPClient |
| 84 | + :return: The Emoji as list |
| 85 | + :rtype: List[Emoji] |
| 86 | + """ |
| 87 | + |
| 88 | + _guild_id = int(guild_id) if isinstance(guild_id, (int, Snowflake)) else int(guild_id.id) |
| 89 | + |
| 90 | + res = await client.get_all_emoji(guild_id=_guild_id) |
| 91 | + return [cls(**emoji, _client=client) for emoji in res] |
| 92 | + |
| 93 | + async def delete( |
| 94 | + self, |
| 95 | + guild_id: Union[int, Snowflake, "Guild"], |
| 96 | + reason: Optional[str] = None, |
| 97 | + ) -> None: |
| 98 | + """ |
| 99 | + Deletes the emoji. |
| 100 | +
|
| 101 | + :param guild_id: The guild id to delete the emoji from |
| 102 | + :type guild_id: Union[int, Snowflake, "Guild"] |
| 103 | + :param reason?: The reason of the deletion |
| 104 | + :type reason?: Optional[str] |
| 105 | + """ |
| 106 | + if not self._client: |
| 107 | + raise LibraryException(code=13) |
| 108 | + |
| 109 | + _guild_id = int(guild_id) if isinstance(guild_id, (int, Snowflake)) else int(guild_id.id) |
| 110 | + |
| 111 | + return await self._client.delete_guild_emoji( |
| 112 | + guild_id=_guild_id, emoji_id=int(self.id), reason=reason |
| 113 | + ) |
| 114 | + |
| 115 | + @property |
| 116 | + def url(self) -> str: |
| 117 | + """ |
| 118 | + Returns the emoji's URL. |
| 119 | +
|
| 120 | + :return: URL of the emoji |
| 121 | + :rtype: str |
| 122 | + """ |
| 123 | + url = f"https://cdn.discordapp.com/emojis/{self.id}" |
| 124 | + url += ".gif" if self.animated else ".png" |
| 125 | + return url |
![pre-commit-ci[bot]](https://avatars.githubusercontent.com/in/68672?v=4&size=40){kind=avatar}
0 commit comments