Gipsy v1.5

.github/FUNDING.yml

@@ -1 +1 @@
-patreon: gunivers
+custom: https://altearn.xyz/soutenir/

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: ":arrow_up: deps:"
+      include: "scope"
+  - package-ecosystem: "pip"
+    directory: "/docs"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: ":arrow_up: docs:"
+      include: "scope"

.github/workflows/qodana_code_quality.yml

@@ -0,0 +1,19 @@
+name: Qodana
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - monitoring
+
+jobs:
+  qodana:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: 'Qodana Scan'
+        uses: JetBrains/[email protected]
+        env:
+          QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

.pylintrc

@@ -0,0 +1,4 @@
+[MASTER]
+
+# resolve import issues for local modules
+init-hook='import sys; sys.path.append(".")'

README.md

@@ -20,4 +20,8 @@ Gipsy is modular, free and open-source Discord bot whose focus on accessibility
 
 *This button redirect you to a more complete presentation with invitation links, list of features, self-hosting instructions and more.*
 
-</div>
+</div>
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=curiosity-org/gipsy&type=Date)](https://star-history.com/#curiosity-org/gipsy&Date)

bot/__init__.py

@@ -3,4 +3,4 @@
 respectant les principes de diffusion des logiciels libres. Vous pouvez
 utiliser, modifier et/ou redistribuer ce programme sous les conditions
 de la licence CeCILL diffusée sur le site "http://www.cecill.info".
-"""
+"""

bot/args.py

@@ -5,41 +5,44 @@
 de la licence CeCILL diffusée sur le site "http://www.cecill.info".
 """
 
-import discord
 import re
+
 from discord.ext import commands
+
 from utils import MyContext
 
 
-class tempdelta(commands.Converter):
-    async def convert(self, ctx: MyContext, argument: str) -> int:
-        d = 0
+class tempdelta(commands.Converter):  # pylint: disable=invalid-name
+    async def convert(
+        self, ctx: MyContext, argument: str
+    ) -> int:  # pylint: disable=unused-argument
+        time = 0
         found = False
-        for x in [
+        for time_spec in [
             ("y", 86400 * 365),
             ("w", 604800),
             ("d", 86400),
             ("h", 3600),
             ("m", 60),
             ("min", 60),
         ]:
-            r = re.search(r"^(\d+)" + x[0] + "$", argument)
-            if r is not None:
-                d += int(r.group(1)) * x[1]
+            pattern = re.search(r"^(\d+)" + time_spec[0] + "$", argument)
+            if pattern is not None:
+                time += int(pattern.group(1)) * time_spec[1]
                 found = True
-        r = re.search(r"^(\d+)h(\d+)m?$", argument)
-        if r is not None:
-            d += int(r.group(1)) * 3600 + int(r.group(2)) * 60
+        pattern = re.search(r"^(\d+)h(\d+)m?$", argument)
+        if pattern is not None:
+            time += int(pattern.group(1)) * 3600 + int(pattern.group(2)) * 60
             found = True
         if not found:
             raise commands.errors.BadArgument("Invalid duration: " + argument)
-        return d
+        return time
 
 
-class moderatorFlag(commands.Converter):
+class moderatorFlag(commands.Converter):  # pylint: disable=invalid-name
     async def convert(self, ctx: MyContext, argument: str) -> str:
-        LogsFlags = ctx.bot.get_cog("ConfigCog").LogsFlags.FLAGS
-        if argument not in LogsFlags.values():
+        logs_flags = ctx.bot.get_cog("ConfigCog").LogsFlags.FLAGS
+        if argument not in logs_flags.values():
             raise commands.errors.BadArgument("Invalid moderation flag: " + argument)
         return argument
 
@@ -48,15 +51,19 @@
     class Constant(commands.Converter):
         w = word
 
-        async def convert(self, ctx: MyContext, arg: str):
+        async def convert(
+            self, ctx: MyContext, arg: str
+        ):  # pylint: disable=unused-argument
             if arg != self.w:
                 raise commands.errors.BadArgument("Unknown argument")
 
     return Constant
 
 
-class arguments(commands.Converter):
-    async def convert(self, ctx: MyContext, argument: str) -> dict:
+class arguments(commands.Converter):  # pylint: disable=invalid-name
+    async def convert(
+        self, ctx: MyContext, argument: str
+    ) -> dict:  # pylint: disable=unused-argument
         answer = dict()
         for result in re.finditer(r"(\w+) ?= ?\"((?:[^\"\\]|\\\"|\\)+)\"", argument):
             answer[result.group(1)] = result.group(2).replace('\\"', '"')

bot/checks.py

@@ -6,6 +6,7 @@
 """
 
 import discord
+
 from utils import MyContext, CheckException
 from core import config
 
@@ -48,9 +49,11 @@ async def is_roles_manager(ctx: MyContext):
 
 
 async def can_group(ctx: MyContext):
-    config = ctx.bot.server_configs[ctx.guild.id]
-    if config["group_allowed_role"] is None:
+    server_config = ctx.bot.server_configs[ctx.guild.id]
+    if server_config["group_allowed_role"] is None:
         return True
-    role = discord.utils.get(ctx.message.guild.roles, id=config["group_allowed_role"])
+    role = discord.utils.get(
+        ctx.message.guild.roles, id=server_config["group_allowed_role"]
+    )
     if role in ctx.author.roles:
         return True

bot/utils/configManager.py

@@ -7,49 +7,49 @@
 
 import os
 from json import dump, load
-from utils import Gunibot
 
 from discord.ext import commands
-from utils import CONFIG_OPTIONS
+
+from utils import Gunibot, CONFIG_OPTIONS
 
 CONFIG_FOLDER = "configs"
 
 CONFIG_TEMPLATE = {k: v["default"] for k, v in CONFIG_OPTIONS.items() if "default" in v}
 
 
-class serverConfig(dict):
-    def __init__(self, manager, serverID, value):
+class ServerConfig(dict):
+    def __init__(self, manager, server_id, value):
         super().__init__(value)
         self.manager = manager
-        self.serverID = serverID
+        self.server_id = server_id
 
     def __getitem__(self, key):
         try:
             return super().__getitem__(key)
-        except KeyError as e:
+        except KeyError as exc:
             if key in CONFIG_TEMPLATE.keys():
                 return CONFIG_TEMPLATE[key]
-            raise e
+            raise exc
 
     def __setitem__(self, key, item):
         if key in CONFIG_TEMPLATE.keys():
             super().__setitem__(key, item)
-            self.manager[self.serverID] = self
+            self.manager[self.server_id] = self
         else:
             raise ValueError("Invalid config key")
 
     def __delitem__(self, key):
         super().__setitem__(key, CONFIG_TEMPLATE[key])
-        self.manager[self.serverID] = self
+        self.manager[self.server_id] = self
 
 
 class ConfigCog(commands.Cog):
     def __init__(self, bot):
         self.bot = bot
         self.file = "configManager"
-        self.confManager = self.configManager()
+        self.conf_manager = self.ConfigManager()
 
-    class configManager(dict):
+    class ConfigManager(dict):
         def __init__(self):
             super().__init__()
             self.cache = dict()
@@ -67,7 +67,7 @@ def __getitem__(self, key):
             if not (isinstance(key, int) or key.isnumeric()):
                 raise ValueError("Key need to be a valid guild ID")
             result = dict(CONFIG_TEMPLATE)
-            if key not in self.cache.keys():
+            if key not in self.cache:
                 try:
                     with open(f"{CONFIG_FOLDER}/{key}.json", "r", encoding="utf8") as f:
                         self.cache[key] = load(f)
@@ -76,7 +76,7 @@ def __getitem__(self, key):
             result.update(self.cache[key])
             allowed_keys = CONFIG_TEMPLATE.keys()
             result = {k: v for k, v in result.items() if k in allowed_keys}
-            return serverConfig(self, key, result)
+            return ServerConfig(self, key, result)
 
         def __repr__(self):
             return "<configManager>"
@@ -95,11 +95,11 @@ def has_key(self, k):
         def update(self, *args, **kwargs):
             for arg in args:
                 if isinstance(arg, dict):
-                    for k, v in arg.items():
-                        self.__setitem__(k, v)
+                    for key, value in arg.items():
+                        self[key] = value
             for kwarg in kwargs:
-                for k, v in kwarg.items():
-                    self.__setitem__(k, v)
+                for key, value in kwarg.items():
+                    self[key] = value
 
         def keys(self):
             return [name for name in os.listdir(CONFIG_FOLDER) if os.path.isfile(name)]
@@ -129,16 +129,16 @@ class LogsFlags:
             1 << 8: "emojis",
         }
 
-        def flagsToInt(self, flags: list) -> int:
+        def flags_to_int(self, flags: list) -> int:
             r = 0
             for k, v in self.FLAGS.items():
                 if v in flags:
                     r |= k
             return r
 
-        def intToFlags(self, i: int) -> list:
+        def int_to_flags(self, i: int) -> list:
             return [v for k, v in self.FLAGS.items() if i & k == k]
 
 
-async def setup(bot: Gunibot = None, plugin_config: dict = None):
+async def setup(bot: Gunibot = None):
     await bot.add_cog(ConfigCog(bot))