Add alembic and migrations

README.md

@@ -63,7 +63,6 @@ Note: The `latest` tag refers to the latest stable version.
   - [ ] AI.draw: Add [stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) support
 - [ ] Allow passing arguments to FFMPEG (for hardware acceleration)
 - [ ] Allow bot owner to run every command (including admin only commands)
-- [ ] Setup migration with alembic
 
 ## Notable commands
 

alembic.ini

@@ -0,0 +1,119 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+version_path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = sqlite:///volume/db.sqlite3
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

migrations/env.py

@@ -0,0 +1,79 @@
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+from my_discord_bot.models._model_base import ModelBase
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if (
+    config.config_file_name is not None
+    and "no_alembic_loggers" not in config.attributes
+):
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = [ModelBase.metadata]
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migrations/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

migrations/versions/a29aedea6bce_first_migration.py

@@ -0,0 +1,44 @@
+"""First migration
+
+Revision ID: a29aedea6bce
+Revises:
+Create Date: 2025-02-02 22:16:04.229508
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "a29aedea6bce"
+down_revision: Union[str, None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "guild",
+        sa.Column(
+            "id",
+            sa.Integer(),
+            sa.Identity(always=True, start=1, increment=1),
+            nullable=False,
+        ),
+        sa.Column("guild_id", sa.Integer(), nullable=False),
+        sa.Column("guild_name", sa.String(length=100), nullable=False),
+        sa.Column("bot_channel", sa.Integer(), nullable=True),
+        sa.Column("welcome_message", sa.String(length=2000), nullable=True),
+        sa.PrimaryKeyConstraint("id", name=op.f("pk_guild")),
+        sa.UniqueConstraint("guild_id", name=op.f("uq_guild_guild_id")),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("guild")
+    # ### end Alembic commands ###

pyproject.toml

@@ -7,6 +7,7 @@ requires-python = ">=3.11"
 dependencies = [
     "aiohttp==3.*",
     "aiosqlite==0.*",
+    "alembic==1.*",
     "discord-py[voice]==2.*",
     "gallery-dl==1.*",
     "openai==1.*",

src/my_discord_bot/__main__.py

@@ -5,46 +5,55 @@
 from pathlib import Path
 
 import discord
+from alembic import command
+from alembic.config import Config
 from dotenv import load_dotenv
 from sqlalchemy import event
 from sqlalchemy.engine.interfaces import DBAPIConnection
 from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine
 from sqlalchemy.pool import ConnectionPoolEntry
 
 from .bot import DiscordBot
-from .models import ModelBase
+
+# Initialization
+Path("./volume/logs").mkdir(parents=True, exist_ok=True)
+Path("./volume/gallery-dl").mkdir(parents=True, exist_ok=True)
+
+# Logger
+logger = logging.getLogger()
+logger.setLevel("INFO")
+logger.addHandler(logging.StreamHandler())
+# Time Rotating File Handler
+logHandler = TimedRotatingFileHandler(
+    Path("./volume/logs/discord.log"), when="D", backupCount=10, encoding="utf-8"
+)
+logHandler.setFormatter(
+    logging.Formatter(
+        "%(asctime)s %(levelname)-8s %(name)-15s %(message)s",
+        datefmt="%H:%M:%S",
+    )
+)
+logger.addHandler(logHandler)
+
+
+# Load .env and basic sanity checking
+load_dotenv(dotenv_path="./.env")
+for env in ["DISCORD_TOKEN", "PREFIX"]:
+    if not os.getenv(env):
+        errMsg = f"{env} is not set in both .env and the OS environment. Exiting..."
+        logger.error(errMsg)
+        raise Exception(errMsg)
+
+logging.info("Running migrations...")
+alembic_cfg = Config("./alembic.ini")
+alembic_cfg.attributes["no_alembic_loggers"] = True
+command.upgrade(alembic_cfg, "head")
 
 
 async def main() -> None:
     """Entrypoint of the bot."""
 
-    # Initialization
-    Path("./volume/logs").mkdir(parents=True, exist_ok=True)
-    Path("./volume/gallery-dl").mkdir(parents=True, exist_ok=True)
-
-    # Logger
-    logger = logging.getLogger()
-    logger.setLevel("INFO")
-    logger.addHandler(logging.StreamHandler())
-    # Time Rotating File Handler
-    logHandler = TimedRotatingFileHandler(
-        Path("./volume/logs/discord.log"), when="D", backupCount=10, encoding="utf-8"
-    )
-    logHandler.setFormatter(
-        logging.Formatter(
-            "%(asctime)s %(levelname)-8s %(name)-15s %(message)s",
-            datefmt="%H:%M:%S",
-        )
-    )
-    logger.addHandler(logHandler)
-
-    # Load .env and basic sanity checking
-    load_dotenv(dotenv_path="./.env")
-    for env in ["DISCORD_TOKEN", "PREFIX"]:
-        if not os.getenv(env):
-            errMsg = f"{env} is not set in both .env and the OS environment. Exiting..."
-            logger.error(errMsg)
-            raise Exception(errMsg)
+    logging.info("\nSetting up the bot...")
 
     # Database initialization
     engine = create_async_engine("sqlite+aiosqlite:///volume/db.sqlite3", echo=True)
@@ -58,8 +67,6 @@ def set_sqlite_pragma(
         cursor.execute("PRAGMA foreign_keys=ON")
         cursor.close()
 
-    async with engine.begin() as conn:
-        await conn.run_sync(ModelBase.metadata.create_all)
     async_session = async_sessionmaker(engine, expire_on_commit=False)
 
     intents = discord.Intents.default()
@@ -74,7 +81,6 @@ def set_sqlite_pragma(
         os.getenv("PREFIX", ">>"), intents, activity, description, async_session
     )
 
-    logger.info("STARTING DISCORD BOT PROCESS...\n")
     await bot.start(os.getenv("DISCORD_TOKEN", ""))