Homogenize @declared_attr parameter name

Homogenize the parameter name of the methods decorated by `@declared_attr.*`.

This pull request is:

- [x] A documentation / typographical / small typing error fix
	- Good to go, no issue or tests are needed

Closes: #13438
Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/13438
Pull-request-sha: e7b77149cc48c2410eb83442e348a5740973f50a

Change-Id: I573ad13e0e7a55359342b36ffa03beeba2513a95

diff --git a/doc/build/orm/declarative_mixins.rst b/doc/build/orm/declarative_mixins.rst
index 8087276d9129a955d433740997710d0b4b08c8da..a921526d1bee3c2fd3538c108c68bb01c6823ce3 100644 (file)
--- a/doc/build/orm/declarative_mixins.rst
+++ b/doc/build/orm/declarative_mixins.rst
@@ -51,7 +51,7 @@ An example of some commonly mixed-in idioms is below::
         log_record_id: Mapped[int] = mapped_column(ForeignKey("logrecord.id"))
 
         @declared_attr
-        def log_record(self) -> Mapped["LogRecord"]:
+        def log_record(cls) -> Mapped["LogRecord"]:
             return relationship("LogRecord")
 
 
@@ -184,7 +184,7 @@ below illustrates some of the previous section's example in terms of the
         log_record_id: Mapped[int] = mapped_column(ForeignKey("logrecord.id"))
 
         @declared_attr
-        def log_record(self) -> Mapped["LogRecord"]:
+        def log_record(cls) -> Mapped["LogRecord"]:
             return relationship("LogRecord")
 
 
@@ -239,7 +239,7 @@ example below::
         log_record_id = mapped_column(ForeignKey("logrecord.id"))
 
         @declared_attr
-        def log_record(self):
+        def log_record(cls):
             return relationship("LogRecord")
 
 

diff --git a/test/orm/declarative/test_mixin.py b/test/orm/declarative/test_mixin.py
index 0ec0cdbe622c1cdb12519f5882144e382d73e769..b14cbcd03f82b053eaae4e1e55c0c71b6b87d668 100644 (file)
--- a/test/orm/declarative/test_mixin.py
+++ b/test/orm/declarative/test_mixin.py
@@ -1080,7 +1080,7 @@ class DeclarativeMixinTest(DeclarativeTestBase):
             __tablename__ = "test"
 
             @declared_attr
-            def __table_args__(self):
+            def __table_args__(cls):
                 info = {}
                 args = dict(info=info)
                 info.update(MyMixin1.__table_args__["info"])
@@ -1221,7 +1221,7 @@ class DeclarativeMixinTest(DeclarativeTestBase):
                 return {"mysql_engine": "InnoDB"}
 
             @declared_attr
-            def id(self):
+            def id(cls):
                 return Column(Integer, primary_key=True)
 
         Base = declarative_base(cls=Base)
@@ -1549,7 +1549,7 @@ class DeclarativeMixinTest(DeclarativeTestBase):
     def test_honor_class_mro_one(self):
         class HasXMixin:
             @declared_attr
-            def x(self):
+            def x(cls):
                 return Column(Integer)
 
         class Parent(HasXMixin, Base):
@@ -1565,7 +1565,7 @@ class DeclarativeMixinTest(DeclarativeTestBase):
     def test_honor_class_mro_two(self):
         class HasXMixin:
             @declared_attr
-            def x(self):
+            def x(cls):
                 return Column(Integer)
 
         class Parent(HasXMixin, Base):

diff --git a/test/orm/declarative/test_tm_future_annotations_sync.py b/test/orm/declarative/test_tm_future_annotations_sync.py
index d0bed9789a8db097f9c9fce4d096b9d91a7e375c..2bbaf6375a2bd294d04faae082d67db320c417c0 100644 (file)
--- a/test/orm/declarative/test_tm_future_annotations_sync.py
+++ b/test/orm/declarative/test_tm_future_annotations_sync.py
@@ -3354,33 +3354,33 @@ class MixinTest(fixtures.TestBase, testing.AssertsCompiledSQL):
             id: Mapped[int] = mapped_column(primary_key=True)
 
             @declared_attr
-            def users(self) -> Mapped[List[User]]:
+            def users(cls) -> Mapped[List[User]]:
                 return relationship(User)
 
             if use_directive:
                 if use_annotation:
 
                     @declared_attr.directive
-                    def user_ids(self) -> AssociationProxy[List[int]]:
+                    def user_ids(cls) -> AssociationProxy[List[int]]:
                         return association_proxy("users", "id")
 
                 else:
 
                     @declared_attr.directive
-                    def user_ids(self):
+                    def user_ids(cls):
                         return association_proxy("users", "id")
 
             else:
                 if use_annotation:
 
                     @declared_attr
-                    def user_ids(self) -> AssociationProxy[List[int]]:
+                    def user_ids(cls) -> AssociationProxy[List[int]]:
                         return association_proxy("users", "id")
 
                 else:
 
                     @declared_attr
-                    def user_ids(self):
+                    def user_ids(cls):
                         return association_proxy("users", "id")
 
         class Thing(Mixin, decl_base):

diff --git a/test/orm/declarative/test_typed_mapping.py b/test/orm/declarative/test_typed_mapping.py
index af6c92ab1e4c0cb4f66820346cb649f1cce8359c..75a4e0c7dc39b22d1112038e6a4f589ef8e6e2ee 100644 (file)
--- a/test/orm/declarative/test_typed_mapping.py
+++ b/test/orm/declarative/test_typed_mapping.py
@@ -3345,33 +3345,33 @@ class MixinTest(fixtures.TestBase, testing.AssertsCompiledSQL):
             id: Mapped[int] = mapped_column(primary_key=True)
 
             @declared_attr
-            def users(self) -> Mapped[List[User]]:
+            def users(cls) -> Mapped[List[User]]:
                 return relationship(User)
 
             if use_directive:
                 if use_annotation:
 
                     @declared_attr.directive
-                    def user_ids(self) -> AssociationProxy[List[int]]:
+                    def user_ids(cls) -> AssociationProxy[List[int]]:
                         return association_proxy("users", "id")
 
                 else:
 
                     @declared_attr.directive
-                    def user_ids(self):
+                    def user_ids(cls):
                         return association_proxy("users", "id")
 
             else:
                 if use_annotation:
 
                     @declared_attr
-                    def user_ids(self) -> AssociationProxy[List[int]]:
+                    def user_ids(cls) -> AssociationProxy[List[int]]:
                         return association_proxy("users", "id")
 
                 else:
 
                     @declared_attr
-                    def user_ids(self):
+                    def user_ids(cls):
                         return association_proxy("users", "id")
 
         class Thing(Mixin, decl_base):

diff --git a/test/typing/plain_files/ext/association_proxy/association_proxy_three.py b/test/typing/plain_files/ext/association_proxy/association_proxy_three.py
index 2f18a9aff34b08452d0554a3894acfa47aeb8f00..896f51085f87694cdf27b5c0277cafb8294eb287 100644 (file)
--- a/test/typing/plain_files/ext/association_proxy/association_proxy_three.py
+++ b/test/typing/plain_files/ext/association_proxy/association_proxy_three.py
@@ -21,11 +21,11 @@ class Milestone:
     id: Mapped[int] = mapped_column(primary_key=True)
 
     @declared_attr
-    def users(self) -> Mapped[List["User"]]:
+    def users(cls) -> Mapped[List["User"]]:
         return relationship("User")
 
     @declared_attr
-    def user_ids(self) -> AssociationProxy[List[int]]:
+    def user_ids(cls) -> AssociationProxy[List[int]]:
         return association_proxy("users", "id")