WIP: Conversion to SQLAlchemy v2

src/cihai/core.py

@@ -6,6 +6,7 @@
 import typing as t
 from cihai._internal.config_reader import ConfigReader
 from cihai.data.unihan.dataset import Unihan
+
 from unihan_etl.util import merge_dict
 
 from . import exc, extend
@@ -71,6 +72,7 @@ class Cihai:
     default_config: "UntypedDict" = DEFAULT_CONFIG
     config: "ConfigDict"
     unihan: Unihan
+    sql: Database
 
     def __init__(
         self,

src/cihai/data/unihan/bootstrap.py

@@ -1,6 +1,7 @@
 import typing as t
 
 import sqlalchemy.sql.schema
+import sqlalchemy
 from sqlalchemy import Column, String, Table
 
 from unihan_etl import process as unihan
@@ -11,6 +12,7 @@
 
 
 def bootstrap_unihan(
+    engine: sqlalchemy.Engine,
     metadata: sqlalchemy.sql.schema.MetaData,
     options: t.Optional[t.Dict[str, object]] = None,
 ) -> None:
@@ -24,9 +26,11 @@ def bootstrap_unihan(
     p.download()
     data = p.export()
     table = create_unihan_table(UNIHAN_FIELDS, metadata)
-    metadata.create_all()
-    assert metadata.bind is not None
-    metadata.bind.execute(table.insert(), data)
+
+    metadata.create_all(engine)
+    with engine.connect() as conn:
+        conn.execute(table.insert().values(data))
+        conn.commit()
 
 
 TABLE_NAME = "Unihan"

src/cihai/data/unihan/dataset.py

@@ -26,7 +26,9 @@ def bootstrap(self, options: Optional[Dict[str, object]] = None) -> None:
         if options is None:
             options = {}
 
-        bootstrap.bootstrap_unihan(self.sql.metadata, options=options)
+        bootstrap.bootstrap_unihan(
+            engine=self.sql.engine, metadata=self.sql.metadata, options=options
+        )
         self.sql.reflect_db()  # automap new table created during bootstrap
 
     def lookup_char(self, char: str) -> "Query[Unihan]":

src/cihai/db.py

@@ -30,7 +30,6 @@ def __init__(self, config: ConfigDict) -> None:
         self.engine = create_engine(config["database"]["url"])
 
         self.metadata = MetaData()
-        self.metadata.bind = self.engine
         self.reflect_db()
 
         self.session = Session(self.engine)
@@ -42,6 +41,6 @@ def reflect_db(self) -> None:
         This is available as a method so the database can be reflected
         outside initialization (such bootstrapping unihan during CLI usage).
         """
-        self.metadata.reflect(views=True, extend_existing=True)
+        self.metadata.reflect(bind=self.engine, views=True, extend_existing=True)
         self.base = automap_base(metadata=self.metadata)
         self.base.prepare()

tests/conftest.py

@@ -4,6 +4,8 @@
 
 import pytest
 
+import sqlalchemy
+
 from cihai.data.unihan.constants import UNIHAN_FILES
 
 
@@ -52,3 +54,13 @@ def unihan_options(
 @pytest.fixture(scope="function")
 def tmpdb_file(tmpdir: str) -> str:
     return tmpdir.join("test.db")
+
+
+@pytest.fixture(scope="session")
+def engine():
+    return sqlalchemy.create_engine("sqlite:///")
+
+
+@pytest.fixture(scope="session")
+def metadata() -> sqlalchemy.MetaData:
+    return sqlalchemy.MetaData()

tests/data/unihan/test_bootstrap.py

@@ -10,7 +10,7 @@ def test_reflect_db(
 ) -> None:
     c = Cihai(config={"database": {"url": f"sqlite:///{tmpdb_file}"}})
     assert not c.unihan.is_bootstrapped
-    bootstrap.bootstrap_unihan(c.sql.metadata, unihan_options)
+    bootstrap.bootstrap_unihan(c.sql.engine, c.sql.metadata, unihan_options)
     assert not hasattr(c.sql.base.classes, "Unihan")
     c.unihan.sql.reflect_db()
     assert hasattr(c.sql.base.classes, "Unihan")

tests/test_cihai.py

@@ -5,6 +5,7 @@
 
 """
 import typing as t
+import sqlalchemy
 
 import cihai
 from cihai.constants import UNIHAN_CONFIG
@@ -43,10 +44,14 @@ def test_yaml_config_and_override(test_config_file: str) -> None:
 
 
 def test_unihan_options(
-    unihan_options: t.Dict[str, object], test_config_file: str
+    unihan_options: t.Dict[str, object],
+    engine: sqlalchemy.Engine,
+    test_config_file: str,
 ) -> None:
     app = Cihai.from_file(test_config_file)
-    bootstrap.bootstrap_unihan(app.sql.metadata, unihan_options)
+    bootstrap.bootstrap_unihan(
+        engine=engine, metadata=app.sql.metadata, options=unihan_options
+    )
     assert "Unihan" in app.sql.metadata.tables
     assert app.sql.metadata.tables["Unihan"].columns
     assert set(app.sql.metadata.tables["Unihan"].columns.keys()) == set(