comprobot 2.3.0__tar.gz → 2.3.2__tar.gz

{comprobot-2.3.0 → comprobot-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comprobot
-Version: 2.3.0
+Version: 2.3.2
 Summary: A self-hostable Discord bot built for maximum customization.
 Author: badluma
 License: MIT

{comprobot-2.3.0 → comprobot-2.3.2}/comprobot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: comprobot
-Version: 2.3.0
+Version: 2.3.2
 Summary: A self-hostable Discord bot built for maximum customization.
 Author: badluma
 License: MIT

{comprobot-2.3.0 → comprobot-2.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "comprobot"
-version = "2.3.0"
+version = "2.3.2"
 authors = [{name = "badluma"}]
 description = "A self-hostable Discord bot built for maximum customization."
 readme = "README.md"

{comprobot-2.3.0 → comprobot-2.3.2}/src/__main__.py

@@ -14,7 +14,8 @@ def main():
         description="A self-hostable open-source Discord bot built for maximum customization.",
     )
     subparsers = parser.add_subparsers(dest="command", metavar="")
-    subparsers.add_parser("start", help="Start the bot.")
+    start_parser = subparsers.add_parser("start", help="Start the bot.")
+    start_parser.add_argument("--daemon", action="store_true", help="Daemonize the process.")
     subparsers.add_parser("onboard", help="Set up Comprobot for the first time.")
     config_parser = subparsers.add_parser("config", help="Configure the bot's settings.")
     config_parser.add_argument("config_args", nargs=argparse.REMAINDER)
@@ -25,7 +26,7 @@ def main():
 
     match args.command:
         case "start":
-            start()
+            start(daemon=getattr(args, "daemon", False))
         case "onboard":
             settings = onboarding()
 

{comprobot-2.3.0 → comprobot-2.3.2}/src/api.py

@@ -29,7 +29,7 @@ def access_api(url, parameter, error_message, headers=None):
 # ---------- Commands ----------
 def quote():
     try:
-        quote_response = requests.get("https://zenquotes.io/api/random")
+        quote_response = requests.get("https://zenquotes.io/api/random", timeout=10)
     except requests.exceptions.RequestException as e:
         return f"{error_messages['quote']} ({e})"
     if quote_response.status_code != 200:
@@ -143,8 +143,8 @@ def bible(
                     choice(output["general"]["bible"])
                     .replace(r"{{PASSAGE}}", verse["text"].strip())
                     .replace(r"{{BOOK}}", verse["book"].strip())
-                    .replace(r"{{CHAPTER}}", str(verse["chapter"].strip()))
-                    .replace(r"{{VERSE}}", str(verse["verse"].strip()))
+                    .replace(r"{{CHAPTER}}", str(verse["chapter"]).strip())
+                    .replace(r"{{VERSE}}", str(verse["verse"]).strip())
                 )
             elif "text" in data and "reference" in data:
                 parts = data["reference"].split()

{comprobot-2.3.0 → comprobot-2.3.2}/src/commands.py

@@ -23,15 +23,10 @@ def calculate(calculation):
 
 def help(category=None):
     if not category:
-        message = "# Commands"
+        message = "# Categories"
+
         for category in list(keywords.keys()):
-            message += f"\n## {category.title()}\n"
-            for command in list(keywords[category].keys()):
-                if active.get(command, True):
-                    message += f"\n**{config["prefix"]}{keywords[category][command][0]}** - {descriptions[category][command]}"
-                    if len(keywords[category][command]) > 1:
-                        message += f"\n-# Aliases: {config["prefix"]}{', '.join(keywords[category][command][1:])}"
-                    message += "\n-# \u200b"
+            message += f"\n**{category.title()}**\n!help {category}\n-# \u200b"
         return message
     else:
         if not category.lower() in list(keywords.keys()):
@@ -39,10 +34,10 @@ def help(category=None):
         message = f"## {category.title()}\n"
         for command in list(keywords[category.lower()].keys()):
             if active.get(command, True):
-                message += f"\n**{config["prefix"]}{keywords[category.lower()][command][0]}** - {descriptions[category.lower()][command]}"
+                message += f"\n**{config['prefix']}{keywords[category.lower()][command][0]}** - {descriptions[category.lower()][command]}"
                 if len(keywords[category.lower()][command]) > 1:
-                    message += f"\n-# Aliases: {config["prefix"]}{', '.join(keywords[category][command][1:])}"
-                message += "\n-# "
+                    message += f"\n-# Aliases: {', '.join(config['prefix'] + alias for alias in keywords[category.lower()][command][1:])}"
+                message += "\n-# \u200b"
         return message
 
 

comprobot-2.3.2/src/data.py

@@ -0,0 +1,159 @@
+import os
+from collections.abc import Mapping
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+
+import appdirs
+import tomlkit
+import tomlkit.exceptions
+
+from . import templates
+
+Migration = Union[Tuple[str, str], Callable]
+
+RENAME_COMMANDS: List[Migration] = [("commands", "general")]
+
+
+def get_data_path(filename: str) -> str:
+    base_dir = appdirs.user_data_dir(appname="Comprobot", appauthor=False)
+    return os.path.join(base_dir, filename)
+
+
+def _write(path: str, data) -> None:
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    with open(path, "w", encoding="utf-8") as f:
+        tomlkit.dump(data, f)
+
+
+def _apply_migrations(data, migrations: List[Migration]) -> bool:
+    changed = False
+    for migration in migrations:
+        if callable(migration):
+            changed |= bool(migration(data))
+        else:
+            old_key, new_key = migration
+            if old_key in data:
+                if new_key not in data:
+                    data[new_key] = data[old_key]
+                del data[old_key]
+                changed = True
+    return changed
+
+
+def _merge_defaults(data, defaults) -> bool:
+    changed = False
+    for key, value in defaults.items():
+        if key not in data:
+            data[key] = value
+            changed = True
+        elif isinstance(value, Mapping) and isinstance(data.get(key), Mapping):
+            changed |= _merge_defaults(data[key], value)
+    return changed
+
+
+def _reorder(data, defaults) -> bool:
+    in_data = set(data.keys())
+    target = [k for k in defaults if k in in_data] + [k for k in in_data if k not in defaults]
+
+    if list(data.keys()) == target:
+        changed = False
+        for key in defaults:
+            if isinstance(defaults[key], Mapping) and isinstance(data.get(key), Mapping):
+                changed |= _reorder(data[key], defaults[key])
+        return changed
+
+    snapshot = {k: data[k] for k in in_data}
+    for key in list(in_data):
+        del data[key]
+    for key in target:
+        data[key] = snapshot[key]
+
+    for key in defaults:
+        if isinstance(defaults[key], Mapping) and isinstance(data.get(key), Mapping):
+            _reorder(data[key], defaults[key])
+
+    return True
+
+
+def _prune(data, defaults) -> bool:
+    changed = False
+    for key in [k for k in data if k not in defaults]:
+        del data[key]
+        changed = True
+    for key, value in defaults.items():
+        if isinstance(value, Mapping) and isinstance(data.get(key), Mapping):
+            changed |= _prune(data[key], value)
+    return changed
+
+
+def load_or_create(
+    path: str,
+    template_content: str,
+    migrations: Optional[List[Migration]] = None,
+    prune_obsolete: bool = True,
+) -> dict:
+    defaults = tomlkit.loads(template_content)
+
+    try:
+        with open(path, "r", encoding="utf-8") as f:
+            data = tomlkit.loads(f.read())
+    except FileNotFoundError:
+        _write(path, defaults)
+        return defaults
+    except tomlkit.exceptions.TOMLKitError:
+        backup = path + ".bak"
+        os.replace(path, backup)
+        print(f"[Comprobot] Corrupt TOML at {path!r} — backed up to {backup!r}, resetting to defaults.")
+        _write(path, defaults)
+        return defaults
+
+    changed = _apply_migrations(data, migrations or [])
+    changed |= _merge_defaults(data, defaults)
+    if prune_obsolete:
+        changed |= _prune(data, defaults)
+    changed |= _reorder(data, defaults)
+
+    if changed:
+        _write(path, data)
+
+    return data
+
+
+def save_toml(data, path: str) -> None:
+    with open(path, "w", encoding="utf-8") as f:
+        tomlkit.dump(data, f)
+
+
+error_messages: Dict[str, str] = load_or_create(
+    get_data_path("error-messages.toml"), templates.error_messages
+)
+config: Dict[str, Any] = load_or_create(
+    get_data_path("config.toml"), templates.config
+)
+keywords: Dict[str, Dict[str, List[str]]] = load_or_create(
+    get_data_path("keywords.toml"), templates.keywords, migrations=RENAME_COMMANDS
+)
+ai: Dict[str, Any] = load_or_create(
+    get_data_path("ai.toml"), templates.ai
+)
+system_prompt_text: str = str(ai["system_prompt"])
+money: Dict[str, Dict[str, int]] = load_or_create(
+    get_data_path("money.toml"), "[members]\n", prune_obsolete=False
+)
+active: Dict[str, bool] = load_or_create(
+    get_data_path("active.toml"), templates.active
+)
+output: Dict[str, Dict[str, List[str]]] = load_or_create(
+    get_data_path("output.toml"), templates.output, migrations=RENAME_COMMANDS
+)
+moderation: Dict[Any, Any] = load_or_create(
+    get_data_path("moderation.toml"), templates.moderation
+)
+descriptions: Dict[str, Dict[str, str]] = load_or_create(
+    get_data_path("descriptions.toml"), templates.descriptions, migrations=RENAME_COMMANDS
+)
+
+env_path = get_data_path(".env")
+if not os.path.isfile(env_path):
+    os.makedirs(os.path.dirname(env_path), exist_ok=True)
+    with open(env_path, "w", encoding="utf-8") as f:
+        f.write(templates.env)

{comprobot-2.3.0 → comprobot-2.3.2}/src/process.py

@@ -61,17 +61,7 @@ class Comprobot(ext_commands.Cog):
     @ext_commands.check(lambda ctx: active["waifu"])
     async def waifu_cmd(self, ctx):
         await ctx.send(api.waifu())
-
-    @ext_commands.group(
-        name=keywords["general"]["image"][0],
-        aliases=keywords["general"]["image"][1:],
-        invoke_without_command=True,
-    )
-    @ext_commands.check(lambda ctx: active["image"])
-    async def image_cmd(self, ctx):
-        await ctx.send(error_messages["missing_argument"])
-
-    @image_cmd.command(
+    @ext_commands.command(
         name=keywords["general"]["duck"][0],
         aliases=keywords["general"]["duck"][1:],
     )
@@ -79,7 +69,7 @@ class Comprobot(ext_commands.Cog):
     async def duck_cmd(self, ctx):
         await ctx.send(api.duck())
 
-    @image_cmd.command(
+    @ext_commands.command(
         name=keywords["general"]["dog"][0],
         aliases=keywords["general"]["dog"][1:],
     )
@@ -87,7 +77,7 @@ class Comprobot(ext_commands.Cog):
     async def dog_cmd(self, ctx):
         await ctx.send(api.dog())
 
-    @image_cmd.command(
+    @ext_commands.command(
         name=keywords["general"]["cat"][0],
         aliases=keywords["general"]["cat"][1:],
     )

{comprobot-2.3.0 → comprobot-2.3.2}/src/start.py

@@ -1,3 +1,4 @@
+import os
 import platform
 import sys
 from os import getenv as os_getenv
@@ -33,6 +34,14 @@ async def _setup_hook():
 client.setup_hook = _setup_hook
 
 
+@client.event
+async def on_message(message):
+    if message.author == client.user:
+        return
+    ctx = await client.get_context(message)
+    await client.invoke(ctx)
+
+
 @client.event
 async def on_ready():
     user_name = client.user.name if client.user else "Unknown"
@@ -40,7 +49,20 @@ async def on_ready():
     para()
 
 
-def start():
+def _daemonize():
+    if os.fork() != 0:
+        os._exit(0)
+    os.setsid()
+    if os.fork() != 0:
+        os._exit(0)
+    devnull = os.open(os.devnull, os.O_RDONLY)
+    os.dup2(devnull, 0)
+    os.close(devnull)
+
+
+def start(daemon=False):
+    if daemon:
+        _daemonize()
     print(
         f"Configuration directory: {appdirs.user_data_dir(appname='Comprobot', appauthor=False)}"
     )

{comprobot-2.3.0 → comprobot-2.3.2}/src/templates.py

@@ -80,7 +80,6 @@ quote             = ["quote"]
 joke              = ["joke"]
 meme              = ["meme"]
 waifu             = ["waifu"]
-image             = ["image", "picture"]
 duck              = ["duck"]
 dog               = ["dog"]
 cat               = ["cat"]
@@ -128,7 +127,6 @@ active = r"""quote             = true
 joke              = true
 meme              = true
 waifu             = true
-image             = true
 duck              = true
 dog               = true
 cat               = true
@@ -157,7 +155,6 @@ quote             = "Get a random inspirational quote."
 joke              = "Get a random two-part joke"
 meme              = "Get a random meme image"
 waifu             = "Compare two random waifu images"
-image             = "Get a random animal image (duck/dog/cat)"
 duck              = "Get a random duck image"
 dog               = "Get a random dog image"
 cat               = "Get a random cat image"

comprobot-2.3.0/src/data.py

@@ -1,87 +0,0 @@
-import os
-from typing import Any, Dict, List
-
-import appdirs
-import tomlkit
-
-from . import templates
-
-
-def get_data_path(filename):
-
-    base_dir = appdirs.user_data_dir(appname="Comprobot", appauthor=False)
-    return os.path.join(base_dir, filename)
-
-
-def ensure_file(path, content):
-
-    os.makedirs(os.path.dirname(path), exist_ok=True)
-    if not os.path.isfile(path):
-        with open(path, "w", encoding="utf-8") as f:
-            f.write(content)
-
-
-def merge_defaults(data, defaults):
-    for key, value in defaults.items():
-        if key not in data:
-            data[key] = value
-        elif isinstance(value, dict) and isinstance(data.get(key), dict):
-            merge_defaults(data[key], value)
-
-
-def migrate_section(data, old_key, new_key):
-    if old_key in data and new_key not in data:
-        data[new_key] = data[old_key]
-        del data[old_key]
-
-
-def load_or_create(path, template_content):
-    try:
-        with open(path, "r", encoding="utf-8") as f:
-            data = tomlkit.loads(f.read())
-    except FileNotFoundError:
-        ensure_file(path, template_content)
-        with open(path, "r", encoding="utf-8") as f:
-            data = tomlkit.loads(f.read())
-
-    migrate_section(data, "commands", "general")
-
-    defaults = tomlkit.loads(template_content)
-    merge_defaults(data, defaults)
-
-    if data != defaults:
-        with open(path, "w", encoding="utf-8") as f:
-            tomlkit.dump(data, f)
-
-    return data
-
-
-error_messages: Dict[str, str] = load_or_create(
-    get_data_path("error-messages.toml"), templates.error_messages
-)
-config: Dict[str, Any] = load_or_create(get_data_path("config.toml"), templates.config)
-keywords: Dict[str, Dict[str, List[str]]] = load_or_create(
-    get_data_path("keywords.toml"), templates.keywords
-)
-ai: Dict[str, Any] = load_or_create(get_data_path("ai.toml"), templates.ai)
-system_prompt_text: str = str(ai["system_prompt"])
-money: Dict[str, Dict[str, int]] = load_or_create(
-    get_data_path("money.toml"), r"""members = {}"""
-)
-active: Dict[str, bool] = load_or_create(get_data_path("active.toml"), templates.active)
-output: Dict[str, Dict[str, List[str]]] = load_or_create(
-    get_data_path("output.toml"), templates.output
-)
-moderation: Dict[Any, Any] = load_or_create(
-    get_data_path("moderation.toml"), templates.moderation
-)
-descriptions: Dict[str, Dict[str, str]] = load_or_create(
-    get_data_path("descriptions.toml"), templates.descriptions
-)
-
-ensure_file(get_data_path(".env"), templates.env)
-
-
-def save_toml(data, path):
-    with open(path, "w", encoding="utf-8") as f:
-        tomlkit.dump(data, f)