Add new mention_message config, black + ruff

.github/workflows/docker-image.yml

@@ -1,10 +1,10 @@
 
-name: Create and publish a Docker image
+name: Docker Image
 
 on:
   push:
     branches:
-      - 'main'
+      - 'stable'
       - 'develop'
     tags:
       - 'v*'

.github/workflows/lints.yml

@@ -1,4 +1,4 @@
-name: Modmail Workflow
+name: Checks
 
 on: [push, pull_request]
 
@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10']
+        python-version: ['3.10']
 
     name: Python ${{ matrix.python-version }} on ubuntu-latest
 
@@ -22,8 +22,8 @@ jobs:
       run: |
         python -m pip install --upgrade pip pipenv
         pipenv install --dev --system
-    - name: Pylint
-      run: pylint ./bot.py cogs/*.py core/*.py  --exit-zero -r y
+    - name: Ruff
+      run: ruff . --no-fix
       continue-on-error: true
     - name: Black
       run: |

CHANGELOG.md

@@ -21,6 +21,7 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 - New .env config option: `REGISTRY_PLUGINS_ONLY`, restricts to only allow adding registry plugins. ([PR #3247](https://github.com/modmail-dev/modmail/pull/3247))
 - Added custom database name detection in `CONNECTION_URI`
 - Added dpy and python version info in `?about` embed and credit for contributors
+- New config option: `mention_message`, this will include an additional configurable message next to role mention on thread creation. Defaults to None.
 
 ### Changed
 - Guild icons in embed footers and author urls now have a fixed size of 128. ([PR #3261](https://github.com/modmail-dev/modmail/pull/3261))

Pipfile

@@ -5,8 +5,8 @@ verify_ssl = true
 
 [dev-packages]
 black = "==22.3.0"
-pylint = "~=2.9.3"
 typing-extensions = "==4.2.0"
+ruff = "*"
 
 [packages]
 aiohttp = "==3.8.1"

bot.py

@@ -6,26 +6,25 @@
 import hashlib
 import logging
 import os
+import platform
 import re
 import string
 import struct
 import sys
-import platform
 import typing
 from datetime import datetime, timezone
 from subprocess import PIPE
 from types import SimpleNamespace
 
 import discord
 import isodate
-from aiohttp import ClientSession, ClientResponseError
+from aiohttp import ClientResponseError, ClientSession
 from discord.ext import commands, tasks
-from discord.ext.commands.view import StringView
 from discord.ext.commands import MemberConverter
+from discord.ext.commands.view import StringView
 from emoji import UNICODE_EMOJI
 from pkg_resources import parse_version
 
-
 try:
     # noinspection PyUnresolvedReferences
     from colorama import init

cogs/modmail.py

@@ -1,19 +1,18 @@
 import asyncio
 import re
-from datetime import datetime, timezone
+from datetime import timezone
 from itertools import zip_longest
-from typing import Optional, Union, List, Tuple, Literal
 from types import SimpleNamespace
+from typing import List, Literal, Optional, Tuple, Union
 
 import discord
+from dateutil import parser
 from discord.ext import commands
-from discord.ext.commands.view import StringView
 from discord.ext.commands.cooldowns import BucketType
+from discord.ext.commands.view import StringView
 from discord.role import Role
 from discord.utils import escape_markdown
 
-from dateutil import parser
-
 from core import checks
 from core.models import DMDisabled, PermissionLevel, SimilarCategoryConverter, getLogger
 from core.paginator import EmbedPaginatorSession
@@ -1647,7 +1646,6 @@ async def blocked(self, ctx):
 
         roles = []
         users = []
-        now = ctx.message.created_at
 
         blocked_users = list(self.bot.blocked_users.items())
         for id_, reason in blocked_users:

cogs/plugins.py

@@ -6,22 +6,21 @@
 import sys
 import typing
 import zipfile
-from importlib import invalidate_caches
 from difflib import get_close_matches
+from importlib import invalidate_caches
 from pathlib import Path, PurePath
 from re import match
 from site import USER_SITE
 from subprocess import PIPE
 
 import discord
 from discord.ext import commands
-
 from pkg_resources import parse_version
 
 from core import checks
 from core.models import PermissionLevel, getLogger
 from core.paginator import EmbedPaginatorSession
-from core.utils import truncate, trigger_typing
+from core.utils import trigger_typing, truncate
 
 logger = getLogger(__name__)
 

cogs/utility.py

@@ -3,8 +3,8 @@
 import os
 import random
 import re
-import traceback
 import sys
+import traceback
 from contextlib import redirect_stdout
 from difflib import get_close_matches
 from io import BytesIO, StringIO
@@ -24,16 +24,9 @@
 
 from core import checks, utils
 from core.changelog import Changelog
-from core.models import (
-    HostingMethod,
-    InvalidConfigError,
-    PermissionLevel,
-    UnseenFormatter,
-    getLogger,
-)
-from core.utils import trigger_typing, truncate
+from core.models import HostingMethod, InvalidConfigError, PermissionLevel, UnseenFormatter, getLogger
 from core.paginator import EmbedPaginatorSession, MessagePaginatorSession
-
+from core.utils import trigger_typing, truncate
 
 logger = getLogger(__name__)
 
@@ -333,7 +326,6 @@ async def about(self, ctx):
         desc += "an organised manner."
         embed.description = desc
 
-        repo_url = "https://github.com/modmail-dev/modmail/graphs/contributors"
         python_version = "{}.{}.{}".format(*sys.version_info[:3])
         dpy_version = discord.__version__
 
@@ -710,6 +702,13 @@ async def mention(self, ctx, *user_or_role: Union[discord.Role, discord.Member,
 
         Do not ping `@everyone` to set mention to everyone, use "everyone" or "all" instead.
 
+        You can also additionally configure a custom message to show after the mention.
+        You can use `[prefix]` as placeholder for bot prefix.
+
+        Examples:
+        - `{prefix}mention message Use [prefix]reply to reply`
+        - `{prefix}mention message disable`
+
         Notes:
         - Type only `{prefix}mention` to retrieve your current "mention" message.
         - `{prefix}mention disable` to disable mention.
@@ -720,6 +719,24 @@ async def mention(self, ctx, *user_or_role: Union[discord.Role, discord.Member,
             embed = discord.Embed(
                 title="Current mention:", color=self.bot.main_color, description=str(current)
             )
+        elif isinstance(user_or_role[0], str) and user_or_role[0].lower() in ("message", "msg"):
+            option = user_or_role[1].lower()
+            if option == "disable":
+                embed = discord.Embed(
+                    description="Disabled mention message on thread creation.",
+                    color=self.bot.main_color,
+                )
+                self.bot.config["mention_message"] = None
+            else:
+                msg = " ".join(user_or_role[1:])
+                mention_msg = msg.replace("[prefix]", self.bot.prefix)
+                embed = discord.Embed(
+                    title="Changed mention message!",
+                    description=f'On thread creation the bot now says "{current} {mention_msg}".',
+                    color=self.bot.main_color,
+                )
+                self.bot.config["mention_message"] = msg
+            await self.bot.config.update()
         elif (
             len(user_or_role) == 1
             and isinstance(user_or_role[0], str)

core/clients.py

@@ -1,13 +1,12 @@
 import secrets
 import sys
 from json import JSONDecodeError
-from typing import Any, Dict, Union, Optional
+from typing import Any, Dict, Optional, Union
 
 import discord
-from discord import Member, DMChannel, TextChannel, Message
+from aiohttp import ClientResponse, ClientResponseError
+from discord import DMChannel, Member, Message, TextChannel
 from discord.ext import commands
-
-from aiohttp import ClientResponseError, ClientResponse
 from motor.motor_asyncio import AsyncIOMotorClient
 from pymongo.errors import ConfigurationError
 from pymongo.uri_parser import parse_uri