Allow to opt out from special naming when fieldname ends with _id (#356)

* Allow to opt out from special naming when fieldname ends with _id

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

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

* PR Fixes

* Fix changes.rst

* Split the line in CHANGES.rst

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: idan.sheinberg <[email protected]>
Co-authored-by: Alex Grönholm <[email protected]>

Author: 4 people

CHANGES.rst

@@ -5,6 +5,8 @@ Version history
 
 - Dropped support for Python 3.9
 - Fix Postgres ``DOMAIN`` adaptation regression introduced in SQLAlchemy 2.0.42 (PR by @sheinbergon)
+- Support disabling special naming logic for single column many-to-one and one-to-one relationships
+  (PR by @Henkhogan, revised by @sheinbergon)
 
 **3.1.1**
 

README.rst

@@ -103,6 +103,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
+  * ``noidsuffix``: prevent the special naming logic for single column many-to-one
+    and one-to-one relationships (see `Relationship naming logic`_ for details)
 
 * ``declarative``
 

src/sqlacodegen/generators.py

@@ -766,6 +766,7 @@ class DeclarativeGenerator(TablesGenerator):
         "use_inflect",
         "nojoined",
         "nobidi",
+        "noidsuffix",
     }
 
     def __init__(
@@ -1102,7 +1103,7 @@ def generate_relationship_name(
 
             # If there's a constraint with a single column that ends with "_id", use the
             # preceding part as the relationship name
-            if relationship.constraint:
+            if relationship.constraint and "noidsuffix" not in self.options:
                 is_source = relationship.source.table is relationship.constraint.table
                 if is_source or relationship.type not in (
                     RelationshipType.ONE_TO_ONE,

tests/test_generator_declarative.py

@@ -1563,6 +1563,62 @@ class SimpleItems(Base):
     )
 
 
+@pytest.mark.parametrize("generator", [["noidsuffix"]], indirect=True)
+def test_named_foreign_key_constraints_with_noidsuffix(
+    generator: CodeGenerator,
+) -> None:
+    Table(
+        "simple_items",
+        generator.metadata,
+        Column("id", INTEGER, primary_key=True),
+        Column("container_id", INTEGER),
+        ForeignKeyConstraint(
+            ["container_id"], ["simple_containers.id"], name="foreignkeytest"
+        ),
+    )
+    Table(
+        "simple_containers",
+        generator.metadata,
+        Column("id", INTEGER, primary_key=True),
+    )
+
+    validate_code(
+        generator.generate(),
+        """\
+from typing import Optional
+
+from sqlalchemy import ForeignKeyConstraint, Integer
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
+
+class Base(DeclarativeBase):
+    pass
+
+
+class SimpleContainers(Base):
+    __tablename__ = 'simple_containers'
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+
+    simple_items: Mapped[list['SimpleItems']] = relationship('SimpleItems', \
+back_populates='simple_containers')
+
+
+class SimpleItems(Base):
+    __tablename__ = 'simple_items'
+    __table_args__ = (
+        ForeignKeyConstraint(['container_id'], ['simple_containers.id'], \
+name='foreignkeytest'),
+    )
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    container_id: Mapped[Optional[int]] = mapped_column(Integer)
+
+    simple_containers: Mapped[Optional['SimpleContainers']] = relationship('SimpleContainers', \
+back_populates='simple_items')
+""",
+    )
+
+
 # @pytest.mark.xfail(strict=True)
 def test_colname_import_conflict(generator: CodeGenerator) -> None:
     Table(