Merge pull request #709 from TotallyNotRobots/sqlalchemy-2.0

refactor: Migrate to sqlalchemy 2.0-style statements

Author: linuxdaemon

.github/workflows/pythonapp.yml

@@ -45,6 +45,7 @@ jobs:
       env:
         PYTHONDEVMODE: 1
         PYTHONPATH: .
+        SQLALCHEMY_WARN_20: 1
 
     - uses: codecov/codecov-action@v4
       with:

cloudbot/bot.py

@@ -486,7 +486,7 @@ def migrate_db(self) -> None:
             if not inspector.has_table(table.name):
                 continue
 
-            old_data = old_session.execute(table.select()).fetchall()
+            old_data = old_session.execute(table.select()).mappings().fetchall()
             if not old_data:
                 continue
 

cloudbot/util/database.py

@@ -4,16 +4,20 @@
 
 from sqlalchemy import MetaData
 from sqlalchemy.engine import Engine
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import close_all_sessions, scoped_session, sessionmaker
+from sqlalchemy.orm import (
+    close_all_sessions,
+    declarative_base,
+    scoped_session,
+    sessionmaker,
+)
 
 __all__ = ("metadata", "base", "Base", "Session", "configure")
 
 
 Base = declarative_base()
 base = Base
 metadata: MetaData = Base.metadata
-Session = scoped_session(sessionmaker())
+Session = scoped_session(sessionmaker(future=True))
 
 
 def configure(bind: Engine = None) -> None:

plugins/badwords.py

@@ -33,7 +33,7 @@ def load_bad(db):
     """- Should run on start of bot to load the existing words into the regex"""
     words = []
     new_cache = defaultdict(list)
-    for chan, word in db.execute(select([table.c.chan, table.c.word])):
+    for chan, word in db.execute(select(table.c.chan, table.c.word)):
         new_cache[chan.casefold()].append(word)
         words.append(word)
 

plugins/chain.py

@@ -23,7 +23,7 @@
 def load_cache(db):
     new_cache = {}
     for row in db.execute(commands.select()):
-        new_cache[row["hook"]] = row["allowed"]
+        new_cache[row.hook] = row.allowed
 
     allow_cache.clear()
     allow_cache.update(new_cache)

plugins/core/autojoin.py

@@ -26,7 +26,7 @@
 def load_cache(db):
     new_cache = defaultdict(set)
     for row in db.execute(table.select()):
-        new_cache[row["conn"]].add(row["chan"])
+        new_cache[row.conn].add(row.chan)
 
     with db_lock:
         chan_cache.clear()

plugins/core/chan_key_db.py

@@ -35,12 +35,12 @@ def load_keys(conn: IrcClient, db) -> None:
     """
     Load channel keys to the client
     """
-    query = select(
-        [table.c.chan, table.c.key], table.c.conn == conn.name.lower()
+    query = select(table.c.chan, table.c.key).where(
+        table.c.conn == conn.name.lower()
     )
     conn.clear_channel_keys()
     for row in db.execute(query):
-        conn.set_channel_key(row["chan"], row["key"])
+        conn.set_channel_key(row.chan, row.key)
 
 
 @hook.irc_raw("MODE")

plugins/core/ignore.py

@@ -34,9 +34,9 @@
 def load_cache(db):
     new_cache = []
     for row in db.execute(table.select()):
-        conn = row["connection"]
-        chan = row["channel"]
-        mask = row["mask"]
+        conn = row.connection
+        chan = row.channel
+        mask = row.mask
         new_cache.append((conn, chan, mask))
 
     ignore_cache.clear()
@@ -182,16 +182,15 @@ def listignores(db, conn, chan):
     """- List all active ignores for the current channel"""
 
     rows = db.execute(
-        select(
-            [table.c.mask],
+        select(table.c.mask).where(
             and_(
                 table.c.connection == conn.name.lower(),
                 table.c.channel == chan.lower(),
             ),
         )
     ).fetchall()
 
-    out = "\n".join(row["mask"] for row in rows) + "\n"
+    out = "\n".join(row.mask for row in rows) + "\n"
 
     return web.paste(out)
 
@@ -245,13 +244,13 @@ def list_all_ignores(db, conn, text):
         whereclause = and_(whereclause, table.c.channel == text.lower())
 
     rows = db.execute(
-        select([table.c.channel, table.c.mask], whereclause)
+        select(table.c.channel, table.c.mask).where(whereclause)
     ).fetchall()
 
     ignores: Dict[str, List[str]] = OrderedDict()
 
     for row in rows:
-        ignores.setdefault(row["channel"], []).append(row["mask"])
+        ignores.setdefault(row.channel, []).append(row.mask)
 
     out = ""
     for chan, masks in ignores.items():

plugins/core/optout.py

@@ -175,9 +175,7 @@ def clear_optout(db, conn, chan=None):
 def load_cache(db):
     new_cache = defaultdict(list)
     for row in db.execute(optout_table.select()):
-        new_cache[row["network"]].append(
-            OptOut(row["chan"], row["hook"], row["allow"])
-        )
+        new_cache[row.network].append(OptOut(row.chan, row.hook, row.allow))
 
     for opts in new_cache.values():
         opts.sort(reverse=True)

plugins/core/regex_chans.py

@@ -36,9 +36,9 @@
 def load_cache(db):
     new_cache = {}
     for row in db.execute(table.select()):
-        conn = row["connection"]
-        chan = row["channel"]
-        status = row["status"]
+        conn = row.connection
+        chan = row.channel
+        status = row.status
         if status == ENABLED:
             value = True
         elif status == DISABLED: