SQLAlchemy: Clean up and refactor SQLAlchemy polyfills

... to `cratedb_toolkit.util.sqlalchemy`.
crate · Jul 6, 2024 · a654983 · a654983
1 parent 19c5cff
commit a654983
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 269 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -5,6 +5,8 @@
 - IO: Added the `if-exists` query parameter by updating to influxio 0.4.0.
 - Rockset: Added CrateDB Rockset Adapter, a HTTP API emulation layer
 - MongoDB: Added adapter amalgamating PyMongo to use CrateDB as backend
+- SQLAlchemy: Clean up and refactor SQLAlchemy polyfills
+  to `cratedb_toolkit.util.sqlalchemy`
 
 ## 2024/06/18 v0.0.14
 - Add `ctk cfr` and `ctk wtf` diagnostics programs

diff --git a/cratedb_toolkit/adapter/pymongo/api.py b/cratedb_toolkit/adapter/pymongo/api.py
@@ -3,9 +3,9 @@
 import pymongo.collection
 
 from cratedb_toolkit.adapter.pymongo.collection import collection_factory
-from cratedb_toolkit.sqlalchemy.patch import patch_types_map
 from cratedb_toolkit.util import DatabaseAdapter
 from cratedb_toolkit.util.pandas import patch_pandas_sqltable_with_extended_mapping
+from cratedb_toolkit.util.sqlalchemy import patch_types_map
 
 
 class PyMongoCrateDBAdapter:

diff --git a/cratedb_toolkit/adapter/pymongo/backlog.md b/cratedb_toolkit/adapter/pymongo/backlog.md
@@ -2,7 +2,7 @@
 
 ## Iteration +1
 - Upstream / converge patches.
-  - `cratedb_toolkit/sqlalchemy/patch.py`
+  - `cratedb_toolkit/util/sqlalchemy.py`
   - `cratedb_toolkit/util/pandas.py`
   - `cratedb_toolkit/adapter/pymongo/api.py::adjust_sqlalchemy`
   - `cratedb_toolkit/adapter/pymongo/collection.py::insert_returning_id`

diff --git a/cratedb_toolkit/cfr/systable.py b/cratedb_toolkit/cfr/systable.py
@@ -27,9 +27,9 @@
 import sqlalchemy as sa
 from tqdm import tqdm
 
-from cratedb_toolkit.sqlalchemy.patch import patch_encoder
 from cratedb_toolkit.util import DatabaseAdapter
 from cratedb_toolkit.util.cli import error_logger
+from cratedb_toolkit.util.sqlalchemy import patch_encoder
 from cratedb_toolkit.wtf.core import InfoContainer
 
 logger = logging.getLogger(__name__)

diff --git a/cratedb_toolkit/sqlalchemy/__init__.py b/cratedb_toolkit/sqlalchemy/__init__.py
diff --git a/cratedb_toolkit/sqlalchemy/polyfill.py b/cratedb_toolkit/sqlalchemy/polyfill.py
diff --git a/cratedb_toolkit/sqlalchemy/patch.py → cratedb_toolkit/util/sqlalchemy.py b/cratedb_toolkit/sqlalchemy/patch.py → cratedb_toolkit/util/sqlalchemy.py
@@ -1,3 +1,9 @@
+"""
+Patches and polyfills, mostly for SQLAlchemy.
+
+TODO: Refactor to `crate` or `sqlalchemy-cratedb` packages.
+"""
+
 import calendar
 import datetime as dt
 import json

diff --git a/tests/sqlalchemy/test_patch.py b/tests/sqlalchemy/test_patch.py
@@ -4,7 +4,7 @@
 import pytest
 import sqlalchemy as sa
 
-from cratedb_toolkit.sqlalchemy.patch import CrateJsonEncoderWithNumPy
+from cratedb_toolkit.util.sqlalchemy import CrateJsonEncoderWithNumPy
 from tests.conftest import TESTDRIVE_DATA_SCHEMA
 
 

diff --git a/tests/sqlalchemy/test_polyfill.py b/tests/sqlalchemy/test_polyfill.py