easterobot 1.1.2__tar.gz → 1.3.2__tar.gz

{easterobot-1.1.2 → easterobot-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: easterobot
-Version: 1.1.2
+Version: 1.3.2
 Summary: Discord bot for Easter.
 Project-URL: Homepage, https://github.com/Dashstrom/easterobot
 Project-URL: Repository, https://github.com/Dashstrom/easterobot
@@ -121,10 +121,8 @@ from `PyPI <https://pypi.org/project>`_
     cd easterobot
     echo "DISCORD_TOKEN=YOU_MUST_PUT_YOUR_TOKEN_HERE" > .env
 
-    # Can be unsafe
-    chmod -R 700 .
-    mkdir data
-    chmod 777 data
+    # Can be unsafe (and for each update)
+    chmod -R 700 . && mkdir data -p && chmod 777 data
 
     # Run the docker container
     docker compose up -d
@@ -135,6 +133,12 @@ from `PyPI <https://pypi.org/project>`_
     # Remove the container (not the data)
     docker compose down --rmi all
 
+    # Update
+    git reset --hard HEAD && git pull
+
+    # One-line update
+    docker compose down --rmi all && git reset --hard HEAD && git pull && chmod -R 700 . && mkdir data -p && chmod 777 data && docker compose up -d
+
 Configuration directory
 #######################
 

{easterobot-1.1.2 → easterobot-1.3.2}/README.rst

@@ -83,10 +83,8 @@ from `PyPI <https://pypi.org/project>`_
     cd easterobot
     echo "DISCORD_TOKEN=YOU_MUST_PUT_YOUR_TOKEN_HERE" > .env
 
-    # Can be unsafe
-    chmod -R 700 .
-    mkdir data
-    chmod 777 data
+    # Can be unsafe (and for each update)
+    chmod -R 700 . && mkdir data -p && chmod 777 data
 
     # Run the docker container
     docker compose up -d
@@ -97,6 +95,12 @@ from `PyPI <https://pypi.org/project>`_
     # Remove the container (not the data)
     docker compose down --rmi all
 
+    # Update
+    git reset --hard HEAD && git pull
+
+    # One-line update
+    docker compose down --rmi all && git reset --hard HEAD && git pull && chmod -R 700 . && mkdir data -p && chmod 777 data && docker compose up -d
+
 Configuration directory
 #######################
 

easterobot-1.3.2/conftest.py

@@ -0,0 +1,44 @@
+"""Configuration for all tests."""
+
+from collections.abc import AsyncIterator
+from typing import Any
+
+import py
+import pytest
+import pytest_asyncio
+from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
+
+from easterobot import __author__
+from easterobot.bot import Easterobot
+from easterobot.config import MConfig
+
+
+@pytest.fixture(autouse=True)
+def _add_author(doctest_namespace: dict[str, Any]) -> None:
+    """Update doctest namespace."""
+    doctest_namespace["author"] = __author__
+
+
+@pytest.fixture
+def bot(tmpdir: py.path.LocalPath) -> Easterobot:
+    """Get a bot ready-to-use."""
+    return Easterobot.generate(str(tmpdir), env=True)
+
+
+@pytest.fixture
+def engine(bot: Easterobot) -> AsyncEngine:
+    """Get a bot ready-to-use."""
+    return bot.engine
+
+
+@pytest_asyncio.fixture
+async def session(engine: AsyncEngine) -> AsyncIterator[AsyncSession]:
+    """Get a bot ready-to-use."""
+    async with AsyncSession(engine, expire_on_commit=False) as session:
+        yield session
+
+
+@pytest.fixture
+def config(bot: Easterobot) -> MConfig:
+    """Get a bot ready-to-use."""
+    return bot.config

{easterobot-1.1.2 → easterobot-1.3.2}/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   bot:
-    container_name: easterobot_bot
+    container_name: bot
     stdin_open: true
     tty: true
     build:

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/bot.py

@@ -1,7 +1,6 @@
 """Main program."""
 
 import logging
-import logging.config
 import pathlib
 import shutil
 from getpass import getpass
@@ -37,7 +36,8 @@ from .config import (
 T = TypeVar("T")
 
 logger = logging.getLogger(__name__)
-INTENTS = discord.Intents.all()
+INTENTS = discord.Intents.default()
+INTENTS.message_content = True
 
 
 class Easterobot(discord.ext.commands.Bot):
@@ -47,15 +47,24 @@ class Easterobot(discord.ext.commands.Bot):
 
     def __init__(self, config: MConfig) -> None:
         """Initialise Easterbot."""
+        # Initialize intents
+        intents = discord.Intents.default()
+        if config.message_content:
+            intents.message_content = True
+
+        # Remove warning about VoiceClient
+        discord.VoiceClient.warn_nacl = False
+
+        # Initialize Bot
         super().__init__(
             command_prefix=".",
             description="Bot discord pour faire la chasse aux œufs",
             activity=discord.Game(name="rechercher des œufs"),
             intents=INTENTS,
         )
-        self.config = config
 
         # Attributes
+        self.config = config
         self.app_commands: list[discord.app_commands.AppCommand] = []
         self.app_emojis: dict[str, discord.Emoji] = {}
 
@@ -89,9 +98,9 @@ class Easterobot(discord.ext.commands.Bot):
         cls,
         destination: Union[Path, str],
         *,
-        token: Optional[str],
-        env: bool,
-        interactive: bool,
+        token: Optional[str] = None,
+        env: bool = False,
+        interactive: bool = False,
     ) -> "Easterobot":
         """Generate all data."""
         destination = Path(destination).resolve()

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/commands/__init__.py

@@ -12,6 +12,7 @@ from easterobot.commands.game import (
     tictactoe_command,
 )
 from easterobot.commands.help import help_command
+from easterobot.commands.info import info_command
 from easterobot.commands.reset import reset_command
 from easterobot.commands.search import search_command
 from easterobot.commands.top import top_command
@@ -24,6 +25,7 @@ __all__ = [
     "egg_command_group",
     "enable_command",
     "help_command",
+    "info_command",
     "reset_command",
     "rockpaperscissor_command",
     "search_command",
@@ -33,4 +35,5 @@ __all__ = [
 
 
 async def setup(bot: Easterobot) -> None:
+    egg_command_group.name = bot.config.group
     bot.tree.add_command(egg_command_group)

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/commands/base.py

@@ -170,7 +170,10 @@ def controlled_command(  # noqa: C901, PLR0915
             try:
                 await f(cast(Context, interaction), *args, **kwargs)
             except InterruptedCommandError:
-                logger.exception("InterruptedCommandError occur")
+                logger.warning(
+                    "InterruptedCommandError occur for %s",
+                    event_repr,
+                )
                 async with (
                     AsyncSession(interaction.client.engine) as session,
                     cooldown_lock,

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/commands/disable.py

@@ -10,7 +10,7 @@ from .base import Context, controlled_command, egg_command_group
 
 @egg_command_group.command(
     name="disable",
-    description="Désactiver la chasse aux œufs dans le salon"
+    description="Désactiver la chasse aux œufs dans le salon",
 )
 @controlled_command(cooldown=True, manage_channels=True)
 async def disable_command(ctx: Context) -> None:

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/commands/enable.py

@@ -10,7 +10,7 @@ from .base import Context, controlled_command, egg_command_group
 
 @egg_command_group.command(
     name="enable",
-    description="Activer la chasse dans le salon"
+    description="Activer la chasse dans le salon",
 )
 @controlled_command(
     cooldown=True,

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/commands/game.py

@@ -91,13 +91,13 @@ async def game_dual(  # noqa: C901, D103, PLR0912
         )
         if len(e1) < bet:
             await ctx.response.send_message(
-                "Vous n'avez pas assez d'oeufs",
+                "Vous n'avez pas assez d'œufs",
                 ephemeral=True,
             )
             return
         if len(e2) < bet:
             await ctx.response.send_message(
-                f"{member.mention} n'a pas assez d'oeufs",
+                f"{member.mention} n'a pas assez d'œufs",
                 ephemeral=True,
             )
             return
@@ -113,7 +113,7 @@ async def game_dual(  # noqa: C901, D103, PLR0912
                 )
                 if len(e1) < bet:
                     await ctx.response.send_message(
-                        "Vous n'avez plus assez d'oeufs",
+                        "Vous n'avez plus assez d'œufs",
                         ephemeral=True,
                     )
                     return
@@ -121,7 +121,7 @@ async def game_dual(  # noqa: C901, D103, PLR0912
                     e.lock = True
                 if len(e2) < bet:
                     await ctx.response.send_message(
-                        f"{member.mention} n'a plus assez d'oeufs",
+                        f"{member.mention} n'a plus assez d'œufs",
                         ephemeral=True,
                     )
                     return
@@ -130,26 +130,28 @@ async def game_dual(  # noqa: C901, D103, PLR0912
                 await session.commit()
 
             # Play the game
-            game = cls(ctx.user, member, msg)
-            await ctx.client.game.run(game)
-            winner = await game.wait_winner()
-
-            # Give eggs to the winner or remove previous one
-            async with lock:
-                for e in e1:
-                    e.lock = False
-                    if winner:
-                        e.user_id = winner.id
-                for e in e2:
-                    e.lock = False
-                    if winner:
-                        e.user_id = winner.id
-                await session.commit()
+            winner = None
+            try:
+                game = cls(ctx.user, member, msg)
+                await ctx.client.game.run(game)
+                winner = await game.wait_winner()
+            finally:
+                # Give eggs to the winner or remove previous one
+                async with lock:
+                    for e in e1:
+                        e.lock = False
+                        if winner:
+                            e.user_id = winner.id
+                    for e in e2:
+                        e.lock = False
+                        if winner:
+                            e.user_id = winner.id
+                    await session.commit()
 
 
 @egg_command_group.command(
     name="connect4",
-    description="Lancer une partie de puissance 4"
+    description="Lancer une partie de puissance 4",
 )
 @controlled_command(cooldown=True, channel_permissions={"send_messages": True})
 async def connect4_command(
@@ -163,12 +165,12 @@ async def connect4_command(
 
 @egg_command_group.command(
     name="tictactoe",
-    description="Lancer une partie de morpion"
+    description="Lancer une partie de morpion",
 )
-@controlled_command(cooldown=True)
+@controlled_command(cooldown=True, channel_permissions={"send_messages": True})
 async def tictactoe_command(
     ctx: Context,
-    member: discord.Member,
+    member: Optional[discord.Member] = None,
     bet: app_commands.Range[int, 0] = 0,
 ) -> None:
     """Run a tictactoe."""
@@ -179,10 +181,10 @@ async def tictactoe_command(
     name="rockpaperscissor",
     description="Lancer une partie de pierre papier ciseaux",
 )
-@controlled_command(cooldown=True)
+@controlled_command(cooldown=True, channel_permissions={"send_messages": True})
 async def rockpaperscissor_command(
     ctx: Context,
-    member: discord.Member,
+    member: Optional[discord.Member] = None,
     bet: app_commands.Range[int, 0] = 0,
 ) -> None:
     """Run a rockpaperscissor."""

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/commands/help.py

@@ -9,9 +9,9 @@ from .base import Context, controlled_command, egg_command_group
 
 @egg_command_group.command(
     name="help",
-    description="Obtenir l'aide des commandes"
+    description="Obtenir l'aide des commandes",
 )
-@controlled_command(cooldown=True)
+@controlled_command(cooldown=True, channel_permissions={"send_messages": True})
 async def help_command(ctx: Context) -> None:
     """Help command."""
     emb = embed(
@@ -33,4 +33,4 @@ async def help_command(ctx: Context) -> None:
                 value=f"{option.description}",
                 inline=False,
             )
-    await ctx.response.send_message(embed=emb, ephemeral=True)
+    await ctx.response.send_message(embed=emb)

easterobot-1.3.2/easterobot/commands/info.py

@@ -0,0 +1,61 @@
+"""Command basket."""
+
+import asyncio
+from typing import Optional
+
+import discord
+from discord import app_commands
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from easterobot.commands.base import (
+    Context,
+    controlled_command,
+    egg_command_group,
+)
+from easterobot.hunts.hunt import embed
+from easterobot.hunts.rank import Ranking
+
+
+@egg_command_group.command(
+    name="info",
+    description="Avoir des informations sur la chance d'un joueur",
+)
+@app_commands.describe(
+    user="Joueur a inspecter",
+)
+@controlled_command(cooldown=True)
+async def info_command(
+    ctx: Context, user: Optional[discord.Member] = None
+) -> None:
+    """Show current user basket."""
+    # Delay the response
+    await ctx.response.defer(ephemeral=True)
+
+    # Set the user of the basket
+    hunter = user or ctx.user
+
+    async with AsyncSession(ctx.client.engine) as session:
+        ranking, member_luck = await asyncio.gather(
+            Ranking.from_guild(session, ctx.guild_id),
+            ctx.client.hunt.get_luck(
+                session=session,
+                guild_id=hunter.guild.id,
+                user_id=hunter.id,
+                sleep_hours=False,
+            ),
+        )
+        hunter_rank = ranking.get(hunter.id)
+
+        await ctx.followup.send(
+            embed=embed(
+                title=f"Informations sur {hunter.display_name}",
+                description=(
+                    f"Classement : {hunter_rank.badge}\n"
+                    f"Nombre d'œufs : `{hunter_rank.eggs}`\n"
+                    f"Chance brute : `{member_luck.luck:.0%}`\n"
+                    f"Chance de trouver un œuf : `{member_luck.discovered:.0%}`\n"
+                    f"Chance de se faire voler : `{member_luck.spotted:.0%}`"
+                ),
+            ),
+            ephemeral=True,
+        )

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/commands/reset.py

@@ -15,7 +15,7 @@ from .base import Context, Interaction, controlled_command, egg_command_group
 
 @egg_command_group.command(
     name="reset",
-    description="Réinitialiser la chasse aux œufs"
+    description="Réinitialiser la chasse aux œufs",
 )
 @controlled_command(cooldown=True, administrator=True)
 async def reset_command(ctx: Context) -> None:

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/commands/search.py

@@ -4,10 +4,10 @@ import logging
 from typing import Any
 
 import discord
-from sqlalchemy import and_, func, select
+from sqlalchemy import select
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from easterobot.config import RAND, agree
+from easterobot.config import agree
 from easterobot.hunts.hunt import embed
 from easterobot.models import Egg, Hunt
 
@@ -23,7 +23,7 @@ logger = logging.getLogger("easterobot")
 
 @egg_command_group.command(
     name="search",
-    description="Rechercher un œuf"
+    description="Rechercher un œuf",
 )
 @controlled_command(cooldown=True, channel_permissions={"send_messages": True})
 async def search_command(ctx: Context) -> None:
@@ -37,7 +37,7 @@ async def search_command(ctx: Context) -> None:
                 "La chasse aux œufs n'est pas activée dans ce salon",
                 ephemeral=True,
             )
-            return
+            raise InterruptedCommandError
     try:
         await ctx.response.defer(ephemeral=False)
     except discord.errors.NotFound as err:
@@ -45,39 +45,15 @@ async def search_command(ctx: Context) -> None:
     name = ctx.user.display_name
 
     async with AsyncSession(ctx.client.engine) as session:
-        egg_max = await session.scalar(
-            select(
-                func.count().label("max"),
-            )
-            .where(Egg.guild_id == ctx.guild_id)
-            .group_by(Egg.user_id)
-            .order_by(func.count().label("max").desc())
-            .limit(1)
+        luck = await ctx.client.hunt.get_luck(
+            guild_id=ctx.guild_id,
+            user_id=ctx.user.id,
+            session=session,
+            sleep_hours=ctx.client.config.in_sleep_hours(),
         )
-        egg_max = egg_max or 0
-        egg_count = await session.scalar(
-            select(func.count().label("count")).where(
-                and_(
-                    Egg.guild_id == ctx.guild.id,
-                    Egg.user_id == ctx.user.id,
-                )
-            )
-        )
-        if egg_count is None:
-            egg_count = 0
-    ratio = egg_count / egg_max if egg_max != 0 else 1.0
-
-    discovered = ctx.client.config.commands.search.discovered
-    prob_d = (discovered.max - discovered.min) * (1 - ratio) + discovered.min
 
-    sample_d = RAND.random()
-    if prob_d > sample_d or egg_count < discovered.shield:
-        sample_s = RAND.random()
-        spotted = ctx.client.config.commands.search.spotted
-        prob_s = (spotted.max - spotted.min) * ratio + spotted.min
-        logger.info("discovered: %.2f > %.2f", prob_d, sample_d)
-        if prob_s > sample_s and egg_count > spotted.shield:
-            logger.info("spotted: %.2f > %.2f", prob_s, sample_s)
+    if luck.sample_discovered():
+        if luck.sample_spotted():
 
             async def send_method(
                 *args: Any, **kwargs: Any
@@ -91,7 +67,6 @@ async def search_command(ctx: Context) -> None:
                 send_method=send_method,
             )
         else:
-            logger.info("found: %.2f > %.2f", prob_s, sample_s)
             emoji = ctx.client.egg_emotes.rand()
             async with AsyncSession(ctx.client.engine) as session:
                 session.add(
@@ -108,7 +83,7 @@ async def search_command(ctx: Context) -> None:
                 "%s (%s) got an egg for a total %s in %s",
                 ctx.user,
                 ctx.user.id,
-                agree("{0} egg", "{0} eggs", egg_count),
+                agree("{0} egg", "{0} eggs", luck.egg_count),
                 ctx.channel.jump_url,
             )
             await ctx.followup.send(
@@ -116,15 +91,14 @@ async def search_command(ctx: Context) -> None:
                     title=f"{name} récupère un œuf",
                     description=ctx.client.config.hidden(ctx.user),
                     thumbnail=emoji.url,
-                    egg_count=egg_count + 1,
+                    egg_count=luck.egg_count + 1,
                 )
             )
     else:
-        logger.info("failed: %.2f > %.2f", prob_d, sample_d)
         await ctx.followup.send(
             embed=embed(
                 title=f"{name} repart bredouille",
                 description=ctx.client.config.failed(ctx.user),
-                egg_count=egg_count,
+                egg_count=luck.egg_count,
             )
         )

{easterobot-1.1.2 → easterobot-1.3.2}/easterobot/config.py

@@ -5,9 +5,11 @@ import logging.config
 import os
 import pathlib
 import random
+import re
 from abc import ABC, abstractmethod
 from argparse import Namespace
 from collections.abc import Iterable
+from datetime import datetime, time, timezone
 from typing import (
     Any,
     Generic,
@@ -80,7 +82,7 @@ class ConjugableText(Serializable[str]):
     def gender(member: discord.Member) -> Literal["man", "woman"]:
         """Get the gender of a people."""
         if any(
-            marker in role.name.casefold()
+            marker in tokenize(role.name)
             for role in member.roles
             for marker in (
                 "woman",
@@ -88,6 +90,7 @@ class ConjugableText(Serializable[str]):
                 "femme",
                 "fille",
                 "elle",
+                "elles",
                 "her",
                 "she",
             )
@@ -163,6 +166,14 @@ class RandomConjugableText(RandomItem[ConjugableText]):
         return cls(convert(obj, typ=list[ConjugableText]))
 
 
+class MSleep(msgspec.Struct):
+    start: time
+    end: time
+    divide_hunt: float
+    divide_discovered: float
+    divide_spotted: float
+
+
 class MCooldown(msgspec.Struct):
     min: float
     max: float
@@ -194,12 +205,20 @@ class MDiscovered(msgspec.Struct):
     min: float
     max: float
 
+    def probability(self, luck: float) -> float:
+        """Get discover probability."""
+        return (self.max - self.min) * luck + self.min
+
 
 class MSpotted(msgspec.Struct):
     shield: int
     min: float
     max: float
 
+    def probability(self, luck: float) -> float:
+        """Get discover probability."""
+        return (self.max - self.min) * (1 - luck) + self.min
+
 
 class SearchCommand(MCommand):
     discovered: MDiscovered
@@ -239,6 +258,7 @@ class MCommands(msgspec.Struct, forbid_unknown_fields=True):
     help: MCommand
     edit: MCommand
     connect4: MCommand
+    info: MCommand
     tictactoe: MCommand
     rockpaperscissor: MCommand
 
@@ -269,6 +289,16 @@ class MConfig(msgspec.Struct, dict=True):
     appear: RandomItem[str]
     action: RandomItem[MText]
     commands: MCommands
+    sleep: MSleep = msgspec.field(
+        default_factory=lambda: MSleep(
+            start=time(hour=23),
+            end=time(hour=9),
+            divide_hunt=2.0,
+            divide_discovered=2.0,
+            divide_spotted=1.5,
+        )
+    )
+    message_content: bool = True
     token: Optional[Union[str, msgspec.UnsetType]] = msgspec.UNSET
     _resources: Optional[Union[pathlib.Path, msgspec.UnsetType]] = (
         msgspec.field(name="resources", default=msgspec.UNSET)
@@ -284,6 +314,17 @@ class MConfig(msgspec.Struct, dict=True):
             "%(data)s", "/" + self.working_directory.as_posix()
         )
 
+    def in_sleep_hours(self) -> bool:
+        """Get if bot is currently in sleep mode."""
+        hour = datetime.now(tz=timezone.utc).time()
+        if self.sleep.start < self.sleep.end:
+            if self.sleep.start < hour < self.sleep.end:
+                return True
+        elif self.sleep.start > self.sleep.end:  # noqa: SIM102
+            if not self.sleep.start < hour < self.sleep.end:
+                return True
+        return False
+
     def verified_token(self) -> str:
         """Get the safe token."""
         if self.token is None or self.token is msgspec.UNSET:
@@ -370,6 +411,14 @@ class MConfig(msgspec.Struct, dict=True):
             )
             self.__logging_flag = True
 
+    def __str__(self) -> str:
+        """Represent the Configuration."""
+        return f"<Config {str(self.working_directory)!r}>"
+
+    def __repr__(self) -> str:
+        """Represent the Configuration."""
+        return f"<Config {str(self.working_directory)!r}>"
+
 
 def _dec_hook(typ: type[T], obj: Any) -> T:
     # Get the base type
@@ -463,3 +512,24 @@ def agree(
     if amount is None or amount in (-1, 0, 1):
         return singular.format(amount, *args)
     return plural.format(amount, *args)
+
+
+RE_VALID = re.compile(r"[^a-zA-Z0-9éàèê]")
+
+
+def tokenize(text: str) -> list[str]:
+    """Get token from text.
+
+    Examples:
+        >>> tokenize("Activités manuelles")
+        ['activités', 'manuelles']
+        >>> tokenize("Elle")
+        ['elle']
+        >>> tokenize("Iel/Iels")
+        ['iel', 'iels']
+        >>> tokenize("🦉 Elle")
+        ['elle']
+    """
+    text = text.casefold()
+    text = RE_VALID.sub(" ", text)
+    return text.strip().split()