Merge pull request #14 from ae-utbm/peewee

Setup database

Author: imperosol

.gitignore

@@ -66,6 +66,7 @@ cover/
 *.pot
 
 local_settings.py
+*.sqlite
 *.sqlite3
 *.sqlite3-journal
 

db/__init__.py

@@ -0,0 +1,42 @@
+from datetime import UTC, datetime
+
+import peewee
+from peewee import Model, SqliteDatabase
+
+from src.settings import BASE_DIR
+
+# SQLite may not be suited for production, but is
+# perfectly for the initial development phase
+db = SqliteDatabase(BASE_DIR / "db.sqlite3")
+
+
+class DbBaseModel(Model):
+    created_at = peewee.DateTimeField(default=datetime.now(tz=UTC))
+    updated_at = peewee.DateTimeField()
+
+    def save(self, *args, **kwargs):
+        self.updated_at = datetime.now(tz=UTC)
+        return super().save(*args, **kwargs)
+
+    class Meta:
+        database = db
+
+
+class User(DbBaseModel):
+    discord_id = peewee.IntegerField(primary_key=True)
+    sith_id = peewee.IntegerField(null=True)
+    username = peewee.CharField()
+
+
+class Club(DbBaseModel):
+    name = peewee.CharField(max_length=64, unique=True)
+    category_id = peewee.IntegerField(unique=True)
+    sith_id = peewee.IntegerField(unique=True)
+    president_role_id = peewee.IntegerField(unique=True)
+    treasurer_role_id = peewee.IntegerField(unique=True)
+    member_role_id = peewee.IntegerField(unique=True)
+    former_member_role_id = peewee.IntegerField(unique=True)
+
+
+def init():
+    db.create_tables([User, Club])

db/models.py

@@ -2,5 +2,5 @@ services:
   discord:
     build: .
     volumes:
-      - /data:/app/data
+      - ./db.sqlite3:/app/db.sqlite3
       - ./log:/app/log

docker-compose.yml

@@ -7,6 +7,7 @@ requires-python = ">=3.12"
 dependencies = [
     "aiohttp>=3.13.0",
     "discord-py[speed]>=2.6.4",
+    "peewee>=3.18.2",
     "pydantic-settings>=2.11.0",
     "pydantic>=2.12.0",
     "pytz>=2025.2",

pyproject.toml

@@ -7,8 +7,9 @@
 from discord.ext import commands
 from discord.ext.commands import BadArgument
 
+from db.models import Club
 from src.client import ClubSchema  # noqa TC001
-from src.services.club import ClubService, DiscordClub
+from src.services.club import ClubExists, ClubService
 from src.settings import Settings
 
 if TYPE_CHECKING:
@@ -63,14 +64,14 @@ async def remove_club_member(
         member: Member,
     ):
         await interaction.response.defer(thinking=True)
-        discord_club = DiscordClub.load(club.id)
-        role_membre = utils.get(member.guild.roles, id=discord_club.member_role_id)
-        if not discord_club:
+        db_club = Club.get_or_none(Club.sith_id == club.id)
+        if not db_club:
             await interaction.followup.send(f"Le club : {club.name} n'existe pas")
             return
+        role_membre = utils.get(member.guild.roles, id=db_club.member_role_id)
         if (
             not interaction.user.guild_permissions.manage_roles
-            and not interaction.user.get_role(discord_club.president_role_id)
+            and not interaction.user.get_role(db_club.president_role_id)
         ):
             await interaction.followup.send(
                 "Seul le président du club et les admins peuvent retirer un membre"
@@ -79,7 +80,7 @@ async def remove_club_member(
         if role_membre not in member.roles:
             await interaction.followup.send("Cet utilisateur n'est pas dans le club")
             return
-        await self.club_service.remove_member(discord_club, member)
+        await self.club_service.remove_member(db_club, member)
         await interaction.followup.send(
             f"{member.name} a été retiré du club :thumbs_up:"
         )
@@ -93,14 +94,14 @@ async def add_club_member(
         member: Member,
     ):
         await interaction.response.defer(thinking=True)
-        discord_club = DiscordClub.load(club.id)
-        role_membre = utils.get(member.guild.roles, id=discord_club.member_role_id)
-        if not discord_club:
+        db_club = Club.get_or_none(Club.sith_id == club.id)
+        role_membre = member.guild.get_role(db_club.member_role_id)
+        if not db_club:
             await interaction.followup.send(f"Le club : {club.name} n'existe pas")
             return
         if (
             not interaction.user.guild_permissions.manage_roles
-            and not interaction.user.get_role(discord_club.president_role_id)
+            and not interaction.user.get_role(db_club.president_role_id)
         ):
             await interaction.followup.send(
                 "Seul le président du club et les admins peuvent ajouter un membre"
@@ -109,7 +110,7 @@ async def add_club_member(
         if role_membre in member.roles:
             await interaction.followup.send("Cet utilisateur est déjà dans le club")
             return
-        await self.club_service.add_member(discord_club, member)
+        await self.club_service.add_member(db_club, member)
         await interaction.followup.send(
             f"{member.name} a été ajouté au club :thumbs_up:"
         )
@@ -121,8 +122,10 @@ async def create_club(
         self, interaction: Interaction, club: Transform[ClubSchema, ClubTransformer]
     ):
         await interaction.response.defer(thinking=True)
-        discord_club = DiscordClub.load(club.id)
-        if discord_club is not None:
+        try:
+            await self.club_service.create_club(club, interaction.guild)
+            await interaction.followup.send(f"Le club : {club.name} à été créé")
+        except ClubExists:
             await interaction.followup.send(f"Le club : {club.name} existe déjà...")
         else:
             await self.club_service.create_club(club, interaction.guild)
@@ -139,16 +142,16 @@ async def handover(
         new_treasurer: Member,
     ):
         await interaction.response.defer(thinking=True)
-        discord_club = DiscordClub.load(club.id)
+        db_club = Club.get_or_none(Club.sith_id == club.id)
         guild = interaction.guild
 
-        if not discord_club:
+        if not db_club:
             await interaction.followup.send(f"Le club : {club.name} n'existe pas")
             return
 
         await self.club_service.handover(club, new_president, new_treasurer, guild)
         annonce = await self.club_service.get_channel(
-            guild, discord_club.category_id, f"annonces {club.name}".lower()
+            guild, db_club.category_id, f"annonces {club.name}".lower()
         )
 
         if annonce:
@@ -157,12 +160,11 @@ async def handover(
                 f"le nouveau président du club {club.name}"
                 f" et {new_treasurer.mention} le nouveau trésorier !!"
             )
-
         else:
             await interaction.followup.send(
                 "Attention, ce club n'a pas ses salons de discussion.\n"
                 "La passation va quand même se faire, mais il faut "
-                "contacter un des mainteneurs du bots pour remettre "
+                "contacter un des mainteneurs du bot pour remettre "
                 "les salons en place"
             )
         await interaction.followup.send("Passation effectuée")
@@ -174,16 +176,15 @@ async def stop_club(
         self, interaction: Interaction, club: Transform[ClubSchema, ClubTransformer]
     ):
         await interaction.response.defer(thinking=True)
-        guild = interaction.guild
-        discord_club = DiscordClub.load(club.id)
-        await self.club_service.stop_club(discord_club, interaction.guild)
+        db_club = Club.get_or_none(Club.sith_id == club.id)
+        await self.club_service.stop_club(db_club, interaction.guild)
         annonce = await self.club_service.get_channel(
-            guild, discord_club.category_id, f"annonces {club.name}".lower()
+            interaction.guild, db_club.category_id, f"annonces {club.name}".lower()
         )
 
         if annonce:
             await annonce.send(
                 "Le club, n'ayant pas été repris, est "
                 "temporairement fermé jusqu'à reprise du club"
             )
-        await interaction.followup.send(f"Le club : {club.name} à été arrété")
+        await interaction.followup.send(f"Le club : {club.name} à été arrêté")

src/commands/club.py

@@ -1,13 +1,12 @@
 from __future__ import annotations
 
-import json
-from typing import TYPE_CHECKING, Self
+from typing import TYPE_CHECKING
 from urllib.parse import urljoin
 
 from discord import Embed, PermissionOverwrite, utils
-from pydantic import BaseModel
 
-from src.settings import BASE_DIR, Settings
+from db.models import Club
+from src.settings import Settings
 
 if TYPE_CHECKING:
     from discord import Guild, Member
@@ -16,36 +15,16 @@
     from src.main import AeBot
 
 
-class DiscordClub(BaseModel):
-    """Pydantic model representing data about a club on the discord guild.
+class ClubError(Exception):
+    """Errors related to operations on clubs"""
 
-    It can also manage interaction with the internal data cache.
-    """
 
-    name: str
-    sith_id: int
-    category_id: int
-    president_role_id: int
-    president_sith_id: int | None = None
-    treasurer_role_id: int
-    treasurer_sith_id: int | None = None
-    member_role_id: int
-    member_sith_id: int | None = None
-    former_member_role_id: int
+class ClubExists(ClubError):
+    """Trying to create a club that already exists"""
 
-    @classmethod
-    def load_all(cls) -> dict[str, dict]:
-        return json.loads((BASE_DIR / "data/club.json").read_text())
 
-    @classmethod
-    def load(cls, club_id: int) -> Self | None:
-        club = cls.load_all().get(str(club_id))
-        return cls.model_validate(club) if club is not None else club
-
-    def save(self):
-        all_clubs = self.load_all()
-        all_clubs[str(self.sith_id)] = self.model_dump()
-        (BASE_DIR / "data/club.json").write_text(json.dumps(all_clubs))
+class ClubDoesNotExist(ClubError):
+    """Trying to use a club that does not exist"""
 
 
 class ClubService:
@@ -62,7 +41,8 @@ async def search_club(
     ) -> list[SimpleClubSchema]:
         clubs = await self._client.search_clubs(current)
         if clubs and only_existing:
-            clubs = [c for c in clubs if str(c.id) in DiscordClub.load_all()]
+            clubs_ids = [c[0] for c in Club.select(Club.sith_id).tuples()]
+            clubs = [c for c in clubs if c.id in clubs_ids]
         return clubs if clubs is not None else []
 
     async def get_club(self, club_id: int) -> ClubSchema | None:
@@ -98,6 +78,8 @@ def embed(self, club: ClubSchema) -> Embed:
         return embed
 
     async def create_club(self, club: ClubSchema, guild: Guild):
+        if Club.filter(Club.sith_id == club.id).exists():
+            raise ClubExists
         # create the role for member, presidence and treasurer
         president = await guild.create_role(name=f"Responsable {club.name}")
         treasurer = await guild.create_role(name=f"Trésorier {club.name}")
@@ -129,38 +111,35 @@ async def create_club(self, club: ClubSchema, guild: Guild):
         )
         await category.create_text_channel(f"Général-{club.name}")
         await category.create_voice_channel(f"Général-{club.name}")
-        new_club = DiscordClub(
-            sith_id=club.id,
+        Club.create(
             name=club.name,
+            category_id=category.id,
+            sith_id=club.id,
             president_role_id=president.id,
             treasurer_role_id=treasurer.id,
             member_role_id=member.id,
             former_member_role_id=former_member.id,
-            category_id=category.id,
         )
-        new_club.save()
 
-    async def add_member(self, club: DiscordClub, member: Member):
+    async def add_member(self, club: Club, member: Member):
         role = utils.get(member.guild.roles, id=club.member_role_id)
         former = utils.get(member.guild.roles, id=club.former_member_role_id)
         if former in member.roles:
             await member.remove_roles(
                 former, reason=f"{member.name} joined club {club.name}"
             )
         await member.add_roles(role, reason=f"{member.name} joined club {club.name}")
-        club.save()
 
-    async def remove_member(self, club: DiscordClub, member: Member):
+    async def remove_member(self, club: Club, member: Member):
         role = utils.get(member.guild.roles, id=club.member_role_id)
         former = utils.get(member.guild.roles, id=club.former_member_role_id)
         await member.remove_roles(role, reason=f"{member.name} left club {club.name}")
         await member.add_roles(former, reason=f"{member.name} left club {club.name}")
-        club.save()
 
     async def handover(
         self, club: ClubSchema, new_pres: Member, new_treso: Member, guild: Guild
     ):
-        club = DiscordClub.load(club.id)
+        club = Club.get_or_none(Club.sith_id == club.id)
 
         # removing former presidence and treasurer
         role_pres = utils.get(guild.roles, id=club.president_role_id)
@@ -190,7 +169,7 @@ async def handover(
         )
         await category.move(above=highest_inactive)
 
-    async def stop_club(self, club: DiscordClub, guild: Guild):
+    async def stop_club(self, club: Club, guild: Guild):
         role_pres = utils.get(guild.roles, id=club.president_role_id)
         role_treso = utils.get(guild.roles, id=club.treasurer_role_id)
         role_member = utils.get(guild.roles, id=club.member_role_id)