WIP: Fix ignoring kwargs and ensure deterministic output (#439) (#440)

* Fix ignoring kwargs and ensure deterministic output (#439)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update src/sqlacodegen/generators.py

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

---------

Co-authored-by: Idan Sheinberg <ishinberg0@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Alex Grönholm <alex.gronholm@nextday.fi>

Author: 4 people

CHANGES.rst

@@ -7,7 +7,9 @@ Version history
   connect to the same target table. Regenerating models will break existing code.
 - Improved relationship naming: one-to-many uses FK column names (e.g.,
   ``simple_items_parent_container``), many-to-many uses junction table names (e.g.,
-  ``students_enrollments``). Use ``--options nofknames`` to revert to old behavior.
+  ``students_enrollments``). Use ``--options nofknames`` to revert to old behavior. (PR by @sheinbergon)
+- Fixed ``Index`` kwargs (e.g. ``mysql_length``) being ignored during code generation
+  (PR by @luliangce)
 
 **4.0.0rc2**
 

src/sqlacodegen/generators.py

@@ -424,7 +424,10 @@ def render_table(self, table: Table) -> str:
 
     def render_index(self, index: Index) -> str:
         extra_args = [repr(col.name) for col in index.columns]
-        kwargs = {}
+        kwargs = {
+            key: repr(value) if isinstance(value, str) else value
+            for key, value in sorted(index.kwargs.items(), key=lambda item: item[0])
+        }
         if index.unique:
             kwargs["unique"] = True
 

tests/test_generator_declarative.py

@@ -77,6 +77,41 @@ class SimpleItems(Base):
     )
 
 
+def test_index_with_kwargs(generator: CodeGenerator) -> None:
+    simple_items = Table(
+        "simple_items",
+        generator.metadata,
+        Column("id", INTEGER, primary_key=True),
+        Column("name", VARCHAR),
+    )
+    simple_items.indexes.add(
+        Index("idx_name", simple_items.c.name, postgresql_using="gist", mysql_length=10)
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+from typing import Optional
+
+from sqlalchemy import Index, Integer, String
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
+
+class Base(DeclarativeBase):
+    pass
+
+
+class SimpleItems(Base):
+    __tablename__ = 'simple_items'
+    __table_args__ = (
+        Index('idx_name', 'name', mysql_length=10, postgresql_using='gist'),
+    )
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    name: Mapped[Optional[str]] = mapped_column(String)
+        """,
+    )
+
+
 def test_constraints(generator: CodeGenerator) -> None:
     Table(
         "simple_items",
@@ -2382,8 +2417,8 @@ class Base(DeclarativeBase):
 class SpatialTable(Base):
     __tablename__ = 'spatial_table'
     __table_args__ = (
-        Index('idx_spatial_table_geog', 'geog'),
-        Index('idx_spatial_table_geom', 'geom')
+        Index('idx_spatial_table_geog', 'geog', postgresql_using='gist'),
+        Index('idx_spatial_table_geom', 'geom', postgresql_using='gist')
     )
 
     id: Mapped[int] = mapped_column(Integer, primary_key=True)