sqlacodegen 4.0.1__tar.gz → 4.0.2__tar.gz

{sqlacodegen-4.0.1 → sqlacodegen-4.0.2}/CHANGES.rst

@@ -1,6 +1,16 @@
 Version history
 ===============
 
+**4.0.2**
+
+- Fixed rendering of inherited keyword arguments for dialect-specific types that use
+  ``**kwargs`` in their initializers (such as MySQL ``CHAR`` with ``collation``) while
+  preserving existing ``*args`` rendering behavior (PR by @hyoj0942)
+- Fixed missing metadata argument when rendering plain tables with the SQLModel
+- Added support for self-referential tables in the SQLModel generator (PR by @sheinbergon)
+- Fixed empty dialect kwargs (e.g. ``postgresql_include=[]``) being included in
+  rendered indexes, tables, and columns (PR by @sheinbergon)
+
 **4.0.1**
 
 - Fix enum column definitions to explicitly include schema and name if reflected

{sqlacodegen-4.0.1 → sqlacodegen-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlacodegen
-Version: 4.0.1
+Version: 4.0.2
 Summary: Automatic model code generator for SQLAlchemy
 Author-email: Alex Grönholm <alex.gronholm@nextday.fi>
 Maintainer-email: Idan Sheinberg <ishinberg0@gmail.com>

{sqlacodegen-4.0.1 → sqlacodegen-4.0.2}/src/sqlacodegen/generators.py

@@ -427,6 +427,7 @@ class TablesGenerator(CodeGenerator):
         kwargs = {
             key: repr(value) if isinstance(value, str) else value
             for key, value in sorted(index.kwargs.items(), key=lambda item: item[0])
+            if value not in ([], {})
         }
         if index.unique:
             kwargs["unique"] = True
@@ -541,6 +542,77 @@ class TablesGenerator(CodeGenerator):
         else:
             return render_callable("mapped_column", *args, kwargs=kwargs)
 
+    def _render_column_type_value(self, value: Any) -> str:
+        if isinstance(value, (JSONB, JSON)):
+            # Remove astext_type if it's the default
+            if isinstance(value.astext_type, Text) and value.astext_type.length is None:
+                value.astext_type = None  # type: ignore[assignment]
+            else:
+                self.add_import(Text)
+
+        if isinstance(value, TextClause):
+            self.add_literal_import("sqlalchemy", "text")
+            return render_callable("text", repr(value.text))
+
+        return repr(value)
+
+    def _collect_inherited_init_kwargs(
+        self,
+        column_type: Any,
+        init_sig: inspect.Signature,
+        seen_param_names: set[str],
+        missing: object,
+    ) -> dict[str, str]:
+        has_var_keyword = any(
+            param.kind is Parameter.VAR_KEYWORD
+            for param in init_sig.parameters.values()
+        )
+        has_var_positional = any(
+            param.kind is Parameter.VAR_POSITIONAL
+            for param in init_sig.parameters.values()
+        )
+        if not has_var_keyword or has_var_positional:
+            return {}
+
+        inherited_kwargs: dict[str, str] = {}
+        for supercls in column_type.__class__.__mro__[1:]:
+            if supercls is object:
+                break
+
+            try:
+                super_sig = inspect.signature(supercls.__init__)
+            except (TypeError, ValueError):
+                continue
+
+            for super_param in list(super_sig.parameters.values())[1:]:
+                if super_param.name.startswith("_"):
+                    continue
+
+                if super_param.kind in (
+                    Parameter.POSITIONAL_ONLY,
+                    Parameter.VAR_POSITIONAL,
+                    Parameter.VAR_KEYWORD,
+                ):
+                    continue
+
+                if super_param.name in seen_param_names:
+                    continue
+
+                seen_param_names.add(super_param.name)
+                value = getattr(column_type, super_param.name, missing)
+                if value is missing:
+                    continue
+
+                default = super_param.default
+                if default is not Parameter.empty and value == default:
+                    continue
+
+                inherited_kwargs[super_param.name] = self._render_column_type_value(
+                    value
+                )
+
+        return inherited_kwargs
+
     def render_column_type(self, column: Column[Any]) -> str:
         column_type = column.type
         # Check if this is an enum column with a Python enum class
@@ -586,6 +658,8 @@ class TablesGenerator(CodeGenerator):
         defaults = {param.name: param.default for param in sig.parameters.values()}
         missing = object()
         use_kwargs = False
+        seen_param_names: set[str] = set()
+
         for param in list(sig.parameters.values())[1:]:
             # Remove annoyances like _warn_on_bytestring
             if param.name.startswith("_"):
@@ -594,32 +668,25 @@ class TablesGenerator(CodeGenerator):
                 use_kwargs = True
                 continue
 
+            seen_param_names.add(param.name)
             value = getattr(column_type, param.name, missing)
-
-            if isinstance(value, (JSONB, JSON)):
-                # Remove astext_type if it's the default
-                if (
-                    isinstance(value.astext_type, Text)
-                    and value.astext_type.length is None
-                ):
-                    value.astext_type = None  # type: ignore[assignment]
-                else:
-                    self.add_import(Text)
-
             default = defaults.get(param.name, missing)
-            if isinstance(value, TextClause):
-                self.add_literal_import("sqlalchemy", "text")
-                rendered_value = render_callable("text", repr(value.text))
-            else:
-                rendered_value = repr(value)
-
             if value is missing or value == default:
                 use_kwargs = True
-            elif use_kwargs:
+                continue
+
+            rendered_value = self._render_column_type_value(value)
+            if use_kwargs:
                 kwargs[param.name] = rendered_value
             else:
                 args.append(rendered_value)
 
+        kwargs.update(
+            self._collect_inherited_init_kwargs(
+                column_type, sig, seen_param_names, missing
+            )
+        )
+
         vararg = next(
             (
                 param.name
@@ -712,6 +779,9 @@ class TablesGenerator(CodeGenerator):
             except Exception:
                 continue
 
+            if isinstance(value, list | dict) and not value:
+                continue
+
             # Render values:
             # - callable context (values_for_dict=False): produce a string expression.
             #   primitives use repr(value); custom objects stringify then repr().
@@ -1671,13 +1741,16 @@ class DeclarativeGenerator(TablesGenerator):
     ) -> Mapping[str, Any]:
         def render_column_attrs(column_attrs: list[ColumnAttribute]) -> str:
             rendered = []
+            render_as_string = False
             for attr in column_attrs:
-                if attr.model is relationship.source:
+                if not self.explicit_foreign_keys and attr.model is relationship.source:
                     rendered.append(attr.name)
                 else:
-                    rendered.append(repr(f"{attr.model.name}.{attr.name}"))
+                    rendered.append(f"{attr.model.name}.{attr.name}")
+                    render_as_string = True
 
-            return "[" + ", ".join(rendered) + "]"
+            joined = "[" + ", ".join(rendered) + "]"
+            return repr(joined) if render_as_string else joined
 
         def render_foreign_keys(column_attrs: list[ColumnAttribute]) -> str:
             rendered = []
@@ -1806,19 +1879,27 @@ class SQLModelGenerator(DeclarativeGenerator):
         self.add_import(Column)
         return render_callable("Column", *args, kwargs=kwargs)
 
+    def render_table(self, table: Table) -> str:
+        # Hack to fix #465 without breaking backwards compatibility
+        self.base.metadata_ref = "SQLModel.metadata"
+
+        return super().render_table(table)
+
     def generate_base(self) -> None:
         self.base = Base(
             literal_imports=[],
             declarations=[],
-            metadata_ref="",
+            metadata_ref="SQLModel.metadata",
         )
 
     def collect_imports(self, models: Iterable[Model]) -> None:
         super(DeclarativeGenerator, self).collect_imports(models)
         if any(isinstance(model, ModelClass) for model in models):
+            self.add_literal_import("sqlmodel", "Field")
+
+        if models:
             self.remove_literal_import("sqlalchemy", "MetaData")
             self.add_literal_import("sqlmodel", "SQLModel")
-            self.add_literal_import("sqlmodel", "Field")
 
     def collect_imports_for_model(self, model: Model) -> None:
         super(DeclarativeGenerator, self).collect_imports_for_model(model)

{sqlacodegen-4.0.1 → sqlacodegen-4.0.2}/src/sqlacodegen.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlacodegen
-Version: 4.0.1
+Version: 4.0.2
 Summary: Automatic model code generator for SQLAlchemy
 Author-email: Alex Grönholm <alex.gronholm@nextday.fi>
 Maintainer-email: Idan Sheinberg <ishinberg0@gmail.com>

{sqlacodegen-4.0.1 → sqlacodegen-4.0.2}/tests/test_generator_declarative.py

@@ -321,6 +321,40 @@ class Num2(Base):
     )
 
 
+@pytest.mark.parametrize("engine", ["mysql"], indirect=["engine"])
+@pytest.mark.parametrize("generator", [["keep_dialect_types"]], indirect=True)
+def test_keep_dialect_types_keeps_mysql_char_collation(
+    generator: CodeGenerator,
+) -> None:
+    from sqlalchemy.dialects.mysql import CHAR as MYSQL_CHAR
+    from sqlalchemy.dialects.mysql import INTEGER as MYSQL_INTEGER
+
+    Table(
+        "result_logs",
+        generator.metadata,
+        Column("id", MYSQL_INTEGER, primary_key=True),
+        Column("result_code", MYSQL_CHAR(1, collation="utf8mb3_bin"), nullable=False),
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+from sqlalchemy.dialects.mysql import CHAR, INTEGER
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
+
+class Base(DeclarativeBase):
+    pass
+
+
+class ResultLogs(Base):
+    __tablename__ = 'result_logs'
+
+    id: Mapped[int] = mapped_column(INTEGER, primary_key=True)
+    result_code: Mapped[str] = mapped_column(CHAR(1, collation='utf8mb3_bin'), nullable=False)
+        """,
+    )
+
+
 def test_onetomany(generator: CodeGenerator) -> None:
     Table(
         "simple_items",
@@ -3127,3 +3161,75 @@ def test_array_enum_named_with_schema(generator: CodeGenerator) -> None:
             tags: Mapped[list[TagEnum]] = mapped_column(ARRAY(Enum(TagEnum, values_callable=lambda cls: [member.value for member in cls], name='tag_enum', schema='custom_schema')), nullable=False)
         """,
     )
+
+
+def test_index_with_empty_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",
+            postgresql_include=[],
+        )
+    )
+
+    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', postgresql_using='gist'),
+    )
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    name: Mapped[Optional[str]] = mapped_column(String)
+        """,
+    )
+
+
+@pytest.mark.parametrize("generator", [["include_dialect_options"]], indirect=True)
+def test_include_dialect_options_empty_values_skipped(
+    generator: CodeGenerator,
+) -> None:
+    Table(
+        "t_opts3",
+        generator.metadata,
+        Column("id", INTEGER, primary_key=True),
+        mysql_engine="InnoDB",
+        mysql_partition_by=[],
+        mysql_PROPERTIES={},
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+from sqlalchemy import Integer
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
+
+class Base(DeclarativeBase):
+    pass
+
+
+class TOpts3(Base):
+    __tablename__ = 't_opts3'
+    __table_args__ = {'mysql_engine': 'InnoDB'}
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+        """,
+    )

{sqlacodegen-4.0.1 → sqlacodegen-4.0.2}/tests/test_generator_sqlmodel.py

@@ -366,3 +366,106 @@ def test_array_enum_named_with_schema(generator: CodeGenerator) -> None:
                 tags: list[TagEnum] = Field(sa_column=Column('tags', ARRAY(Enum(TagEnum, values_callable=lambda cls: [member.value for member in cls], name='tag_enum', schema='custom_schema')), nullable=False))
         """,
     )
+
+
+def test_fallback_table(generator: CodeGenerator) -> None:
+    Table(
+        "simple_fallback",
+        generator.metadata,
+        Column("field", VARCHAR(20), nullable=False),
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+            from sqlalchemy import Column, String, Table
+            from sqlmodel import SQLModel
+
+            t_simple_fallback = Table(
+                'simple_fallback', SQLModel.metadata,
+                Column('field', String(20), nullable=False)
+            )
+        """,
+    )
+
+
+def test_onetomany_selfref(generator: CodeGenerator) -> None:
+    Table(
+        "simple_items",
+        generator.metadata,
+        Column("id", INTEGER, primary_key=True),
+        Column("parent_item_id", INTEGER),
+        ForeignKeyConstraint(["parent_item_id"], ["simple_items.id"]),
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+            from typing import Optional
+
+            from sqlalchemy import Column, ForeignKey, Integer
+            from sqlmodel import Field, Relationship, SQLModel
+
+            class SimpleItems(SQLModel, table=True):
+                __tablename__ = 'simple_items'
+
+                id: int = Field(sa_column=Column('id', Integer, primary_key=True))
+                parent_item_id: Optional[int] = Field(default=None, sa_column=Column(\
+'parent_item_id', ForeignKey('simple_items.id')))
+
+                parent_item: Optional['SimpleItems'] = Relationship(\
+back_populates='parent_item_reverse', sa_relationship_kwargs={\
+'remote_side': '[SimpleItems.id]'})
+                parent_item_reverse: list['SimpleItems'] = Relationship(\
+back_populates='parent_item', sa_relationship_kwargs={\
+'remote_side': '[SimpleItems.parent_item_id]'})
+        """,
+    )
+
+
+def test_onetomany_selfref_multi(generator: CodeGenerator) -> None:
+    Table(
+        "simple_items_selfref",
+        generator.metadata,
+        Column("id", INTEGER, primary_key=True),
+        Column("parent_item_id", INTEGER),
+        Column("top_item_id", INTEGER),
+        ForeignKeyConstraint(["parent_item_id"], ["simple_items_selfref.id"]),
+        ForeignKeyConstraint(["top_item_id"], ["simple_items_selfref.id"]),
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+            from typing import Optional
+
+            from sqlalchemy import Column, ForeignKey, Integer
+            from sqlmodel import Field, Relationship, SQLModel
+
+            class SimpleItemsSelfref(SQLModel, table=True):
+                __tablename__ = 'simple_items_selfref'
+
+                id: int = Field(sa_column=Column('id', Integer, primary_key=True))
+                parent_item_id: Optional[int] = Field(default=None, sa_column=Column(\
+'parent_item_id', ForeignKey('simple_items_selfref.id')))
+                top_item_id: Optional[int] = Field(default=None, sa_column=Column(\
+'top_item_id', ForeignKey('simple_items_selfref.id')))
+
+                parent_item: Optional['SimpleItemsSelfref'] = Relationship(\
+back_populates='parent_item_reverse', sa_relationship_kwargs={\
+'remote_side': '[SimpleItemsSelfref.id]', \
+'foreign_keys': '[SimpleItemsSelfref.parent_item_id]'})
+                parent_item_reverse: list['SimpleItemsSelfref'] = Relationship(\
+back_populates='parent_item', sa_relationship_kwargs={\
+'remote_side': '[SimpleItemsSelfref.parent_item_id]', \
+'foreign_keys': '[SimpleItemsSelfref.parent_item_id]'})
+                top_item: Optional['SimpleItemsSelfref'] = Relationship(\
+back_populates='top_item_reverse', sa_relationship_kwargs={\
+'remote_side': '[SimpleItemsSelfref.id]', \
+'foreign_keys': '[SimpleItemsSelfref.top_item_id]'})
+                top_item_reverse: list['SimpleItemsSelfref'] = Relationship(\
+back_populates='top_item', sa_relationship_kwargs={\
+'remote_side': '[SimpleItemsSelfref.top_item_id]', \
+'foreign_keys': '[SimpleItemsSelfref.top_item_id]'})
+        """,
+    )

{sqlacodegen-4.0.1 → sqlacodegen-4.0.2}/tests/test_generator_tables.py

@@ -603,6 +603,34 @@ def test_mysql_column_types(generator: CodeGenerator) -> None:
     )
 
 
+@pytest.mark.parametrize("engine", ["mysql"], indirect=["engine"])
+@pytest.mark.parametrize("generator", [["keep_dialect_types"]], indirect=True)
+def test_mysql_char_collation_keep_dialect_types(generator: CodeGenerator) -> None:
+    Table(
+        "simple_items",
+        generator.metadata,
+        Column("id", mysql.INTEGER, primary_key=True),
+        Column("result_code", mysql.CHAR(1, collation="utf8mb3_bin"), nullable=False),
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+        from sqlalchemy import Column, MetaData, Table
+        from sqlalchemy.dialects.mysql import CHAR, INTEGER
+
+        metadata = MetaData()
+
+
+        t_simple_items = Table(
+            'simple_items', metadata,
+            Column('id', INTEGER, primary_key=True),
+            Column('result_code', CHAR(1, collation='utf8mb3_bin'), nullable=False)
+        )
+        """,
+    )
+
+
 def test_constraints(generator: CodeGenerator) -> None:
     Table(
         "simple_items",