Merge branch 'master' of https://github.com/verixx/modmail

Author: kyb3r

cogs/modmail.py

@@ -60,9 +60,10 @@ async def setup(self, ctx):
             color=self.bot.main_color
         )
 
-        embed.add_field(name='Thanks for using the bot!', value='If you like what you see, '
-        'consider giving the [repo a star](https://github.com/kyb3r/modmail) :star: or if you are '
-        'feeling generous, check us out on [Patreon](https://patreon.com/kyber)!')
+        embed.add_field(name='Thanks for using the bot!',
+                        value='If you like what you see, consider giving the '
+                              '[repo a star](https://github.com/kyb3r/modmail) :star: or if you are '
+                              'feeling generous, check us out on [Patreon](https://patreon.com/kyber)!')
 
         embed.set_footer(text=f'Type "{self.bot.prefix}help" '
                               'for a complete list of commands.')

cogs/plugins.py

@@ -1,24 +1,25 @@
 import importlib
+import json
 import logging
 import os
+import random
 import shutil
 import site
 import stat
 import subprocess
 import sys
-import json
-from pkg_resources import parse_version
 from difflib import get_close_matches
-import random
 
 import discord
 from discord.ext import commands
 from discord.utils import async_all
 
+from pkg_resources import parse_version
+
 from core import checks
 from core.models import PermissionLevel
-from core.utils import info, error
 from core.paginator import PaginatorSession
+from core.utils import info, error
 
 logger = logging.getLogger('Modmail')
 
@@ -146,37 +147,37 @@ async def plugin_add(self, ctx, *, plugin_name: str):
         """Add a plugin."""
 
         if plugin_name in self.registry:
-            info = self.registry[plugin_name]
-            plugin_name = info['repository'] + '/' + plugin_name
-            required_version = info['bot_version']
+            details = self.registry[plugin_name]
+            plugin_name = details['repository'] + '/' + plugin_name
+            required_version = details['bot_version']
 
             if parse_version(self.bot.version) < parse_version(required_version):
-                em = discord.Embed(
+                embed = discord.Embed(
                     description=f'Your bot\'s version is too low. This plugin requires version `{required_version}`.',
                     color=self.bot.main_color
                 )
-                return await ctx.send(embed=em)
+                return await ctx.send(embed=embed)
 
         if plugin_name in self.bot.config.plugins:
-            em = discord.Embed(
+            embed = discord.Embed(
                 description='This plugin is already installed.',
                 color=self.bot.main_color
             )
-            return await ctx.send(embed=em)
+            return await ctx.send(embed=embed)
 
         if plugin_name in self.bot.cogs.keys():
             # another class with the same name
-            em = discord.Embed(
+            embed = discord.Embed(
                 description='There\'s another cog installed with the same name.',
                 color=self.bot.main_color
             )
-            return await ctx.send(embed=em)
+            return await ctx.send(embed=embed)
 
-        em = discord.Embed(
+        embed = discord.Embed(
             description='Downloading this plugin...',
             color=self.bot.main_color
         )
-        message = await ctx.send(embed=em)
+        message = await ctx.send(embed=embed)
 
         async with ctx.typing():
             if len(plugin_name.split('/')) >= 3:
@@ -185,50 +186,50 @@ async def plugin_add(self, ctx, *, plugin_name: str):
                 try:
                     await self.download_plugin_repo(*parsed_plugin[:-1])
                 except DownloadError as exc:
-                    em = discord.Embed(
+                    embed = discord.Embed(
                         description=f'Unable to fetch this plugin from Github: {exc}.',
                         color=self.bot.main_color
                     )
-                    return await ctx.send(embed=em)
+                    return await ctx.send(embed=embed)
 
                 importlib.invalidate_caches()
 
                 try:
                     await self.load_plugin(*parsed_plugin)
                 except DownloadError as exc:
-                    em = discord.Embed(
+                    embed = discord.Embed(
                         description=f'Unable to load this plugin: {exc}.',
                         color=self.bot.main_color
                     )
-                    return await ctx.send(embed=em)
+                    return await ctx.send(embed=embed)
 
                 # if it makes it here, it has passed all checks and should
                 # be entered into the config
 
                 self.bot.config.plugins.append(plugin_name)
                 await self.bot.config.update()
 
-                em = discord.Embed(
+                embed = discord.Embed(
                     description='The plugin is installed.\n'
                                 '*Please note: any plugin that you install is of your OWN RISK*',
                     color=self.bot.main_color
                 )
-                await message.edit(embed=em)
+                await message.edit(embed=embed)
             else:
-                em = discord.Embed(
+                embed = discord.Embed(
                     description='Invalid plugin name format: use username/repo/plugin.',
                     color=self.bot.main_color
                 )
-                await message.edit(embed=em)
+                await message.edit(embed=embed)
 
     @plugin.command(name='remove', aliases=['del', 'delete', 'rm'])
     @checks.has_permissions(PermissionLevel.OWNER)
     async def plugin_remove(self, ctx, *, plugin_name: str):
         """Remove a plugin."""
 
         if plugin_name in self.registry:
-            info = self.registry[plugin_name]
-            plugin_name = info['repository'] + '/' + plugin_name
+            details = self.registry[plugin_name]
+            plugin_name = details['repository'] + '/' + plugin_name
 
         if plugin_name in self.bot.config.plugins:
             try:
@@ -241,6 +242,7 @@ async def plugin_remove(self, ctx, *, plugin_name: str):
             self.bot.config.plugins.remove(plugin_name)
 
             try:
+                # BUG: Local variables 'username' and 'repo' might be referenced before assignment
                 if not any(i.startswith(f'{username}/{repo}')
                            for i in self.bot.config.plugins):
                     # if there are no more of such repos, delete the folder
@@ -258,33 +260,33 @@ def onerror(func, path, exc_info):  # pylint: disable=W0613
 
             await self.bot.config.update()
 
-            em = discord.Embed(
+            embed = discord.Embed(
                 description='The plugin is uninstalled and all its data is erased.',
                 color=self.bot.main_color
             )
-            await ctx.send(embed=em)
+            await ctx.send(embed=embed)
         else:
-            em = discord.Embed(
+            embed = discord.Embed(
                 description='That plugin is not installed.',
                 color=self.bot.main_color
             )
-            await ctx.send(embed=em)
+            await ctx.send(embed=embed)
 
     @plugin.command(name='update')
     @checks.has_permissions(PermissionLevel.OWNER)
     async def plugin_update(self, ctx, *, plugin_name: str):
         """Update a plugin."""
 
         if plugin_name in self.registry:
-            info = self.registry[plugin_name]
-            plugin_name = info['repository'] + '/' + plugin_name
+            details = self.registry[plugin_name]
+            plugin_name = details['repository'] + '/' + plugin_name
 
         if plugin_name not in self.bot.config.plugins:
-            em = discord.Embed(
+            embed = discord.Embed(
                 description='That plugin is not installed.',
                 color=self.bot.main_color
             )
-            return await ctx.send(embed=em)
+            return await ctx.send(embed=embed)
 
         async with ctx.typing():
             username, repo, name = self.parse_plugin(plugin_name)
@@ -295,20 +297,20 @@ async def plugin_update(self, ctx, *, plugin_name: str):
             except subprocess.CalledProcessError as exc:
                 err = exc.stderr.decode('utf8').strip()
 
-                em = discord.Embed(
+                embed = discord.Embed(
                     description=f'An error occured while updating: {err}.',
                     color=self.bot.main_color
                 )
-                await ctx.send(embed=em)
+                await ctx.send(embed=embed)
 
             else:
                 output = cmd.stdout.decode('utf8').strip()
 
-                em = discord.Embed(
+                embed = discord.Embed(
                     description=f'```\n{output}\n```',
                     color=self.bot.main_color
                 )
-                await ctx.send(embed=em)
+                await ctx.send(embed=embed)
 
                 if output != 'Already up to date.':
                     # repo was updated locally, now perform the cog reload
@@ -331,17 +333,17 @@ async def plugin_enabled(self, ctx):
 
         if self.bot.config.plugins:
             msg = '```\n' + '\n'.join(self.bot.config.plugins) + '\n```'
-            em = discord.Embed(
+            embed = discord.Embed(
                 description=msg,
                 color=self.bot.main_color
             )
-            await ctx.send(embed=em)
+            await ctx.send(embed=embed)
         else:
-            em = discord.Embed(
+            embed = discord.Embed(
                 description='There are no plugins installed.',
                 color=self.bot.main_color
             )
-            await ctx.send(embed=em)
+            await ctx.send(embed=embed)
 
     @plugin.group(invoke_without_command=True, name='registry', aliases=['list'])
     @checks.has_permissions(PermissionLevel.OWNER)
@@ -366,40 +368,40 @@ def find_index(name):
         if plugin_name in self.registry:
             index = find_index(plugin_name)
         elif plugin_name is not None:
-            em = discord.Embed(
+            embed = discord.Embed(
                 color=discord.Color.red(),
                 description=f'Could not find a plugin with name "{plugin_name}" within the registry.'
             )
 
             matches = get_close_matches(plugin_name, self.registry.keys())
 
             if matches:
-                em.add_field(name='Perhaps you meant:', value='\n'.join(f'`{m}`' for m in matches))
+                embed.add_field(name='Perhaps you meant:', value='\n'.join(f'`{m}`' for m in matches))
 
-            return await ctx.send(embed=em)
+            return await ctx.send(embed=embed)
 
-        for name, info in registry:
-            repo = f"https://github.com/{info['repository']}"
+        for name, details in registry:
+            repo = f"https://github.com/{details['repository']}"
             url = f"{repo}/tree/master/{name}"
 
-            em = discord.Embed(
+            embed = discord.Embed(
                 color=self.bot.main_color,
-                description=info['description'],
+                description=details['description'],
                 url=repo,
-                title=info['repository']
+                title=details['repository']
                 )
 
-            em.add_field(
+            embed.add_field(
                 name='Installation',
                 value=f'```{self.bot.prefix}plugins add {name}```')
 
-            em.set_author(name=info['title'], icon_url=info.get('icon_url'), url=url)
-            if info.get('thumbnail_url'):
-                em.set_thumbnail(url=info.get('thumbnail_url'))
-            if info.get('image_url'):
-                em.set_image(url=info.get('image_url'))
+            embed.set_author(name=details['title'], icon_url=details.get('icon_url'), url=url)
+            if details.get('thumbnail_url'):
+                embed.set_thumbnail(url=details.get('thumbnail_url'))
+            if details.get('image_url'):
+                embed.set_image(url=details.get('image_url'))
 
-            embeds.append(em)
+            embeds.append(embed)
 
         paginator = PaginatorSession(ctx, *embeds)
         paginator.current = index
@@ -416,10 +418,10 @@ async def plugin_registry_compact(self, ctx):
 
         pages = ['']
 
-        for name, info in registry:
-            repo = f"https://github.com/{info['repository']}"
+        for name, details in registry:
+            repo = f"https://github.com/{details['repository']}"
             url = f"{repo}/tree/master/{name}"
-            desc = info['description'].replace('\n', '')
+            desc = details['description'].replace('\n', '')
             fmt = f"[`{name}`]({url}) - {desc}"
             length = len(fmt) - len(url) - 4
             fmt = fmt[:75 + len(url)].strip() + '...' if length > 75 else fmt
@@ -431,12 +433,12 @@ async def plugin_registry_compact(self, ctx):
         embeds = []
 
         for page in pages:
-            em = discord.Embed(
+            embed = discord.Embed(
                 color=self.bot.main_color,
                 description=page,
                 )
-            em.set_author(name='Plugin Registry', icon_url=self.bot.user.avatar_url)
-            embeds.append(em)
+            embed.set_author(name='Plugin Registry', icon_url=self.bot.user.avatar_url)
+            embeds.append(embed)
 
         paginator = PaginatorSession(ctx, *embeds)
         await paginator.run()

cogs/utility.py

@@ -233,6 +233,9 @@ async def about(self, ctx):
                         value='https://github.com/kyb3r/modmail',
                         inline=False)
 
+        embed.add_field(name='\u200b',
+                        value='Support this bot on [Patreon](https://patreon.com/kyber).')
+
         embed.set_footer(text=footer)
         await ctx.send(embed=embed)
 
@@ -680,7 +683,7 @@ async def config(self, ctx):
         - `{prefix}config set varname value here`
 
         To remove a configuration variable:
-        - `{prefix}config set remove varname`
+        - `{prefix}config remove varname`
         """
         await ctx.send_help(ctx.command)
 
@@ -816,7 +819,7 @@ async def alias(self, ctx):
         - `{prefix}alias add alias-name other-command`
 
         For example:
-        - `{prefix}alias add reply r`
+        - `{prefix}alias add r reply`
         - Now you can use `{prefix}r` as an replacement for `{prefix}reply`.
 
         See also `{prefix}snippets`.
@@ -1263,7 +1266,8 @@ async def oauth(self, ctx):
     @oauth.command(name='whitelist')
     @checks.has_permissions(PermissionLevel.OWNER)
     async def oauth_whitelist(self, ctx, target: Union[User, Role]):
-        """Whitelist or un-whitelist a user or role to have access to logs.
+        """
+        Whitelist or un-whitelist a user or role to have access to logs.
 
         `target` may be a role ID, name, mention, user ID, name, or mention.
         """