Merge pull request #110 from LewisProjects/development

Fix

alembic.ini

@@ -0,0 +1,114 @@
+# 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
+# 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 = 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 = driver://user:pass@localhost/dbname
+
+
+[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 with an async dbapi.

alembic/env.py

@@ -0,0 +1,98 @@
+import asyncio
+import os
+from logging.config import fileConfig
+from dotenv import load_dotenv
+
+from sqlalchemy import pool
+from sqlalchemy.engine import Connection
+from sqlalchemy.ext.asyncio import async_engine_from_config
+
+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 utils.db_models 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.
+load_dotenv("secrets.env")
+config.set_main_option("sqlalchemy.url", os.environ["POSTGRES_CONNECTION_STRING"])
+
+
+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 do_run_migrations(connection: Connection) -> None:
+    context.configure(connection=connection, target_metadata=target_metadata)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+async def run_async_migrations() -> None:
+    """In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    connectable = async_engine_from_config(
+        config.get_section(
+            config.config_ini_section,
+            {},
+        ),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    async with connectable.connect() as connection:
+        await connection.run_sync(do_run_migrations)
+
+    await connectable.dispose()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode."""
+
+    asyncio.run(run_async_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"}

requirements.txt

@@ -1,4 +1,4 @@
-aiohttp~=3.8.3
+aiohttp~=3.9.1
 asyncpg==0.29.0
 akinator~=1.0.3
 disnake==2.9.1
@@ -13,4 +13,6 @@ cachetools==5.3.0
 python-dateutil~=2.8.2
 pytz==2022.7.1
 discord_together==1.2.6
-better_profanity==0.7.0
+better_profanity==0.7.0
+sqlalchemy[asyncio]==2.0.23
+alembic==1.13.1

setup.sql

@@ -1,6 +1,6 @@
 CREATE TABLE IF NOT EXISTS tags
 (
-    tag_id TEXT,
+    tag_id TEXT PRIMARY KEY,
     content TEXT,
     owner BIGINT,
     created_at BIGINT,
@@ -15,6 +15,7 @@ CREATE TABLE IF NOT EXISTS tag_relations
 
 CREATE TABLE IF NOT EXISTS blacklist
 (
+    id SERIAL PRIMARY KEY,
     user_id BIGINT,
     reason TEXT,
     bot BOOLEAN,
@@ -25,6 +26,7 @@ CREATE TABLE IF NOT EXISTS blacklist
 
 CREATE TABLE IF NOT EXISTS flag_quiz
 (
+    id BIGINT PRIMARY KEY,
     user_id BIGINT,
     tries INTEGER,
     correct INTEGER,
@@ -34,7 +36,7 @@ CREATE TABLE IF NOT EXISTS flag_quiz
 
 CREATE TABLE IF NOT EXISTS trivia
 (
-    id BIGINT,
+    id BIGINT PRIMARY KEY,
     correct INTEGER,
     incorrect INTEGER,
     streak INTEGER,
@@ -43,6 +45,7 @@ CREATE TABLE IF NOT EXISTS trivia
 
 CREATE TABLE IF NOT EXISTS reaction_roles
 (
+    id SERIAL PRIMARY KEY,
     message_id BIGINT,
     role_id BIGINT,
     emoji TEXT,
@@ -60,6 +63,7 @@ CREATE TABLE IF NOT EXISTS warnings
 
 CREATE TABLE IF NOT EXISTS levels
 (
+    id SERIAL PRIMARY KEY,
     guild_id BIGINT,
     user_id BIGINT,
     level INTEGER DEFAULT 0,
@@ -68,28 +72,31 @@ CREATE TABLE IF NOT EXISTS levels
 
 CREATE TABLE IF NOT EXISTS role_rewards
 (
+    id SERIAL PRIMARY KEY,
     guild_id BIGINT,
     role_id BIGINT,
     required_lvl INTEGER DEFAULT 0
 );
 
 CREATE TABLE IF NOT EXISTS birthday
 (
+    id SERIAL PRIMARY KEY,
     user_id BIGINT,
     birthday TEXT DEFAULT NULL,
     birthday_last_changed BIGINT DEFAULT NULL
 );
 
 CREATE TABLE IF NOT EXISTS timezone
 (
+    id SERIAL PRIMARY KEY,
     user_id BIGINT,
     timezone TEXT DEFAULT NULL,
     timezone_last_changed BIGINT DEFAULT NULL
 );
 
 CREATE TABLE IF NOT EXISTS config
 (
-    guild_id BIGINT,
+    guild_id BIGINT PRIMARY KEY,
     xp_boost INTEGER DEFAULT 1,
     xp_boost_expiry BIGINT DEFAULT 0,
     xp_boost_enabled BOOLEAN DEFAULT TRUE,
@@ -98,6 +105,7 @@ CREATE TABLE IF NOT EXISTS config
 
 CREATE TABLE IF NOT EXISTS commands
 (
+    id SERIAL PRIMARY KEY,
     guild_id BIGINT,
     command TEXT,
     command_used INTEGER DEFAULT 0,
@@ -106,6 +114,7 @@ CREATE TABLE IF NOT EXISTS commands
 
 CREATE TABLE IF NOT EXISTS total_commands
 (
+    id SERIAL PRIMARY KEY,
     guild_id  BIGINT UNIQUE,
     total_commands_used INTEGER DEFAULT 0
 );

utils/bot.py

@@ -1,12 +1,12 @@
 import asyncio
 from datetime import datetime
-from os import listdir
+from sqlalchemy.ext.asyncio import create_async_engine
+from db_models import Base
 
 import asyncpg
 import disnake
 from disnake import ApplicationCommandInteraction, OptionType
 from disnake.ext import commands
-from disnake.ext.commands.interaction_bot_base import CFT
 
 from utils.CONSTANTS import __VERSION__
 from utils.DBhandlers import BlacklistHandler
@@ -128,6 +128,8 @@ async def load_db(self):
         pass
 
     async def start(self, *args, **kwargs):
+
+        # engine = create_async_engine(self.config.Database.connection_string)
         self.db = await asyncpg.create_pool(self.config.Database.connection_string)
         await self.db.execute(SETUP_SQL)
         # run the db migrations in /migrations