Support external python-types (#428)

* Support external python-types

* Update CHANGES.rst

* Fix dependencies

* Workflow fixes

* Test fixes

* Exclude python 3.9 tests from geoalchemy2 tests and bump minimal version

* Version fix

* Update CHANGES.rst

Co-authored-by: Alex Grönholm <alex.gronholm@nextday.fi>

* PR Fixes

* PR Fixes

---------

Co-authored-by: Alex Grönholm <alex.gronholm@nextday.fi>

Author: sheinbergon

CHANGES.rst

@@ -1,6 +1,12 @@
 Version history
 ===============
 
+**3.1.1**
+
+- Fallback ``NotImplemented`` errors encountered when accessing ``python_type`` for
+  non-native types to ``typing.Any``
+  (PR by @sheinbergon, based on work by @danplischke)
+
 **3.1.0**
 
 - Type annotations for ARRAY column attributes now include the Python type of

pyproject.toml

@@ -42,15 +42,15 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 test = [
-    "sqlacodegen[sqlmodel,pgvector]",
+    "sqlacodegen[sqlmodel,pgvector,geoalchemy2]",
     "pytest >= 7.4",
     "coverage >= 7",
     "psycopg[binary]",
     "mysql-connector-python",
 ]
 sqlmodel = ["sqlmodel >= 0.0.22"]
 citext = ["sqlalchemy-citext >= 1.7.0"]
-geoalchemy2 = ["geoalchemy2 >= 0.11.1"]
+geoalchemy2 = ["geoalchemy2 >= 0.17.0"]
 pgvector = ["pgvector >= 0.2.4"]
 
 [project.entry-points."sqlacodegen.generators"]

src/sqlacodegen/generators.py

@@ -1241,22 +1241,22 @@ def get_type_qualifiers() -> tuple[str, TypeEngine[Any], str]:
 
         def render_python_type(column_type: TypeEngine[Any]) -> str:
             if isinstance(column_type, DOMAIN):
-                python_type = column_type.data_type.python_type
-            else:
-                python_type = column_type.python_type
-
-            python_type_name = python_type.__name__
-            python_type_module = python_type.__module__
-            if python_type_module == "builtins":
-                return python_type_name
+                column_type = column_type.data_type
 
             try:
-                self.add_module_import(python_type_module)
-                return f"{python_type_module}.{python_type_name}"
+                python_type = column_type.python_type
+                python_type_module = python_type.__module__
+                python_type_name = python_type.__name__
             except NotImplementedError:
                 self.add_literal_import("typing", "Any")
                 return "Any"
 
+            if python_type_module == "builtins":
+                return python_type_name
+
+            self.add_module_import(python_type_module)
+            return f"{python_type_module}.{python_type_name}"
+
         pre, col_type, post = get_type_qualifiers()
         column_python_type = f"{pre}{render_python_type(col_type)}{post}"
         return column_python_type

tests/test_generator_declarative.py

@@ -1,7 +1,10 @@
 from __future__ import annotations
 
+import sys
+
 import pytest
 from _pytest.fixtures import FixtureRequest
+from geoalchemy2 import Geography, Geometry
 from sqlalchemy import BIGINT, PrimaryKeyConstraint
 from sqlalchemy.dialects import postgresql
 from sqlalchemy.dialects.postgresql import JSON, JSONB
@@ -1706,3 +1709,44 @@ class TestDomainJson(Base):
     foo: Mapped[Optional[dict]] = mapped_column(DOMAIN('domain_json', {domain_type.__name__}(astext_type=Text(length=128)), not_null=False))
 """,
     )
+
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 10),
+    reason="This test assumes GeoAlchemy2 0.18.x and above, which does not support python 3.9",
+)
+@pytest.mark.parametrize("engine", ["postgresql"], indirect=["engine"])
+def test_geoalchemy2_types(generator: CodeGenerator) -> None:
+    Table(
+        "spatial_table",
+        generator.metadata,
+        Column("id", INTEGER, primary_key=True),
+        Column("geom", Geometry("POINT", srid=4326, dimension=2), nullable=False),
+        Column("geog", Geography("POLYGON", dimension=2)),
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+from typing import Any, Optional
+
+from geoalchemy2.types import Geography, Geometry
+from sqlalchemy import Index, Integer
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
+
+class Base(DeclarativeBase):
+    pass
+
+
+class SpatialTable(Base):
+    __tablename__ = 'spatial_table'
+    __table_args__ = (
+        Index('idx_spatial_table_geog', 'geog'),
+        Index('idx_spatial_table_geom', 'geom')
+    )
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    geom: Mapped[Any] = mapped_column(Geometry('POINT', 4326, 2, from_text='ST_GeomFromEWKT', name='geometry', nullable=False), nullable=False)
+    geog: Mapped[Optional[Any]] = mapped_column(Geography('POLYGON', dimension=2, from_text='ST_GeogFromText', name='geography'))
+""",
+    )