e5ebea75a9
The global emoji cache still managed to somehow cause memory leaks. By storing IDs directly and lazily evaluating them when needed this essentially removes all strong references to Guild objects which would cause an explosion in memory usage.
240 lines
6.7 KiB
Python
240 lines
6.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2015-2017 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.
|
|
"""
|
|
|
|
import asyncio
|
|
from collections import namedtuple
|
|
|
|
from . import utils
|
|
from .mixins import Hashable
|
|
|
|
class PartialReactionEmoji(namedtuple('PartialReactionEmoji', 'name id')):
|
|
"""Represents a "partial" reaction emoji.
|
|
|
|
This model will be given in two scenarios:
|
|
|
|
- "Raw" data events such as :func:`on_raw_reaction_add`
|
|
- Custom emoji that the bot cannot see from e.g. :attr:`Message.reactions`
|
|
|
|
.. 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:: str(x)
|
|
|
|
Returns the emoji rendered for discord.
|
|
|
|
Attributes
|
|
-----------
|
|
name: str
|
|
The custom emoji name, if applicable, or the unicode codepoint
|
|
of the non-custom emoji.
|
|
id: Optional[int]
|
|
The ID of the custom emoji, if applicable.
|
|
"""
|
|
|
|
__slots__ = ()
|
|
|
|
def __str__(self):
|
|
if self.id is None:
|
|
return self.name
|
|
return '<:%s:%s>' % (self.name, self.id)
|
|
|
|
def is_custom_emoji(self):
|
|
"""Checks if this is a custom non-Unicode emoji."""
|
|
return self.id is not None
|
|
|
|
def is_unicode_emoji(self):
|
|
"""Checks if this is a Unicode emoji."""
|
|
return self.id is None
|
|
|
|
def _as_reaction(self):
|
|
if self.id is None:
|
|
return self.name
|
|
return ':%s:%s' % (self.name, self.id)
|
|
|
|
class Emoji(Hashable):
|
|
"""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: str
|
|
The name of the emoji.
|
|
id: int
|
|
The emoji's ID.
|
|
require_colons: bool
|
|
If colons are required to use this emoji in the client (:PJSalt: vs PJSalt).
|
|
managed: bool
|
|
If this emoji is managed by a Twitch integration.
|
|
guild_id: int
|
|
The guild ID the emoji belongs to.
|
|
"""
|
|
__slots__ = ('require_colons', 'managed', 'id', 'name', '_roles', 'guild_id', '_state')
|
|
|
|
def __init__(self, *, guild, state, data):
|
|
self.guild_id = guild.id
|
|
self._state = state
|
|
self._from_data(data)
|
|
|
|
def _from_data(self, emoji):
|
|
self.require_colons = emoji['require_colons']
|
|
self.managed = emoji['managed']
|
|
self.id = int(emoji['id'])
|
|
self.name = emoji['name']
|
|
self._roles = set(emoji.get('roles', []))
|
|
|
|
def _iterator(self):
|
|
for attr in self.__slots__:
|
|
if attr[0] != '_':
|
|
value = getattr(self, attr, None)
|
|
if value is not None:
|
|
yield (attr, value)
|
|
|
|
def __iter__(self):
|
|
return self._iterator()
|
|
|
|
def __str__(self):
|
|
return "<:{0.name}:{0.id}>".format(self)
|
|
|
|
def __repr__(self):
|
|
return '<Emoji id={0.id} name={0.name!r}>'.format(self)
|
|
|
|
@property
|
|
def created_at(self):
|
|
"""Returns the emoji's creation time in UTC."""
|
|
return utils.snowflake_time(self.id)
|
|
|
|
@property
|
|
def url(self):
|
|
"""Returns a URL version of the emoji."""
|
|
return "https://cdn.discordapp.com/emojis/{0.id}.png".format(self)
|
|
|
|
@property
|
|
def roles(self):
|
|
"""List[:class:`Role`]: A list of roles that is allowed to use this emoji.
|
|
|
|
If roles is empty, the emoji is unrestricted.
|
|
"""
|
|
guild = self.guild
|
|
if guild is None:
|
|
return []
|
|
|
|
return [role for role in guild.roles if role.id in self._roles]
|
|
|
|
@property
|
|
def guild(self):
|
|
""":class:`Guild`: The guild this emoji belongs to."""
|
|
return self._state._get_guild(self.guild_id)
|
|
|
|
@asyncio.coroutine
|
|
def delete(self, *, reason=None):
|
|
"""|coro|
|
|
|
|
Deletes the custom emoji.
|
|
|
|
You must have :attr:`~Permissions.manage_emojis` permission to
|
|
do this.
|
|
|
|
Guild local emotes can only be deleted by user bots.
|
|
|
|
Parameters
|
|
-----------
|
|
reason: Optional[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.
|
|
"""
|
|
|
|
yield from self._state.http.delete_custom_emoji(self.guild.id, self.id, reason=reason)
|
|
|
|
@asyncio.coroutine
|
|
def edit(self, *, name, reason=None):
|
|
"""|coro|
|
|
|
|
Edits the custom emoji.
|
|
|
|
You must have :attr:`~Permissions.manage_emojis` permission to
|
|
do this.
|
|
|
|
Guild local emotes can only be edited by user bots.
|
|
|
|
Parameters
|
|
-----------
|
|
name: str
|
|
The new emoji name.
|
|
reason: Optional[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.
|
|
"""
|
|
|
|
yield from self._state.http.edit_custom_emoji(self.guild.id, self.id, name=name, reason=reason)
|