Release version 4.1.0

Author: regunakyle

compose.yaml

@@ -21,6 +21,9 @@ services:
       OPENAI_BASE_URL: http://localhost:5000/v1
     volumes:
       - dbot-vol:/app/volume
+    depends_on:
+      lavalink:
+        condition: service_started
     restart: unless-stopped
 
   lavalink:

…versions/a29aedea6bce_first_migration.py …versions/93832be8c5ae_first_migration.pymigrations/versions/a29aedea6bce_first_migration.py renamed to migrations/versions/93832be8c5ae_first_migration.py migrations/versions/a29aedea6bce_first_migration.py renamed to migrations/versions/93832be8c5ae_first_migration.py

@@ -1,8 +1,8 @@
 """First migration
 
-Revision ID: a29aedea6bce
+Revision ID: 93832be8c5ae
 Revises:
-Create Date: 2025-02-02 22:16:04.229508
+Create Date: 2025-02-04 00:13:49.353166
 
 """
 
@@ -12,7 +12,7 @@
 from alembic import op
 
 # revision identifiers, used by Alembic.
-revision: str = "a29aedea6bce"
+revision: str = "93832be8c5ae"
 down_revision: Union[str, None] = None
 branch_labels: Union[str, Sequence[str], None] = None
 depends_on: Union[str, Sequence[str], None] = None
@@ -29,9 +29,9 @@ def upgrade() -> None:
             nullable=False,
         ),
         sa.Column("guild_id", sa.Integer(), nullable=False),
-        sa.Column("guild_name", sa.String(length=100), nullable=False),
+        sa.Column("guild_name", sa.Unicode(length=100), nullable=False),
         sa.Column("bot_channel", sa.Integer(), nullable=True),
-        sa.Column("welcome_message", sa.String(length=2000), nullable=True),
+        sa.Column("welcome_message", sa.Unicode(length=2000), nullable=True),
         sa.PrimaryKeyConstraint("id", name=op.f("pk_guild")),
         sa.UniqueConstraint("guild_id", name=op.f("uq_guild_guild_id")),
     )

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "my-discord-bot"
-version = "4.0.1"
+version = "4.1.0"
 description = "Discord Bot by Reguna"
 readme = "README.md"
 requires-python = ">=3.11"

src/my_discord_bot/bot.py

@@ -1,13 +1,13 @@
 import logging
 import os
-from inspect import getmembers, isclass
 
 import discord
 from discord.ext import commands
 from sqlalchemy import delete, select
 from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker
 
-from . import cogs, models
+from .cogs import cog_list
+from .models import Guild
 
 logger = logging.getLogger(__name__)
 
@@ -37,17 +37,17 @@ async def setup_hook(self) -> None:
         logger.info(f"Logged in as {self.user.name} ({str(self.user.id)}).")
 
         # Add all cogs
-        for module in getmembers(cogs, isclass):
+        for cog in cog_list:
             # Disable specific cogs if specific environment variables are not set
-            if module[1].__name__ == "AI" and not (
+            if cog.__name__ == "AI" and not (
                 len(os.getenv("OPENAI_API_KEY", ""))
                 and len(os.getenv("OPENAI_MODEL_NAME", ""))
             ):
                 continue
-            if module[1].__name__ == "Music" and not len(os.getenv("LAVALINK_URL", "")):
+            if cog.__name__ == "Music" and not len(os.getenv("LAVALINK_URL", "")):
                 continue
 
-            await self.add_cog(module[1](self, self.sessionmaker))
+            await self.add_cog(cog(self, self.sessionmaker))
 
     async def on_guild_join(self, guild: discord.Guild) -> None:
         """Called when a Guild is either created by the Client or when the Client joins a guild."""
@@ -58,7 +58,7 @@ async def on_guild_join(self, guild: discord.Guild) -> None:
         async with self.sessionmaker() as session:
             try:
                 session.add(
-                    models.Guild(
+                    Guild(
                         guild_id=guild.id,
                         guild_name=guild.name,
                         bot_channel=guild.system_channel.id
@@ -80,19 +80,17 @@ async def on_guild_remove(self, guild: discord.Guild) -> None:
         logger.info(f"Left a guild. Guild ID: {guild.id}; Guild Name: {guild.name}")
         async with self.sessionmaker() as session:
             # Delete removed guild from database
-            await session.execute(
-                delete(models.Guild).where(models.Guild.guild_id == guild.id)
-            )
+            await session.execute(delete(Guild).where(Guild.guild_id == guild.id))
             await session.commit()
 
     async def on_member_join(self, member: discord.Member) -> None:
         """Called when a Member joins a Guild."""
 
         channel = member.guild.system_channel
         async with self.sessionmaker() as session:
-            guild: models.Guild | None = (
+            guild: Guild | None = (
                 await session.execute(
-                    select(models.Guild).where(models.Guild.guild_id == member.guild.id)
+                    select(Guild).where(Guild.guild_id == member.guild.id)
                 )
             ).scalar()
             if not guild:

src/my_discord_bot/cogs/__init__.py

@@ -4,4 +4,6 @@
 from .meta import Meta
 from .music import Music
 
-__all__ = ("ErrorHandler", "General", "Meta", "Music", "AI")
+cog_list = [ErrorHandler, General, Meta, Music, AI]
+
+__all__ = ("ErrorHandler", "General", "Meta", "Music", "AI", "cog_list")

src/my_discord_bot/cogs/music.py

@@ -112,9 +112,7 @@ async def leave_inactive_voice_channel_task(self) -> None:
 
     async def check_user_bot_same_channel(self, ia: discord.Interaction) -> bool:
         """Return True if the user is in the same channel as the bot."""
-        vc: discord.VoiceProtocol = discord.utils.get(
-            self.bot.voice_clients, guild=ia.guild
-        )
+        vc = discord.utils.get(self.bot.voice_clients, guild=ia.guild)
         if vc:
             channel: discord.VoiceChannel | discord.StageChannel = vc.channel
             try:
@@ -124,6 +122,20 @@ async def check_user_bot_same_channel(self, ia: discord.Interaction) -> bool:
         else:
             return True
 
+    async def play_track(
+        self, player: wavelink.Player, track: wavelink.Playable
+    ) -> None:
+        """Play a track. Also handles seeking to a specific start time."""
+        await player.play(track, end=dict(track.extras)["end"])
+        if dict(track.extras)["start"] != 0:
+            # https://github.com/lavalink-devs/youtube-source/issues/97
+            await player.pause(True)
+            await asyncio.sleep(1)
+            await player.pause(False)
+            await player.seek(dict(track.extras)["start"])
+
+        logger.info(f"Playing track: {track.title}")
+
     # UTILITIES END
     ######################################
 
@@ -146,7 +158,7 @@ async def on_wavelink_track_start(
         for member in payload.player.channel.members:
             if not member.bot:
                 await payload.player.channel.send(
-                    "Now playing *{title}*{looping}!".format(
+                    "Now playing `{title}`{looping}!".format(
                         title=payload.track.title,
                         looping=" (looping)"
                         if payload.player.queue.mode != wavelink.QueueMode.normal
@@ -179,7 +191,7 @@ async def on_wavelink_track_end(
                 return
 
             await asyncio.sleep(1)
-            await payload.player.play(track)
+            await self.play_track(payload.player, track)
         else:
             logger.error(f"Music playing stopped. Reason: {payload.reason.upper()}")
             await payload.player.channel.send(
@@ -198,9 +210,17 @@ async def on_wavelink_track_end(
     @discord.app_commands.guild_only()
     @discord.app_commands.describe(
         youtube_url="URL of the Youtube video you want to play.",
+        start="Start time of the song in seconds. Default: 0",
+        end="End time of the song in seconds. Default: None",
     )
     @check_node_exist
-    async def play(self, ia: discord.Interaction, youtube_url: str) -> None:
+    async def play(
+        self,
+        ia: discord.Interaction,
+        youtube_url: str,
+        start: int = 0,
+        end: None | int = None,
+    ) -> None:
         """Play a song with the given search query."""
 
         # User must be in a voice channel
@@ -218,6 +238,10 @@ async def play(self, ia: discord.Interaction, youtube_url: str) -> None:
             )
             return
 
+        if end and start >= end:
+            await ia.response.send_message("Start time must be earlier than end time!")
+            return
+
         # Delay response, maximum 15 mins
         await ia.response.defer()
 
@@ -245,8 +269,14 @@ async def play(self, ia: discord.Interaction, youtube_url: str) -> None:
         )
 
         track = tracks[0]
-        # Add requester name to track, so that the `queue` command can show it
-        track.extras = {"requester": ia.user.name}
+        # Extra information of the track
+        track.extras = {
+            # Add requester name to track, so that the `queue` command can show it
+            "requester": ia.user.name,
+            # Add start and end time to track (used by the voice player)
+            "start": start * 1000,
+            "end": end * 1000 if end is not None else None,
+        }
 
         await vc.queue.put_wait(track)
         await ia.followup.send(
@@ -258,7 +288,8 @@ async def play(self, ia: discord.Interaction, youtube_url: str) -> None:
             )
         )
         if not vc.playing:
-            await vc.play(vc.queue.get())
+            track = vc.queue.get()
+            await self.play_track(vc, track)
 
     @discord.app_commands.command()
     @discord.app_commands.guild_only()

src/my_discord_bot/models/_model_base.py

@@ -2,7 +2,7 @@
 from sqlalchemy.orm import DeclarativeBase, MappedAsDataclass
 
 
-class ModelBase(DeclarativeBase, MappedAsDataclass):
+class ModelBase(MappedAsDataclass, DeclarativeBase):
     metadata = MetaData(
         naming_convention={
             "ix": "ix_%(column_0_label)s",

src/my_discord_bot/models/guild.py

@@ -1,4 +1,4 @@
-from sqlalchemy import Identity, String
+from sqlalchemy import Identity, Unicode
 from sqlalchemy.orm import Mapped, mapped_column
 
 from ._model_base import ModelBase
@@ -8,9 +8,9 @@ class Guild(ModelBase):
     __tablename__ = "guild"
 
     id: Mapped[int] = mapped_column(
-        Identity(always=True, start=1, increment=1), primary_key=True
+        Identity(always=True, start=1, increment=1), primary_key=True, init=False
     )
     guild_id: Mapped[int] = mapped_column(unique=True)
-    guild_name: Mapped[str] = mapped_column(String(100))
-    bot_channel: Mapped[None | int] = mapped_column()
-    welcome_message: Mapped[None | str] = mapped_column(String(2000))
+    guild_name: Mapped[str] = mapped_column(Unicode(100))
+    bot_channel: Mapped[None | int] = mapped_column(default=None)
+    welcome_message: Mapped[None | str] = mapped_column(Unicode(2000), default=None)