Add custom emoji support.

discord/emoji.py

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+
+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 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 . import utils
+from .mixins import Hashable
+
+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``.
+
+    Supported Operations:
+
+    +-----------+-----------------------------------------+
+    | Operation |               Description               |
+    +===========+=========================================+
+    | x == y    | Checks if two emoji are the same.       |
+    +-----------+-----------------------------------------+
+    | x != y    | Checks if two emoji are not the same.   |
+    +-----------+-----------------------------------------+
+    | hash(x)   | Return the emoji's hash.                |
+    +-----------+-----------------------------------------+
+    | iter(x)   | Returns an iterator of (field, value)   |
+    |           | pairs. This allows this class to be     |
+    |           | used as an iterable in list/dict/etc.   |
+    |           | constructions.                          |
+    +-----------+-----------------------------------------+
+    | str(x)    | Returns the emoji rendered for discord. |
+    +-----------+-----------------------------------------+
+
+    Attributes
+    -----------
+    name : str
+        The name of the emoji.
+    id : str
+        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.
+    created_at : `datetime.datetime`
+        A datetime object denoting the time the invite was created.
+    server : :class:`Server`
+        The server the emoji belongs to.
+    roles : List[:class:`Role`]
+        A list of :class:`Role` that is allowed to use this emoji. If roles is empty,
+        the emoji is unrestricted.
+    """
+    __slots__ = ["require_colons", "managed", "id", "name", "roles", 'server']
+
+    def __init__(self, **kwargs):
+        self.server = kwargs.pop('server')
+        self._from_data(kwargs)
+
+    def _from_data(self, emoji):
+        self.require_colons = emoji.get('require_colons')
+        self.managed = emoji.get('managed')
+        self.id = emoji.get('id')
+        self.name = emoji.get('name')
+        self.roles = emoji.get('roles', [])
+        if self.roles:
+            roles = set(self.roles)
+            self.roles = [role for role in self.server.roles if role.id in roles]
+
+    def _iterator(self):
+        for attr in self.__slots__:
+            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)
+
+    @property
+    def created_at(self):
+        """Returns the emoji's creation time in UTC."""
+        return utils.snowflake_time(self.id)