Add reminders functionality

.gitignore

@@ -15,3 +15,6 @@ docs/build
 
 # local env
 .env*
+
+# Virtual environment
+.venv

alembic.ini

@@ -0,0 +1,113 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+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-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# 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 = 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
+
+[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 @@
+Generic single-database configuration.

alembic/env.py

@@ -0,0 +1,80 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+from bot import constants
+from bot.orm.models import Base
+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
+
+# modify the config here because ConfigParser can't handle default values
+config.set_main_option("sqlalchemy.url", constants.Bot.database_dsn)
+
+# 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
+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/14dcb08ebf2e_initial_revision.py

@@ -0,0 +1,45 @@
+"""initial revision
+
+Revision ID: 14dcb08ebf2e
+Revises:
+Create Date: 2023-10-15 21:13:49.716003
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "14dcb08ebf2e"
+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(
+        "guilds", sa.Column("guild_id", sa.BigInteger(), nullable=False), sa.PrimaryKeyConstraint("guild_id")
+    )
+    op.create_table(
+        "reminders",
+        sa.Column("id", sa.Integer(), autoincrement=True, nullable=False),
+        sa.Column("channel_id", sa.BigInteger(), nullable=False),
+        sa.Column("message_id", sa.BigInteger(), nullable=False),
+        sa.Column("author_id", sa.BigInteger(), nullable=False),
+        sa.Column("mention_ids", sa.ARRAY(sa.BigInteger()), nullable=False),
+        sa.Column("content", sa.String(), nullable=False),
+        sa.Column("expiration", sa.DateTime(timezone=True), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("id"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("reminders")
+    op.drop_table("guilds")
+    # ### end Alembic commands ###

pyproject.toml

@@ -26,7 +26,6 @@ line-length = 120
 [tool.ruff]
 target-version = "py311"
 line-length = 120
-select = ["ALL"]
 ignore = [
   "ERA001", # (Found commented-out code) - Porting features a piece at a time
   "G004", # (Logging statement uses f-string) - Developer UX

requirements/requirements.in

@@ -16,6 +16,7 @@ coloredlogs
 # Database
 psycopg[binary]
 SQLAlchemy
+alembic
 
 # Utilities
 # utils/helpers

requirements/requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    pip-compile --output-file=requirements/requirements.txt requirements/requirements.in
+#    pip-compile requirements/requirements.in
 #
 aiodns==3.0.0
     # via pydis-core
@@ -12,6 +12,8 @@ aiohttp==3.8.6
     #   discord-py
 aiosignal==1.3.1
     # via aiohttp
+alembic==1.12.0
+    # via -r requirements/requirements.in
 annotated-types==0.6.0
     # via pydantic
 arrow==1.3.0
@@ -53,6 +55,10 @@ idna==3.4
     #   yarl
 imsosorry==1.2.1
     # via -r requirements/requirements.in
+mako==1.2.4
+    # via alembic
+markupsafe==2.1.3
+    # via mako
 multidict==6.0.4
     # via
     #   aiohttp
@@ -96,7 +102,9 @@ six==1.16.0
     #   python-dateutil
     #   requests-file
 sqlalchemy==2.0.22
-    # via -r requirements/requirements.in
+    # via
+    #   -r requirements/requirements.in
+    #   alembic
 statsd==4.0.1
     # via pydis-core
 tldextract==5.0.0
@@ -105,6 +113,7 @@ types-python-dateutil==2.8.19.14
     # via arrow
 typing-extensions==4.8.0
     # via
+    #   alembic
     #   psycopg
     #   pydantic
     #   pydantic-core

src/bot/__main__.py

@@ -5,6 +5,7 @@
 import aiohttp
 import discord
 from discord.ext import commands
+from sqlalchemy.ext.asyncio import create_async_engine
 
 from bot import constants
 from bot.bot import Bot
@@ -19,6 +20,7 @@ async def main() -> None:
         guild_id=constants.Guild.id,
         http_session=aiohttp.ClientSession(),
         allowed_roles=list({discord.Object(id_) for id_ in constants.MODERATION_ROLES}),
+        engine=create_async_engine(constants.Bot.database_dsn),
         command_prefix=commands.when_mentioned,
         intents=intents,
     )

src/bot/bot.py

@@ -1,9 +1,13 @@
 """Bot subclass."""
 
+from collections.abc import AsyncIterator
+from contextlib import asynccontextmanager
 from typing import Self
+from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
 
 from pydis_core import BotBase
 from sentry_sdk import push_scope
+from sqlalchemy.ext.asyncio.session import async_sessionmaker
 
 from bot import exts
 from bot.log import get_logger
@@ -22,9 +26,25 @@ def __init__(self: Self, base: Exception) -> None:
 class Bot(BotBase):
     """A subclass of `pydis_core.BotBase` that implements bot-specific functions."""
 
-    def __init__(self: Self, *args: list, **kwargs: dict) -> None:
+    def __init__(self: Self, *args: list, engine: AsyncEngine, **kwargs: dict) -> None:
+        self._engine = engine
+        self._sessionmaker = async_sessionmaker(bind=engine)
+
         super().__init__(*args, **kwargs)
 
+    @asynccontextmanager
+    async def get_session(self) -> AsyncIterator[AsyncSession]:
+        """Return a session in async context manager style.
+
+        Will automatically commit changes to database and close session at end of context
+        """
+        session = self._sessionmaker()
+        try:
+            yield session
+        finally:
+            await session.commit()
+            await session.close()
+
     async def setup_hook(self: Self) -> None:
         """Default async initialisation method for discord.py."""  # noqa: D401
         await super().setup_hook()