base for alembic, added init migration

.isort.cfg

@@ -1,2 +1,3 @@
 [settings]
-line_length=120
+line_length=120
+skip_glob=alembic/*

alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = alembic
+
+# 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.
+# 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 alembic/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:alembic/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
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# 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:///database_word_chain.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 = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+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

alembic/README

@@ -0,0 +1,8 @@
+## How to do migrations
+
+* change the model classes in `model.py`
+* create revision with the console
+  * either as an autogenerated change: `alembic revision --autogenerate -m "<describe the change here>"`
+  * or as am empty change: `alembic revision -m "<describe the change here>"`
+* check the new file and change it if necessary (table and column renames are usually not detected by autogenerate)
+* apply the change with `alembic update head` (or run the bot, which applies it as well in the setup hook)

alembic/env.py

@@ -0,0 +1,79 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config, pool
+
+from alembic import context
+
+# 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:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+from model import Base
+
+target_metadata = Base.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()

alembic/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"}

alembic/versions/d060a8ef2794_init.py

@@ -0,0 +1,34 @@
+"""init
+
+Revision ID: d060a8ef2794
+Revises: 
+Create Date: 2024-10-17 19:37:59.413168
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'd060a8ef2794'
+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:
+    op.execute('CREATE TABLE IF NOT EXISTS blacklist (server_id INT NOT NULL, words TEXT NOT NULL, PRIMARY KEY (server_id, words))')
+    op.execute('CREATE TABLE IF NOT EXISTS whitelist (server_id INT NOT NULL, words TEXT NOT NULL, PRIMARY KEY (server_id, words))')
+    op.execute('CREATE TABLE IF NOT EXISTS members (server_id INTEGER NOT NULL, member_id INTEGER NOT NULL, score INTEGER NOT NULL, correct INTEGER NOT NULL, wrong INTEGER NOT NULL, karma REAL NOT NULL, PRIMARY KEY (server_id, member_id))')
+    op.execute('CREATE TABLE IF NOT EXISTS used_words (server_id INTEGER NOT NULL, words TEXT NOT NULL, PRIMARY KEY (server_id, words))')
+    op.execute('CREATE TABLE IF NOT EXISTS word_cache (words TEXT PRIMARY KEY)')
+
+
+def downgrade() -> None:
+    op.execute('DROP TABLE blacklist')
+    op.execute('DROP TABLE whitelist')
+    op.execute('DROP TABLE members')
+    op.execute('DROP TABLE used_words')
+    op.execute('DROP TABLE word_cache')

main.py

@@ -18,6 +18,8 @@
 from sqlalchemy import Column, CursorResult, delete, exists, func, insert, select, update
 from sqlalchemy.ext.asyncio import AsyncConnection, create_async_engine
 from sqlalchemy.sql.functions import count
+from alembic.config import Config as AlembicConfig
+from alembic import command as alembic_command
 
 from consts import *
 from data import calculate_total_karma
@@ -788,39 +790,8 @@ async def setup_hook(self) -> NoReturn:
         await self.tree.sync()
         logger.info('Commands synchronized')
 
-        conn: sqlite3.Connection = sqlite3.connect(Bot.DB_FILE)
-        cursor: sqlite3.Cursor = conn.cursor()
-
-        cursor.execute(f'CREATE TABLE IF NOT EXISTS {Bot.TABLE_MEMBERS} '
-                       '(server_id INTEGER NOT NULL, '
-                       'member_id INTEGER NOT NULL, '
-                       'score INTEGER NOT NULL, '
-                       'correct INTEGER NOT NULL, '
-                       'wrong INTEGER NOT NULL, '
-                       'karma REAL NOT NULL, '
-                       'PRIMARY KEY (server_id, member_id))')
-
-        cursor.execute(f'CREATE TABLE IF NOT EXISTS {Bot.TABLE_USED_WORDS} '
-                       f'(server_id INTEGER NOT NULL, '
-                       'words TEXT NOT NULL, '
-                       'PRIMARY KEY (server_id, words))')
-
-        cursor.execute(f'CREATE TABLE IF NOT EXISTS {Bot.TABLE_CACHE} '
-                       f'(words TEXT PRIMARY KEY)')
-
-        cursor.execute(f'CREATE TABLE IF NOT EXISTS {Bot.TABLE_BLACKLIST} '
-                       f'(server_id INT NOT NULL, '
-                       f'words TEXT NOT NULL, '
-                       f'PRIMARY KEY (server_id, words))')
-
-        cursor.execute(f'CREATE TABLE IF NOT EXISTS {Bot.TABLE_WHITELIST} '
-                       f'(server_id INT NOT NULL, '
-                       f'words TEXT NOT NULL, '
-                       f'PRIMARY KEY (server_id, words))')
-
-        conn.commit()
-        conn.close()
-
+        alembic_cfg = AlembicConfig('alembic.ini')
+        alembic_command.upgrade(alembic_cfg, 'head')
 
 bot = Bot()
 

requirements.txt

@@ -4,3 +4,4 @@ requests-futures>=1.0.1
 pydantic>=2.9.2
 SQLAlchemy>=2.0.36
 aiosqlite>=0.20.0
+alembic>=1.13.3