sqlacodegen 3.2.0__tar.gz → 4.0.0__tar.gz

sqlacodegen-4.0.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+tidelift: pypi/sqlacodegen

sqlacodegen-4.0.0/.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Keep GitHub Actions up to date with GitHub's Dependabot...
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    groups:
+      github-actions:
+        patterns:
+          - "*"  # Group all Actions updates into a single larger pull request
+    schedule:
+      interval: quarterly

{sqlacodegen-3.2.0 → sqlacodegen-4.0.0}/.github/workflows/publish.yml

@@ -14,9 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     environment: release
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: 3.x
     - name: Install dependencies
@@ -24,7 +24,7 @@ jobs:
     - name: Create packages
       run: python -m build
     - name: Archive packages
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v6
       with:
         name: dist
         path: dist
@@ -38,7 +38,10 @@ jobs:
       id-token: write
     steps:
     - name: Retrieve packages
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v7
+      with:
+        name: dist
+        path: dist
     - name: Upload packages
       uses: pypa/gh-action-pypi-publish@release/v1
 
@@ -49,7 +52,7 @@ jobs:
     permissions:
       contents: write
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - id: changelog
       uses: agronholm/release-notes@v1
       with:

{sqlacodegen-3.2.0 → sqlacodegen-4.0.0}/.github/workflows/test.yml

@@ -13,16 +13,16 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
         allow-prereleases: true
         cache: pip
         cache-dependency-path: pyproject.toml
     - name: Install dependencies
-      run: pip install -e .[test]
+      run: pip install --group test -e .[sqlmodel,citext,geoalchemy2,pgvector]
     - name: Test with pytest
       run: coverage run -m pytest
     - name: Upload Coverage

{sqlacodegen-3.2.0 → sqlacodegen-4.0.0}/.pre-commit-config.yaml

@@ -16,14 +16,14 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.13.3
+    rev: v0.14.10
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.18.2
+    rev: v1.19.1
     hooks:
       - id: mypy
         additional_dependencies:

{sqlacodegen-3.2.0 → sqlacodegen-4.0.0}/CHANGES.rst

@@ -1,6 +1,55 @@
 Version history
 ===============
 
+**4.0.0**
+
+- **BACKWARD INCOMPATIBLE** API changes (for those who customize code generation by
+  subclassing the existing generators):
+
+  * Added new optional keyword argument, ``explicit_foreign_keys`` to
+    ``DeclarativeGenerator``, to force foreign keys to be rendered as
+    ``ClassName.attribute_name`` string references
+  * Removed the ``render_relationship_args()`` method from the SQLModel generator
+  * Added two new methods for customizing relationship rendering in
+    ``DeclarativeGenerator``:
+
+    * ``render_relationship_annotation()``: returns the appropriate type annotation
+      (without the ``Mapped`` wrapper) for the relationship
+    * ``render_relationship_arguments()``: returns a dictionary of keyword arguments to
+      ``sqlalchemy.orm.relationship()``
+
+**4.0.0rc3**
+
+- **BACKWARD INCOMPATIBLE** Relationship names changed when multiple FKs or junction tables
+  connect to the same target table. Regenerating models will break existing code.
+- Added support for generating Python enum classes for ``ARRAY(Enum(...))`` columns
+  (e.g., PostgreSQL ``ARRAY(ENUM)``). Supports named/unnamed enums, shared enums across
+  columns, and multi-dimensional arrays. Respects ``--options nonativeenums``.
+  (PR by @sheinbergon)
+- 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. (PR by @sheinbergon)
+- Fixed ``Index`` kwargs (e.g. ``mysql_length``) being ignored during code generation
+  (PR by @luliangce)
+- Fixed the SQLModel generator not adding the ``foreign_keys`` parameters when
+  generating multiple relationships between the same two tables
+
+**4.0.0rc2**
+
+- Add ``values_callable`` lambda to generated native enums column definitions.
+  This allows for proper enum value insertion when working with ORM models (PR by @sheinbergon)
+
+**4.0.0rc1**
+
+- **BACKWARD INCOMPATIBLE** ``TablesGenerator.render_column_type()`` was changed to
+  receive the ``Column`` object instead of the column type object as its sole argument
+- Added Python enum generation for native database ENUM types (e.g., PostgreSQL / MySQL ENUM).
+  Retained synthetic Python enum generation from CHECK constraints with
+  IN clauses (e.g., ``column IN ('val1', 'val2', ...)``). Use ``--options nonativeenums`` to
+  disable enum generation for native database enums. Use ``--options nosyntheticenums`` to
+  disable enum generation for synthetic database enums (VARCHAR columns with check constraints).
+  (PR by @sheinbergon)
+
 **3.2.0**
 
 - Dropped support for Python 3.9

{sqlacodegen-3.2.0 → sqlacodegen-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlacodegen
-Version: 3.2.0
+Version: 4.0.0
 Summary: Automatic model code generator for SQLAlchemy
 Author-email: Alex Grönholm <alex.gronholm@nextday.fi>
 Maintainer-email: Idan Sheinberg <ishinberg0@gmail.com>
@@ -25,12 +25,6 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: SQLAlchemy>=2.0.29
 Requires-Dist: inflect>=4.0.0
-Provides-Extra: test
-Requires-Dist: sqlacodegen[geoalchemy2,pgvector,sqlmodel]; extra == "test"
-Requires-Dist: pytest>=7.4; extra == "test"
-Requires-Dist: coverage>=7; extra == "test"
-Requires-Dist: psycopg[binary]; extra == "test"
-Requires-Dist: mysql-connector-python; extra == "test"
 Provides-Extra: sqlmodel
 Requires-Dist: sqlmodel>=0.0.22; extra == "sqlmodel"
 Provides-Extra: citext
@@ -47,6 +41,9 @@ Dynamic: license-file
 .. image:: https://coveralls.io/repos/github/agronholm/sqlacodegen/badge.svg?branch=master
   :target: https://coveralls.io/github/agronholm/sqlacodegen?branch=master
   :alt: Code Coverage
+.. image:: https://tidelift.com/badges/package/pypi/sqlacodegen
+  :target: https://tidelift.com/subscription/pkg/pypi-sqlacodegen
+  :alt: Tidelift
 
 This is a tool that reads the structure of an existing database and generates the
 appropriate SQLAlchemy model code, using the declarative style if possible.
@@ -146,6 +143,8 @@ values must be delimited by commas, e.g. ``--options noconstraints,nobidi``):
   * ``noconstraints``: ignore constraints (foreign key, unique etc.)
   * ``nocomments``: ignore table/column comments
   * ``noindexes``: ignore indexes
+  * ``nonativeenums``: don't generate Python enum classes for native database ENUM types (e.g., PostgreSQL ENUM); use plain string mapping instead
+  * ``nosyntheticenums``: don't generate Python enum classes from CHECK constraints with IN clauses (e.g., ``column IN ('value1', 'value2', ...)``); preserves CHECK constraints as-is
   * ``noidsuffix``: prevent the special naming logic for single column many-to-one
     and one-to-one relationships (see `Relationship naming logic`_ for details)
   * ``include_dialect_options``: render a table' dialect options, such as ``starrocks_partition`` for StarRocks' specific options.
@@ -160,6 +159,11 @@ values must be delimited by commas, e.g. ``--options noconstraints,nobidi``):
   * ``nobidi``: generate relationships in a unidirectional fashion, so only the
     many-to-one or first side of many-to-many relationships gets a relationship
     attribute, as on v2.X
+  * ``nofknames``: disable improved relationship naming when multiple FKs or
+    junction tables connect to the same target. By default, uses FK column names
+    for one-to-many (e.g., ``simple_items_parent_container``) and junction table
+    names for many-to-many (e.g., ``students_enrollments``). Reverts to
+    underscore suffixes (``simple_items_``, ``student_``).
 
 * ``dataclasses``
 
@@ -227,6 +231,14 @@ due to that ``_id`` suffix.
 For self referential relationships, the reverse side of the relationship will be named
 with the ``_reverse`` suffix appended to it.
 
+When multiple foreign keys or junction tables connect to the same target table,
+relationships use qualifiers for disambiguation. One-to-many relationships use FK
+column names (e.g., ``simple_items_parent_container``, ``simple_items_top_container``).
+Many-to-many relationships use junction table names (e.g., ``students_enrollments``,
+``students_waitlist``), except for self-referential cases which use FK column names
+(e.g., ``parent``, ``child``). The ``nofknames`` option reverts to underscore suffixes
+(``simple_items_``, ``student_``).
+
 Customizing code generation logic
 =================================
 
@@ -251,3 +263,11 @@ sqlalchemy_ room on Gitter.
 
 .. _sqlacodegen discussion forum: https://github.com/agronholm/sqlacodegen/discussions/categories/q-a
 .. _sqlalchemy: https://app.gitter.im/#/room/#sqlalchemy_community:gitter.im
+
+Security contact information
+============================
+
+To report a security vulnerability, please use the `Tidelift security contact`_.
+Tidelift will coordinate the fix and disclosure.
+
+.. _Tidelift security contact: https://tidelift.com/security

{sqlacodegen-3.2.0 → sqlacodegen-4.0.0}/README.rst

@@ -4,6 +4,9 @@
 .. image:: https://coveralls.io/repos/github/agronholm/sqlacodegen/badge.svg?branch=master
   :target: https://coveralls.io/github/agronholm/sqlacodegen?branch=master
   :alt: Code Coverage
+.. image:: https://tidelift.com/badges/package/pypi/sqlacodegen
+  :target: https://tidelift.com/subscription/pkg/pypi-sqlacodegen
+  :alt: Tidelift
 
 This is a tool that reads the structure of an existing database and generates the
 appropriate SQLAlchemy model code, using the declarative style if possible.
@@ -103,6 +106,8 @@ values must be delimited by commas, e.g. ``--options noconstraints,nobidi``):
   * ``noconstraints``: ignore constraints (foreign key, unique etc.)
   * ``nocomments``: ignore table/column comments
   * ``noindexes``: ignore indexes
+  * ``nonativeenums``: don't generate Python enum classes for native database ENUM types (e.g., PostgreSQL ENUM); use plain string mapping instead
+  * ``nosyntheticenums``: don't generate Python enum classes from CHECK constraints with IN clauses (e.g., ``column IN ('value1', 'value2', ...)``); preserves CHECK constraints as-is
   * ``noidsuffix``: prevent the special naming logic for single column many-to-one
     and one-to-one relationships (see `Relationship naming logic`_ for details)
   * ``include_dialect_options``: render a table' dialect options, such as ``starrocks_partition`` for StarRocks' specific options.
@@ -117,6 +122,11 @@ values must be delimited by commas, e.g. ``--options noconstraints,nobidi``):
   * ``nobidi``: generate relationships in a unidirectional fashion, so only the
     many-to-one or first side of many-to-many relationships gets a relationship
     attribute, as on v2.X
+  * ``nofknames``: disable improved relationship naming when multiple FKs or
+    junction tables connect to the same target. By default, uses FK column names
+    for one-to-many (e.g., ``simple_items_parent_container``) and junction table
+    names for many-to-many (e.g., ``students_enrollments``). Reverts to
+    underscore suffixes (``simple_items_``, ``student_``).
 
 * ``dataclasses``
 
@@ -184,6 +194,14 @@ due to that ``_id`` suffix.
 For self referential relationships, the reverse side of the relationship will be named
 with the ``_reverse`` suffix appended to it.
 
+When multiple foreign keys or junction tables connect to the same target table,
+relationships use qualifiers for disambiguation. One-to-many relationships use FK
+column names (e.g., ``simple_items_parent_container``, ``simple_items_top_container``).
+Many-to-many relationships use junction table names (e.g., ``students_enrollments``,
+``students_waitlist``), except for self-referential cases which use FK column names
+(e.g., ``parent``, ``child``). The ``nofknames`` option reverts to underscore suffixes
+(``simple_items_``, ``student_``).
+
 Customizing code generation logic
 =================================
 
@@ -208,3 +226,11 @@ sqlalchemy_ room on Gitter.
 
 .. _sqlacodegen discussion forum: https://github.com/agronholm/sqlacodegen/discussions/categories/q-a
 .. _sqlalchemy: https://app.gitter.im/#/room/#sqlalchemy_community:gitter.im
+
+Security contact information
+============================
+
+To report a security vulnerability, please use the `Tidelift security contact`_.
+Tidelift will coordinate the fix and disclosure.
+
+.. _Tidelift security contact: https://tidelift.com/security

{sqlacodegen-3.2.0 → sqlacodegen-4.0.0}/pyproject.toml

@@ -39,13 +39,6 @@ dynamic = ["version"]
 "Source Code" = "https://github.com/agronholm/sqlacodegen"
 
 [project.optional-dependencies]
-test = [
-    "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.17.0"]
@@ -60,6 +53,14 @@ sqlmodels = "sqlacodegen.generators:SQLModelGenerator"
 [project.scripts]
 sqlacodegen = "sqlacodegen.cli:main"
 
+[dependency-groups]
+test = [
+    "pytest >= 7.4",
+    "coverage >= 7",
+    "psycopg[binary]",
+    "mysql-connector-python",
+]
+
 [tool.setuptools_scm]
 version_scheme = "post-release"
 local_scheme = "dirty-tag"
@@ -99,4 +100,5 @@ skip_missing_interpreters = true
 [tool.tox.env_run_base]
 package = "editable"
 commands = [["python", "-m", "pytest", { replace = "posargs", extend = true }]]
-extras = ["test"]
+dependency_groups = ["test"]
+extras = ["sqlmodel", "citext", "geoalchemy2", "pgvector"]