refactor(generator): Enable use of generators without engine

Author: kozlek

pyproject.toml

@@ -43,8 +43,6 @@ dynamic = ["version"]
 test = [
     "pytest >= 7.4",
     "coverage >= 7",
-    "psycopg2-binary",
-    "mysql-connector-python",
 ]
 sqlmodel = ["sqlmodel >= 0.0.12"]
 citext = ["sqlalchemy-citext >= 1.7.0"]

src/sqlacodegen/cli.py

@@ -86,7 +86,7 @@ def main() -> None:
 
     # Instantiate the generator
     generator_class = generators[args.generator].load()
-    generator = generator_class(metadata, engine, options)
+    generator = generator_class(metadata, engine.dialect, options)
 
     # Open the target file (if given)
     with ExitStack() as stack:

src/sqlacodegen/generators.py

@@ -25,6 +25,7 @@
     Computed,
     Constraint,
     DefaultClause,
+    Dialect,
     Enum,
     Float,
     ForeignKey,
@@ -39,7 +40,6 @@
     UniqueConstraint,
 )
 from sqlalchemy.dialects.postgresql import JSONB
-from sqlalchemy.engine import Connection, Engine
 from sqlalchemy.exc import CompileError
 from sqlalchemy.sql.elements import TextClause
 
@@ -94,11 +94,9 @@ class Base:
 class CodeGenerator(metaclass=ABCMeta):
     valid_options: ClassVar[set[str]] = set()
 
-    def __init__(
-        self, metadata: MetaData, bind: Connection | Engine, options: Sequence[str]
-    ):
+    def __init__(self, metadata: MetaData, dialect: Dialect, options: Sequence[str]):
         self.metadata: MetaData = metadata
-        self.bind: Connection | Engine = bind
+        self.dialect: Dialect = dialect
         self.options: set[str] = set(options)
 
         # Validate options
@@ -124,12 +122,12 @@ class TablesGenerator(CodeGenerator):
     def __init__(
         self,
         metadata: MetaData,
-        bind: Connection | Engine,
+        dialect: Dialect,
         options: Sequence[str],
         *,
         indentation: str = "    ",
     ):
-        super().__init__(metadata, bind, options)
+        super().__init__(metadata, dialect, options)
         self.indentation: str = indentation
         self.imports: dict[str, set[str]] = defaultdict(set)
         self.module_imports: set[str] = set()
@@ -562,7 +560,7 @@ def add_fk_options(*opts: Any) -> None:
             ]
             add_fk_options(local_columns, remote_columns)
         elif isinstance(constraint, CheckConstraint):
-            args.append(repr(get_compiled_expression(constraint.sqltext, self.bind)))
+            args.append(repr(get_compiled_expression(constraint.sqltext, self.dialect)))
         elif isinstance(constraint, (UniqueConstraint, PrimaryKeyConstraint)):
             args.extend(repr(col.name) for col in constraint.columns)
         else:
@@ -608,7 +606,7 @@ def fix_column_types(self, table: Table) -> None:
         # Detect check constraints for boolean and enum columns
         for constraint in table.constraints.copy():
             if isinstance(constraint, CheckConstraint):
-                sqltext = get_compiled_expression(constraint.sqltext, self.bind)
+                sqltext = get_compiled_expression(constraint.sqltext, self.dialect)
 
                 # Turn any integer-like column with a CheckConstraint like
                 # "column IN (0, 1)" into a Boolean
@@ -646,7 +644,7 @@ def fix_column_types(self, table: Table) -> None:
                 pass
 
             # PostgreSQL specific fix: detect sequences from server_default
-            if column.server_default and self.bind.dialect.name == "postgresql":
+            if column.server_default and self.dialect.name == "postgresql":
                 if isinstance(column.server_default, DefaultClause) and isinstance(
                     column.server_default.arg, TextClause
                 ):
@@ -661,7 +659,7 @@ def fix_column_types(self, table: Table) -> None:
                         column.server_default = None
 
     def get_adapted_type(self, coltype: Any) -> Any:
-        compiled_type = coltype.compile(self.bind.engine.dialect)
+        compiled_type = coltype.compile(self.dialect)
         for supercls in coltype.__class__.__mro__:
             if not supercls.__name__.startswith("_") and hasattr(
                 supercls, "__visit_name__"
@@ -687,7 +685,7 @@ def get_adapted_type(self, coltype: Any) -> Any:
                 try:
                     # If the adapted column type does not render the same as the
                     # original, don't substitute it
-                    if new_coltype.compile(self.bind.engine.dialect) != compiled_type:
+                    if new_coltype.compile(self.dialect) != compiled_type:
                         # Make an exception to the rule for Float and arrays of Float,
                         # since at least on PostgreSQL, Float can accurately represent
                         # both REAL and DOUBLE_PRECISION
@@ -718,13 +716,13 @@ class DeclarativeGenerator(TablesGenerator):
     def __init__(
         self,
         metadata: MetaData,
-        bind: Connection | Engine,
+        dialect: Dialect,
         options: Sequence[str],
         *,
         indentation: str = "    ",
         base_class_name: str = "Base",
     ):
-        super().__init__(metadata, bind, options, indentation=indentation)
+        super().__init__(metadata, dialect, options, indentation=indentation)
         self.base_class_name: str = base_class_name
         self.inflect_engine = inflect.engine()
 
@@ -1305,7 +1303,7 @@ class DataclassGenerator(DeclarativeGenerator):
     def __init__(
         self,
         metadata: MetaData,
-        bind: Connection | Engine,
+        dialect: Dialect,
         options: Sequence[str],
         *,
         indentation: str = "    ",
@@ -1315,7 +1313,7 @@ def __init__(
     ):
         super().__init__(
             metadata,
-            bind,
+            dialect,
             options,
             indentation=indentation,
             base_class_name=base_class_name,
@@ -1344,15 +1342,15 @@ class SQLModelGenerator(DeclarativeGenerator):
     def __init__(
         self,
         metadata: MetaData,
-        bind: Connection | Engine,
+        dialect: Dialect,
         options: Sequence[str],
         *,
         indentation: str = "    ",
         base_class_name: str = "SQLModel",
     ):
         super().__init__(
             metadata,
-            bind,
+            dialect,
             options,
             indentation=indentation,
             base_class_name=base_class_name,

src/sqlacodegen/utils.py

@@ -4,8 +4,7 @@
 from collections.abc import Mapping
 from typing import Any
 
-from sqlalchemy import PrimaryKeyConstraint, UniqueConstraint
-from sqlalchemy.engine import Connection, Engine
+from sqlalchemy import Dialect, PrimaryKeyConstraint, UniqueConstraint
 from sqlalchemy.sql import ClauseElement
 from sqlalchemy.sql.elements import TextClause
 from sqlalchemy.sql.schema import (
@@ -34,9 +33,11 @@ def get_constraint_sort_key(constraint: Constraint) -> str:
         return str(constraint)
 
 
-def get_compiled_expression(statement: ClauseElement, bind: Engine | Connection) -> str:
+def get_compiled_expression(statement: ClauseElement, dialect: Dialect) -> str:
     """Return the statement in a form where any placeholders have been filled in."""
-    return str(statement.compile(bind, compile_kwargs={"literal_binds": True}))
+    return str(
+        statement.compile(dialect=dialect, compile_kwargs={"literal_binds": True})
+    )
 
 
 def get_common_fk_constraints(

tests/conftest.py

@@ -2,20 +2,21 @@
 
 import pytest
 from pytest import FixtureRequest
-from sqlalchemy.engine import Engine, create_engine
+from sqlalchemy import Dialect
+from sqlalchemy.dialects import mysql, postgresql, sqlite
 from sqlalchemy.orm import clear_mappers, configure_mappers
 from sqlalchemy.schema import MetaData
 
 
 @pytest.fixture
-def engine(request: FixtureRequest) -> Engine:
-    dialect = getattr(request, "param", None)
-    if dialect == "postgresql":
-        return create_engine("postgresql:///testdb")
-    elif dialect == "mysql":
-        return create_engine("mysql+mysqlconnector://testdb")
+def dialect(request: FixtureRequest) -> Dialect:
+    dialect_name = getattr(request, "param", None)
+    if dialect_name == "postgresql":
+        return postgresql.dialect()
+    elif dialect_name == "mysql":
+        return mysql.mysqlconnector.dialect()
     else:
-        return create_engine("sqlite:///:memory:")
+        return sqlite.dialect()
 
 
 @pytest.fixture

tests/test_generator_dataclass.py

@@ -2,8 +2,8 @@
 
 import pytest
 from _pytest.fixtures import FixtureRequest
+from sqlalchemy import Dialect
 from sqlalchemy.dialects.postgresql import UUID
-from sqlalchemy.engine import Engine
 from sqlalchemy.schema import Column, ForeignKeyConstraint, MetaData, Table
 from sqlalchemy.sql.expression import text
 from sqlalchemy.types import INTEGER, VARCHAR
@@ -15,10 +15,10 @@
 
 @pytest.fixture
 def generator(
-    request: FixtureRequest, metadata: MetaData, engine: Engine
+    request: FixtureRequest, metadata: MetaData, dialect: Dialect
 ) -> CodeGenerator:
     options = getattr(request, "param", [])
-    return DataclassGenerator(metadata, engine, options)
+    return DataclassGenerator(metadata, dialect, options)
 
 
 def test_basic_class(generator: CodeGenerator) -> None:

tests/test_generator_declarative.py

@@ -2,8 +2,7 @@
 
 import pytest
 from _pytest.fixtures import FixtureRequest
-from sqlalchemy import PrimaryKeyConstraint
-from sqlalchemy.engine import Engine
+from sqlalchemy import Dialect, PrimaryKeyConstraint
 from sqlalchemy.schema import (
     CheckConstraint,
     Column,
@@ -24,10 +23,10 @@
 
 @pytest.fixture
 def generator(
-    request: FixtureRequest, metadata: MetaData, engine: Engine
+    request: FixtureRequest, metadata: MetaData, dialect: Dialect
 ) -> CodeGenerator:
     options = getattr(request, "param", [])
-    return DeclarativeGenerator(metadata, engine, options)
+    return DeclarativeGenerator(metadata, dialect, options)
 
 
 def test_indexes(generator: CodeGenerator) -> None:

tests/test_generator_sqlmodel.py

@@ -2,7 +2,7 @@
 
 import pytest
 from _pytest.fixtures import FixtureRequest
-from sqlalchemy.engine import Engine
+from sqlalchemy import Dialect
 from sqlalchemy.schema import (
     CheckConstraint,
     Column,
@@ -21,10 +21,10 @@
 
 @pytest.fixture
 def generator(
-    request: FixtureRequest, metadata: MetaData, engine: Engine
+    request: FixtureRequest, metadata: MetaData, dialect: Dialect
 ) -> CodeGenerator:
     options = getattr(request, "param", [])
-    return SQLModelGenerator(metadata, engine, options)
+    return SQLModelGenerator(metadata, dialect, options)
 
 
 def test_indexes(generator: CodeGenerator) -> None: