Use a database for league settings

Author: tesence

.pylintrc

@@ -6,7 +6,8 @@ disable=
     too-few-public-methods,
     too-many-arguments,
     no-value-for-parameter,
-    consider-using-f-string
+    consider-using-f-string,
+    too-many-locals
 
 [FORMAT]
 max-line-length=119

Dockerfile

@@ -5,6 +5,8 @@ WORKDIR /app
 COPY gumo ./gumo
 COPY requirements.txt .
 
+RUN apk add git
+
 RUN pip install --upgrade pip
 RUN pip install -r requirements.txt
 

docker-compose.yml.example

@@ -7,4 +7,5 @@ services:
     environment:
       GUMO_BOT_TOKEN: "BOT_TOKEN_HERE"
       GUMO_BOT_GOOGLE_API_SA_FILE: /path/to/the/service/account/file.json
+      GUMO_BOT_DB_FILE: /path/to/database.db
       # GUMO_LOG_LEVEL: "INFO"

gumo/api/core.py

@@ -2,10 +2,13 @@
 Define a client to interact with the Ori and the Blind Forest Randomizer API
 """
 
+import io
 import logging
 from urllib import parse
 import random
 
+import discord
+
 import aiohttp
 
 from gumo.api import models
@@ -33,7 +36,7 @@ class BFRandomizerApiClient:
     def __init__(self, *args, **kwargs):
         self._session = aiohttp.ClientSession(*args, **kwargs, raise_for_status=True)
 
-    async def get_data(self, seed_name: str = None, logic_mode: str = None, key_mode: str = None,
+    async def _get_seed_data(self, seed_name: str = None, logic_mode: str = None, key_mode: str = None,
                        goal_mode: str = None, spawn: str = None, variations: tuple = (), item_pool: str = None,
                        relic_count: int = None):
         """
@@ -47,6 +50,7 @@ async def get_data(self, seed_name: str = None, logic_mode: str = None, key_mode
             spawn (str, optional): Randomizer spawn location. Defaults to None.
             variations (tuple, optional): Randomizer variations. Defaults to ().
             item_pool (str, optional): Randomizer item pool. Defaults to None.
+            relic_count (int, optional): Randomizer relic count (World Tour only). Defaults to None.
 
         Returns:
             dict: The API response content
@@ -93,3 +97,33 @@ async def get_data(self, seed_name: str = None, logic_mode: str = None, key_mode
         logger.info("Outgoing request: %s", url)
         resp = await self._session.request('GET', url)
         return await resp.json()
+
+    async def get_seed(self, seed_name: str = None, logic_mode: str = None, key_mode: str = None,
+                             goal_mode: str = None, spawn: str = None, variations: tuple = (),
+                             item_pool: str = None, relic_count: int = None):
+        """Returns the seed data splitted into different dictionnary keys
+
+        Args:
+            seed_name (str, optional): Seed name. Defaults to None.
+            logic_mode (str, optional): Randomizer logic mode. Defaults to None.
+            key_mode (str, optional): Randomizer key mode. Defaults to None.
+            goal_mode (str, optional): Randomizer goal mode. Defaults to None.
+            spawn (str, optional): Randomizer spawn location. Defaults to None.
+            variations (tuple, optional): Randomizer variations. Defaults to ().
+            item_pool (str, optional): Randomizer item pool. Defaults to None.
+            relic_count (int, optional): Randomizer relic count (World Tour only). Defaults to None.
+
+        Returns:
+            dict: The seed data in a dictonary format
+        """
+        seed_data = await self._get_seed_data(seed_name=seed_name, logic_mode=logic_mode, key_mode=key_mode,
+                                                   goal_mode=goal_mode, spawn=spawn, variations=variations,
+                                                   item_pool=item_pool, relic_count=relic_count)
+        seed_buffer = io.BytesIO(bytes(seed_data['players'][0]['seed'], encoding="utf8"))
+        return {
+            'seed_header': seed_data['players'][0]['seed'].split("\n")[0],
+            'spoiler_url': f"{SEEDGEN_API_URL}{seed_data['players'][0]['spoiler_url']}",
+            'map_url': f"{SEEDGEN_API_URL}{seed_data['map_url']}",
+            'history_url': f"{SEEDGEN_API_URL}{seed_data['history_url']}",
+            'seed_files': [discord.File(seed_buffer, filename='randomizer.dat')]
+        }

gumo/api/models.py

@@ -2,6 +2,8 @@
 Define the mapping between Randomizer parameters presented to the user and the parameters passed in the API request.
 """
 
+from discord import app_commands
+
 LOGIC_MODES = {
     'Casual': "Casual",
     'Standard': "Standard",
@@ -89,3 +91,11 @@
     'Normal': "Normal",
     'Hard': "Hard"
 }
+
+LOGIC_MODE_CHOICES = [app_commands.Choice(name=name, value=name) for name, value in LOGIC_MODES.items()]
+KEY_MODE_CHOICES = [app_commands.Choice(name=name, value=name) for name, value in KEY_MODES.items()]
+GOAL_MODE_CHOICES = [app_commands.Choice(name=name, value=name) for name, value in GOAL_MODES.items()]
+SPAWN_CHOICES = [app_commands.Choice(name=name, value=name) for name, value in SPAWNS.items()]
+VARIATION_CHOICES = [app_commands.Choice(name=name, value=name) for name, value in VARIATIONS.items()]
+LOGIC_PATH_CHOICES = [app_commands.Choice(name=name, value=name) for name, value in LOGIC_PATHS.items()]
+ITEM_POOL_CHOICES = [app_commands.Choice(name=name, value=name) for name, value in ITEM_POOLS.items()]

gumo/bot.py

@@ -6,29 +6,18 @@
 """
 
 import logging
+
 import discord
-from discord import app_commands
 from discord.ext import commands
 
 logger = logging.getLogger(__name__)
 
 MODULES = [
     "gumo.modules.emoji_chain",
-    "gumo.modules.seed"
+    "gumo.modules.seed",
+    "gumo.modules.league",
 ]
 
-class CustomCommandTree(app_commands.CommandTree):
-    """Custom Command Tree class to override the default error handling"""
-
-    # pylint: disable=arguments-differ
-    async def on_error(self, interaction: discord.Interaction, error: app_commands.AppCommandError):
-        command = interaction.command
-        if command is not None:
-            logger.error('Ignoring exception in command %r', command.qualified_name, exc_info=error)
-        else:
-            logger.error('Ignoring exception in command tree', exc_info=error)
-
-
 class Bot(commands.Bot):
     """Custom Bot class to override the default behaviour and logging"""
 
@@ -37,8 +26,7 @@ def __init__(self, *args, **kwargs):
         intents = discord.Intents.default()
         intents.message_content = True
         intents.members = True
-        super().__init__(*args, **kwargs, intents=intents, tree_cls=CustomCommandTree)
-
+        super().__init__(*args, **kwargs, intents=intents)
         self.remove_command('help')
 
     async def setup_hook(self):
@@ -55,10 +43,8 @@ async def on_interaction(self, interaction: discord.Interaction):
         message = f"Command invoked by {interaction.user.name} ({interaction.user.display_name}): " + \
                   f"/{interaction.command.qualified_name}"
 
-        if "options" in interaction.data:
-            options = interaction.data['options'][0]['options'] if interaction.command.parent \
-                      else interaction.data['options']
-            arguments = [f"{opt['name']}='{opt['value']}'" for opt in options]
+        if interaction.namespace:
+            arguments = [f"{opt[0]}='{opt[1]}'" for opt in interaction.namespace]
             message += f" {' '.join(arguments)}"
 
         logger.info(message)