Flesh out the info cog/command to be more expansible (#53)

* flesh out the info Cog as it felt a bit barren

* add error handler for Cog

* add relative datetimes

* pin to dpy fix commit

* more versioning fixes

Author: AbstractUmbra

core/bot.py

@@ -35,6 +35,9 @@
 import asyncpg
 import discord
 from discord.ext import commands
+from discord.ext.commands.cog import Cog  # type: ignore # stubs
+
+from constants import GUILD_ID
 
 from .context import Context
 from .core import CONFIG
@@ -77,6 +80,11 @@ async def get_context(
     ) -> Context:
         return await super().get_context(message, cls=Context)
 
+    async def add_cog(self, cog: Cog, /, *, override: bool = False) -> None:  # type: ignore
+        # we patch this since we're a single guild bot.
+        # it allows for guild syncing only.
+        return await super().add_cog(cog, override=override, guild=discord.Object(id=GUILD_ID))
+
     async def on_ready(self) -> None:
         """On Bot ready - cache is built."""
         assert self.user

modules/info.py

@@ -22,57 +22,117 @@
 """
 from __future__ import annotations
 
+from typing import TypeVar
+
 import discord
 from discord.ext import commands
 
 import core
+from constants import GUILD_ID
 
 
-class InformationEmbed(discord.Embed):
-    """A subclass of discord.Embed.
+EntityT = TypeVar("EntityT", discord.Member, discord.User, discord.Role, discord.abc.GuildChannel, discord.Guild)
 
-    This class allows to automatically get information within the class instead of recreating the embed each time
 
-    :param author: The embed author. Expects discord.Member or discord.User
-    :param entity: The Member, User, Role, TextChannel, or Guild to get information about.
-    """
+class NoPermissions(commands.CommandError):
+    pass
 
-    def __init__(
-        self,
-        *,
-        author: discord.Member | discord.User,
-        entity: discord.Member | discord.User | discord.Role | discord.TextChannel | discord.Guild,
-    ) -> None:
-        super().__init__()
-        created_at: str = f"{discord.utils.format_dt(entity.created_at)} ({discord.utils.format_dt(entity.created_at, 'R')})"
-        if isinstance(entity, discord.Member) and entity.joined_at:
-            joined_at = f"\n\nJoined At: {discord.utils.format_dt(entity.joined_at)} ({discord.utils.format_dt(entity.joined_at, 'R')})"
-        else:
-            joined_at = ""
 
-        description = f"Name: {entity.name}\n\nID: {entity.id}\n\nCreated At: {created_at}{joined_at}"
-        if isinstance(entity, discord.Member):
-            self.set_thumbnail(url=entity.guild_avatar or entity.display_avatar or None)
-        elif isinstance(entity, discord.User):
-            self.set_thumbnail(url=entity.display_avatar or None)
+class Information(core.Cog):
+    """Information commands which allows you to get information about users, the guild, roles, and channels."""
+
+    def __init__(self, bot: core.Bot) -> None:
+        self.bot: core.Bot = bot
+
+    async def cog_command_error(self, ctx: core.Context, error: commands.CommandError) -> None:  # type: ignore # bad lib types.
+        error = getattr(error, "original", error)
+
+        if isinstance(error, NoPermissions):
+            await ctx.send("Sorry, you don't have permissions to view details on this object.")
+            return
+
+    def _embed_factory(self, entity: EntityT) -> discord.Embed:
+        embed = discord.Embed(title=f"Info on {entity.name}!", colour=discord.Colour.random())
+        embed.add_field(name="ID:", value=entity.id)
+        embed.timestamp = discord.utils.utcnow()
+
+        if isinstance(entity, discord.User):
+            return self._user_info(entity, embed=embed)
+        elif isinstance(entity, discord.Member):
+            embed = self._user_info(entity, embed=embed)  # type: ignore # superclass
+            return self._member_info(entity, embed=embed)
         elif isinstance(entity, discord.Role):
-            description += f"\n\nHoisted: {entity.hoist}\n\nMentionable: {entity.mentionable}\n\n"
-        elif isinstance(entity, discord.TextChannel):
-            description += f"\n\nCategory: {entity.category}\n\nNSFW: {entity.nsfw}"
-        else:  # Change to elif when other types are added
-            description += f"\n\nOwner: {entity.owner}"
-            self.set_thumbnail(url=entity.icon or None)
+            return self._role_info(entity, embed=embed)
+        elif isinstance(entity, discord.abc.GuildChannel):
+            return self._channel_info(entity, embed=embed)
+        else:
+            return self._guild_info(entity, embed=embed)
 
-        self.description = description
-        self.set_author(name=author.name, icon_url=author.display_avatar)
-        self.color = 0x7289DA
+    def _member_info(self, member: discord.Member, /, *, embed: discord.Embed) -> discord.Embed:
+        if member.joined_at:
+            joined_at_fmt = (
+                discord.utils.format_dt(member.joined_at, "F") + "\n" f"({discord.utils.format_dt(member.joined_at, 'R')})"
+            )
+            embed.add_field(name="Member joined the guild on:", value=joined_at_fmt)
 
+        roles = [role.mention for role in member.roles[1:]]
+        roles.reverse()
+        embed.add_field(name="Member's top 5 roles:-", value="\n".join(roles[:5]), inline=False)
+        embed.colour = member.colour or embed.colour
 
-class Information(core.Cog):
-    """Information commands which allows you to get information about users, the guild, roles, and channels."""
+        return embed
 
-    def __init__(self, bot: core.Bot) -> None:
-        self.bot = bot
+    def _user_info(self, user: discord.User, /, *, embed: discord.Embed) -> discord.Embed:
+        embed = discord.Embed(title=f"Info on {user.display_name}!", colour=discord.Colour.random())
+        embed.set_author(name=user.name)
+        embed.set_image(url=user.display_avatar.url)
+        created_at_fmt = (
+            discord.utils.format_dt(user.created_at, "F") + "\n" f"({discord.utils.format_dt(user.created_at, 'R')})"
+        )
+        embed.add_field(name="Account was created on:", value=created_at_fmt)
+
+        embed.timestamp = discord.utils.utcnow()
+
+        return embed
+
+    def _role_info(self, role: discord.Role, /, *, embed: discord.Embed) -> discord.Embed:
+        embed.colour = role.colour or embed.colour
+        embed.add_field(name="Mentionable?", value=role.mentionable)
+        embed.add_field(name="Hoisted?", value=role.hoist)
+        embed.add_field(name="Member count:", value=len(role.members))
+        embed.add_field(name="Created on:", value=discord.utils.format_dt(role.created_at, "F"))
+
+        return embed
+
+    def _channel_info(self, channel: discord.abc.GuildChannel, /, *, embed: discord.Embed) -> discord.Embed:
+        sneaky_role = channel.guild.default_role
+        permissions = channel.permissions_for(sneaky_role)
+
+        allowed_to_read = discord.Permissions(read_messages=True, view_channel=True)
+
+        if not permissions.is_strict_superset(allowed_to_read):
+            # They cannot read this channel
+            raise NoPermissions("Cannot read this channel.")
+
+        embed.url = channel.jump_url
+
+        embed.add_field(name="Channel type:", value=channel.type.name, inline=False)
+
+        embed.add_field(name="Created on:", value=discord.utils.format_dt(channel.created_at, "F"), inline=False)
+
+        is_private = not (permissions.view_channel or permissions.read_messages)
+        embed.add_field(name="Private Channel?", value=is_private)
+
+        return embed
+
+    def _guild_info(self, guild: discord.Guild, /, *, embed: discord.Embed) -> discord.Embed:
+        if guild.id != GUILD_ID:
+            raise NoPermissions("Unreachable but better safe than sorry.")
+
+        embed.add_field(name="Created on:", value=discord.utils.format_dt(guild.created_at, "F"))
+        embed.set_thumbnail(url=(guild.icon and guild.icon.url))
+
+        return embed
 
     @commands.group(
         name="information",
@@ -81,18 +141,21 @@ def __init__(self, bot: core.Bot) -> None:
         invoke_without_command=True,
     )
     async def info(
-        self, ctx: core.Context, entity: discord.Member | discord.User | discord.Role | discord.TextChannel = commands.Author
+        self,
+        ctx: core.Context,
+        *,
+        entity: discord.Member
+        | discord.User
+        | discord.Role
+        | discord.abc.GuildChannel
+        | discord.Guild = commands.CurrentGuild,
     ) -> None:
-        """Get information about a object
-        Args:
-            entity: The user, role, or TextChannel to get information about"""
-        embed = InformationEmbed(author=ctx.author, entity=entity)
-        await ctx.send(embed=embed)
-
-    @info.command(name="guild", brief="Get the current guild's information.")
-    async def guild_info(self, ctx: core.GuildContext):
-        embed = InformationEmbed(author=ctx.author, entity=ctx.guild)
-        await ctx.reply(embed=embed)
+        """Get information about a specific Pythonista related object.
+
+        entity: Accepts a Person's ID, a Role ID or a Channel ID. Defaults to showing info on the Guild.
+        """
+        embed = self._embed_factory(entity)  # type: ignore # we ignore because converter sadness
+        await ctx.reply(embed=embed, mention_author=False)
 
 
 async def setup(bot: core.Bot) -> None:

poetry.lock

@@ -12,7 +12,7 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.11"
-"discord.py" = "*"
+"discord.py" = { git = "https://github.com/Rapptz/discord.py.git", rev = "e6a0dc5bc0ba8e739b0def446378088bea65d1df" }
 aiohttp = "*"
 asyncpg = "*"
 toml = "*"

pyproject.toml

@@ -1,4 +1,4 @@
-discord.py>=1.6.0
+discord.py @ git+https://github.com/Rapptz/discord.py@e6a0dc5
 aiohttp~=3.7.3
 asyncpg~=0.27.0
 toml>=0.10.2