]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Changed some `declared_attr` code examples in the docs to return `mapped_column`...
authorgmanny <gmanyy@gmail.com>
Wed, 24 Apr 2024 20:41:34 +0000 (22:41 +0200)
committerGitHub <noreply@github.com>
Wed, 24 Apr 2024 20:41:34 +0000 (22:41 +0200)
doc/build/orm/dataclasses.rst
doc/build/orm/extensions/mypy.rst
doc/build/orm/mapping_api.rst

index 2c45a4d019647be5b56d5454ac8cdbd13f165fbc..e737597cf1486e45ed410b35c0de3fb25f2bc84a 100644 (file)
@@ -787,8 +787,8 @@ example at :ref:`orm_declarative_mixins_relationships`::
 
     class RefTargetMixin:
         @declared_attr
-        def target_id(cls):
-            return Column("target_id", ForeignKey("target.id"))
+        def target_id(cls) -> Mapped[int]:
+            return mapped_column("target_id", ForeignKey("target.id"))
 
         @declared_attr
         def target(cls):
index 8275e94866b38b5250c74831b679c3ba6584e0b6..afd34929af628803972fba21aa8b83c362f323b7 100644 (file)
@@ -497,7 +497,7 @@ plugin that a particular class intends to serve as a declarative mixin::
     class HasCompany:
         @declared_attr
         def company_id(cls) -> Mapped[int]:  # uses Mapped
-            return Column(ForeignKey("company.id"))
+            return mapped_column(ForeignKey("company.id"))
 
         @declared_attr
         def company(cls) -> Mapped["Company"]:
index 57ef5e00e0ffca7f501dab3b129c1967dad92b73..399111d6058467d1749470968dd87c63cae31433 100644 (file)
@@ -53,11 +53,11 @@ Class Mapping API
 
             class HasIdMixin:
                 @declared_attr.cascading
-                def id(cls):
+                def id(cls) -> Mapped[int]:
                     if has_inherited_table(cls):
-                        return Column(ForeignKey("myclass.id"), primary_key=True)
+                        return mapped_column(ForeignKey("myclass.id"), primary_key=True)
                     else:
-                        return Column(Integer, primary_key=True)
+                        return mapped_column(Integer, primary_key=True)
 
 
             class MyClass(HasIdMixin, Base):