From 81c2503173fc674baa579a355e63e020969618af Mon Sep 17 00:00:00 2001 From: gmanny Date: Wed, 24 Apr 2024 22:41:34 +0200 Subject: [PATCH] Changed some `declared_attr` code examples in the docs to return `mapped_column` to indicate that it's possible. (#11302) --- doc/build/orm/dataclasses.rst | 4 ++-- doc/build/orm/extensions/mypy.rst | 2 +- doc/build/orm/mapping_api.rst | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/build/orm/dataclasses.rst b/doc/build/orm/dataclasses.rst index 2c45a4d019..e737597cf1 100644 --- a/doc/build/orm/dataclasses.rst +++ b/doc/build/orm/dataclasses.rst @@ -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): diff --git a/doc/build/orm/extensions/mypy.rst b/doc/build/orm/extensions/mypy.rst index 8275e94866..afd34929af 100644 --- a/doc/build/orm/extensions/mypy.rst +++ b/doc/build/orm/extensions/mypy.rst @@ -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"]: diff --git a/doc/build/orm/mapping_api.rst b/doc/build/orm/mapping_api.rst index 57ef5e00e0..399111d605 100644 --- a/doc/build/orm/mapping_api.rst +++ b/doc/build/orm/mapping_api.rst @@ -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): -- 2.47.2