feat(emojiinfo): added aliases and groups

emojiinfo/model.py

@@ -0,0 +1,88 @@
+import json
+
+import discord
+from redbot.core import commands, data_manager
+
+
+class PartialEmoji(discord.PartialEmoji):
+    """Represents a "partial" emoji. Subclasses `discord.PartialEmoji`
+
+    .. 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: Optional[:class:`str`]
+        The custom emoji name, if applicable, or the unicode codepoint
+        of the non-custom emoji. This can be ``None`` if the emoji
+        got deleted (e.g. removing a reaction with a deleted emoji).
+    animated: :class:`bool`
+        Whether the emoji is animated or not.
+    id: Optional[:class:`int`]
+        The ID of the custom emoji, if applicable.
+    group: Optional[:class:`str`]
+        The group name of the emoji if it is a native emoji.
+    """
+
+    def __init__(self, *, name: str, animated: bool = False, id: int | None = None, group: str | None = None, aliases: list | None = None) -> None:
+        super().__init__(name=name, animated=animated, id=id)
+        self.group = group
+        self.aliases = aliases
+
+    @classmethod
+    def from_str(cls, coginstance: commands.Cog, value: str) -> "PartialEmoji":
+        """Converts a Discord string representation of an emoji to a :class:`PartialEmoji`.
+
+        The formats accepted are:
+
+        - ``a:name:id``
+        - ``<a:name:id>``
+        - ``name:id``
+        - ``<:name:id>``
+
+        If the format does not match then it is assumed to be a unicode emoji.
+
+        .. versionadded:: 2.0
+
+        Parameters
+        ------------
+        value: :class:`str`
+            The string representation of an emoji.
+
+        Returns
+        --------
+        :class:`PartialEmoji`
+            The partial emoji from this string.
+        """
+        match = cls._CUSTOM_EMOJI_RE.match(value)
+        if match is not None:
+            groups = match.groupdict()
+            animated = bool(groups['animated'])
+            emoji_id = int(groups['id'])
+            name = groups['name']
+            return cls(name=name, animated=animated, id=emoji_id)
+
+        emojis: dict = json.load(data_manager.bundled_data_path(coginstance) / "emojis.json")
+        emoji_aliases = []
+        for dict_name, group in emojis.items:
+            for key, value in group.items:
+                if value == name:
+                    emoji_group = dict_name
+                    if key not in emoji_aliases:
+                        emoji_aliases.append(key)
+        return cls(name=name, animated=animated, id=emoji_id, group=emoji_group, aliases=emoji_aliases)