Added raw alias

Author: Taaku18

.pylintrc

@@ -19,7 +19,7 @@ ignore-patterns=
 
 # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
 # number of processors available to use.
-jobs=1
+jobs=0
 
 # Control the amount of potential inferred values when inferring a single
 # object. This can help the performance when dealing with large functions or

CHANGELOG.md

@@ -39,6 +39,7 @@ however, insignificant breaking changes does not guarantee a major version bump,
 - `?plugin registry page-number` plugin registry can specify a page number for quick access.
 - A reworked interface for `?snippet` and `?alias`.
   - Add an `?snippet raw <name>` command for viewing the raw content of a snippet (escaped markdown).
+  - Add an `?alias raw <name>` command for viewing the raw content of a alias (escaped markdown).
 - The placeholder channel for the streaming status changed to https://www.twitch.tv/discordmodmail/.
 - Removed unclear `rm` alias for some `remove` commands.
 - Paginate `?config options`.

app.json

@@ -15,10 +15,6 @@
       "description": "Comma separated user IDs of people that are allowed to use owner only commands. (eval and update).",
       "required": true
     },
-    "GITHUB_ACCESS_TOKEN": {
-      "description": "Your personal access token for GitHub, adding this gives you the ability to use the 'update' command, which will sync your fork with the main repo.",
-      "required": false
-    },
     "MONGO_URI": {
       "description": "Mongo DB connection URI for self-hosting your data.",
       "required": true

cogs/modmail.py

@@ -1,7 +1,7 @@
 import asyncio
 import logging
 from datetime import datetime
-from itertools import zip_longest, takewhile
+from itertools import zip_longest
 from typing import Optional, Union
 from types import SimpleNamespace as param
 
@@ -17,7 +17,7 @@
 from core.models import PermissionLevel
 from core.paginator import PaginatorSession
 from core.time import UserFriendlyTime, human_timedelta
-from core.utils import format_preview, User, create_not_found_embed
+from core.utils import format_preview, User, create_not_found_embed, format_description
 
 logger = logging.getLogger("Modmail")
 
@@ -149,12 +149,7 @@ async def snippet(self, ctx, *, name: str.lower = None):
         for i, names in enumerate(
             zip_longest(*(iter(sorted(self.bot.snippets)),) * 15)
         ):
-            description = "\n".join(
-                ": ".join((str(a + i * 15), b))
-                for a, b in enumerate(
-                    takewhile(lambda x: x is not None, names), start=1
-                )
-            )
+            description = format_description(i, names)
             embed = discord.Embed(color=self.bot.main_color, description=description)
             embed.set_author(name="Snippets", icon_url=ctx.guild.icon_url)
             embeds.append(embed)

cogs/plugins.py

@@ -288,7 +288,7 @@ async def plugin_remove(self, ctx, *, plugin_name: str):
                     for i in self.bot.config["plugins"]
                 ):
                     # if there are no more of such repos, delete the folder
-                    def onerror(func, path, exc_info):  # pylint: disable=W0613
+                    def onerror(func, path, _):
                         if not os.access(path, os.W_OK):
                             # Is the error an access error?
                             os.chmod(path, stat.S_IWUSR)

cogs/utility.py

@@ -33,6 +33,7 @@
     get_perm_level,
     create_not_found_embed,
     parse_alias,
+    format_description,
 )
 
 logger = logging.getLogger("Modmail")
@@ -248,11 +249,10 @@ def __init__(self, bot):
             verify_checks=False, command_attrs={"help": "Shows this help message."}
         )
         # Looks a bit ugly
-        # noinspection PyProtectedMember
-        self.bot.help_command._command_impl = checks.has_permissions(  # pylint: disable=W0212
+        self.bot.help_command._command_impl = checks.has_permissions(  # pylint: disable=protected-access
             PermissionLevel.REGULAR
         )(
-            self.bot.help_command._command_impl  # pylint: disable=W0212
+            self.bot.help_command._command_impl  # pylint: disable=protected-access
         )
 
         self.bot.help_command.cog = self
@@ -998,19 +998,26 @@ async def alias(self, ctx, *, name: str.lower = None):
         embeds = []
 
         for i, names in enumerate(zip_longest(*(iter(sorted(self.bot.aliases)),) * 15)):
-            description = "\n".join(
-                ": ".join((str(a + i * 15), b))
-                for a, b in enumerate(
-                    takewhile(lambda x: x is not None, names), start=1
-                )
-            )
+            description = format_description(i, names)
             embed = Embed(color=self.bot.main_color, description=description)
             embed.set_author(name="Command Aliases", icon_url=ctx.guild.icon_url)
             embeds.append(embed)
 
         session = PaginatorSession(ctx, *embeds)
         await session.run()
 
+    @alias.command(name="raw")
+    @checks.has_permissions(PermissionLevel.MODERATOR)
+    async def alias_raw(self, ctx, *, name: str.lower):
+        """
+        View the raw content of an alias.
+        """
+        val = self.bot.aliases.get(name)
+        if val is None:
+            embed = create_not_found_embed(name, self.bot.aliases.keys(), "Alias")
+            return await ctx.send(embed=embed)
+        return await ctx.send(escape_markdown(escape_mentions(val)).replace("<", "\\<"))
+
     @alias.command(name="add")
     @checks.has_permissions(PermissionLevel.MODERATOR)
     async def alias_add(self, ctx, name: str.lower, *, value):
@@ -1027,36 +1034,36 @@ async def alias_add(self, ctx, name: str.lower, *, value):
         - This will fail: `{prefix}alias add reply You'll need to type && to work`
         - Correct method: `{prefix}alias add reply "You'll need to type && to work"`
         """
+        embed = None
         if self.bot.get_command(name):
             embed = Embed(
                 title="Error",
                 color=Color.red(),
                 description=f"A command with the same name already exists: `{name}`.",
             )
-            return await ctx.send(embed=embed)
 
-        if name in self.bot.aliases:
+        elif name in self.bot.aliases:
             embed = Embed(
                 title="Error",
                 color=Color.red(),
                 description=f"Another alias with the same name already exists: `{name}`.",
             )
-            return await ctx.send(embed=embed)
 
-        if name in self.bot.snippets:
+        elif name in self.bot.snippets:
             embed = Embed(
                 title="Error",
                 color=Color.red(),
                 description=f"A snippet with the same name already exists: `{name}`.",
             )
-            return await ctx.send(embed=embed)
 
-        if len(name) > 120:
+        elif len(name) > 120:
             embed = Embed(
                 title="Error",
                 color=Color.red(),
                 description=f"Alias names cannot be longer than 120 characters.",
             )
+
+        if embed is not None:
             return await ctx.send(embed=embed)
 
         values = parse_alias(value)
@@ -1106,7 +1113,7 @@ async def alias_add(self, ctx, name: str.lower, *, value):
                     return await ctx.send(embed=embed)
                 embed.description += f"\n{i}: {val}"
 
-        self.bot.aliases[name] = "&&".join(values)
+        self.bot.aliases[name] = " && ".join(values)
         await self.bot.config.update()
 
         return await ctx.send(embed=embed)
@@ -1217,10 +1224,9 @@ async def permissions(self, ctx):
     def _verify_user_or_role(user_or_role):
         if hasattr(user_or_role, "id"):
             return user_or_role.id
-        elif user_or_role in {"everyone", "all"}:
+        if user_or_role in {"everyone", "all"}:
             return -1
-        else:
-            raise commands.BadArgument(f'User or Role "{user_or_role}" not found')
+        raise commands.BadArgument(f'User or Role "{user_or_role}" not found')
 
     @staticmethod
     def _parse_level(name):

core/checks.py

@@ -33,7 +33,7 @@ async def predicate(ctx):
 
         if not has_perm and ctx.command.qualified_name != "help":
             logger.error(
-                "You does not have permission to use this command: `%s` (%s).",
+                "You do not have permission to use this command: `%s` (%s).",
                 str(ctx.command.qualified_name),
                 str(permission_level.name),
             )
@@ -43,7 +43,7 @@ async def predicate(ctx):
     return commands.check(predicate)
 
 
-async def check_permissions(  # pylint: disable=R0911
+async def check_permissions(  # pylint: disable=too-many-return-statements
     ctx, command_name, permission_level
 ) -> bool:
     """Logic for checking permissions for a command for a user"""

core/config.py

@@ -3,7 +3,6 @@
 import logging
 import os
 import typing
-from collections import namedtuple
 from copy import deepcopy
 
 from dotenv import load_dotenv
@@ -155,7 +154,6 @@ def populate_cache(self) -> dict:
             os.path.dirname(os.path.abspath(__file__)), "config_help.json"
         )
         with open(config_help_json, "r") as f:
-            Entry = namedtuple("Entry", ["index", "embed"])
             self.config_help = dict(sorted(json.load(f).items()))
 
         return self._cache

core/thread.py

@@ -338,9 +338,9 @@ async def _close(
         )
 
         if isinstance(log_data, dict):
-            prefix = self.bot.config['log_url_prefix'].strip('/')
-            if prefix == 'NONE':
-                prefix = ''
+            prefix = self.bot.config["log_url_prefix"].strip("/")
+            if prefix == "NONE":
+                prefix = ""
             log_url = f"{self.bot.config['log_url'].strip('/')}{'/' + prefix if prefix else ''}/{log_data['key']}"
 
             if log_data["messages"]:
@@ -410,7 +410,9 @@ async def _close(
         await asyncio.gather(*tasks)
 
     async def cancel_closure(
-        self, auto_close: bool = False, all: bool = False  # pylint: disable=W0622
+        self,
+        auto_close: bool = False,
+        all: bool = False,  # pylint: disable=redefined-builtin
     ) -> None:
         if self.close_task is not None and (not auto_close or all):
             self.close_task.cancel()
@@ -746,8 +748,7 @@ async def send(
             file_upload_count += 1
 
         if from_mod:
-            # noinspection PyUnresolvedReferences,PyDunderSlots
-            embed.color = self.bot.mod_color  # pylint: disable=E0237
+            embed.colour = self.bot.mod_color
             # Anonymous reply sent in thread channel
             if anonymous and isinstance(destination, discord.TextChannel):
                 embed.set_footer(text="Anonymous Reply")
@@ -760,12 +761,10 @@ async def send(
             else:
                 embed.set_footer(text=self.bot.config["anon_tag"])
         elif note:
-            # noinspection PyUnresolvedReferences,PyDunderSlots
-            embed.color = discord.Color.blurple()  # pylint: disable=E0237
+            embed.colour = discord.Color.blurple()
         else:
             embed.set_footer(text=f"Recipient")
-            # noinspection PyUnresolvedReferences,PyDunderSlots
-            embed.color = self.bot.recipient_color  # pylint: disable=E0237
+            embed.colour = self.bot.recipient_color
 
         try:
             await destination.trigger_typing()

core/utils.py

@@ -2,7 +2,8 @@
 import shlex
 import typing
 from difflib import get_close_matches
-from distutils.util import strtobool as _stb  # pylint: disable=E0401
+from distutils.util import strtobool as _stb
+from itertools import takewhile
 from urllib import parse
 
 import discord
@@ -37,7 +38,7 @@ async def convert(self, ctx, argument):
         return discord.Object(int(match.group(1)))
 
 
-def truncate(text: str, max: int = 50) -> str:  # pylint: disable=W0622
+def truncate(text: str, max: int = 50) -> str:  # pylint: disable=redefined-builtin
     """
     Reduces the string to `max` length, by trimming the message into "...".
 
@@ -253,3 +254,10 @@ def parse_alias(alias):
     if not all(cmd):
         return []
     return cmd
+
+
+def format_description(i, names):
+    return "\n".join(
+        ": ".join((str(a + i * 15), b))
+        for a, b in enumerate(takewhile(lambda x: x is not None, names), start=1)
+    )