Remove member_order attributes (#13962)

Author: AA-Turner

sphinx/ext/autodoc/_documenters.py

@@ -79,8 +79,6 @@ class Documenter:
     #: name by which the directive is called (auto...) and the default
     #: generated directive name
     objtype: ClassVar = 'object'
-    #: order if autodoc_member_order is set to 'groupwise'
-    member_order: ClassVar = 0
     #: true if the generated content may contain titles
     titles_allowed: ClassVar = True
 
@@ -174,14 +172,6 @@ def _load_object_by_name(self) -> Literal[True] | None:
         self.parent = parent
         self.object_name = props.object_name
         self.object = props._obj
-        if self.objtype == 'method':
-            if 'staticmethod' in props.properties:  # type: ignore[attr-defined]
-                # document static members before regular methods
-                self.member_order -= 1  # type: ignore[misc]
-            elif 'classmethod' in props.properties:  # type: ignore[attr-defined]
-                # document class methods before static methods as
-                # they usually behave as alternative constructors
-                self.member_order -= 2  # type: ignore[misc]
         self._load_object_has_been_called = True
         return True
 
@@ -497,7 +487,7 @@ def sort_members(
         """Sort the given member list."""
         if order == 'groupwise':
             # sort by group; alphabetically within groups
-            documenters.sort(key=lambda e: (e[0].member_order, e[0].name))
+            documenters.sort(key=lambda e: (e[0].props._groupwise_order_key, e[0].name))
         elif order == 'bysource':
             if (
                 isinstance(self, ModuleDocumenter)
@@ -780,7 +770,6 @@ class FunctionDocumenter(Documenter):
     props: _FunctionDefProperties
 
     objtype = 'function'
-    member_order = 30
 
 
 class DecoratorDocumenter(FunctionDocumenter):
@@ -797,7 +786,6 @@ class ClassDocumenter(Documenter):
     props: _ClassDefProperties
 
     objtype = 'class'
-    member_order = 20
     option_spec: ClassVar[OptionSpec] = {
         'members': members_option,
         'undoc-members': bool_option,
@@ -836,7 +824,6 @@ class ExceptionDocumenter(ClassDocumenter):
     props: _ClassDefProperties
 
     objtype = 'exception'
-    member_order = 10
 
 
 class DataDocumenter(Documenter):
@@ -847,7 +834,6 @@ class DataDocumenter(Documenter):
     __uninitialized_global_variable__ = True
 
     objtype = 'data'
-    member_order = 40
     option_spec: ClassVar[OptionSpec] = dict(Documenter.option_spec)
     option_spec['annotation'] = annotation_option
     option_spec['no-value'] = bool_option
@@ -860,7 +846,6 @@ class MethodDocumenter(Documenter):
 
     objtype = 'method'
     directivetype = 'method'
-    member_order = 50
 
 
 class AttributeDocumenter(Documenter):
@@ -869,7 +854,6 @@ class AttributeDocumenter(Documenter):
     props: _AssignStatementProperties
 
     objtype = 'attribute'
-    member_order = 60
     option_spec: ClassVar[OptionSpec] = dict(Documenter.option_spec)
     option_spec['annotation'] = annotation_option
     option_spec['no-value'] = bool_option
@@ -887,7 +871,6 @@ class PropertyDocumenter(Documenter):
     props: _FunctionDefProperties
 
     objtype = 'property'
-    member_order = 60
 
 
 class TypeAliasDocumenter(Documenter):
@@ -896,7 +879,6 @@ class TypeAliasDocumenter(Documenter):
     props: _TypeStatementProperties
 
     objtype = 'type'
-    member_order = 70
     option_spec: ClassVar[OptionSpec] = {
         'no-index': bool_option,
         'no-index-entry': bool_option,

sphinx/ext/autodoc/_property_types.py

@@ -79,6 +79,10 @@ def parent_names(self) -> tuple[str, ...]:
     def dotted_parts(self) -> str:
         return '.'.join(self.parts)
 
+    @property
+    def _groupwise_order_key(self) -> int:
+        return 0
+
 
 @dataclasses.dataclass(frozen=False, kw_only=True, slots=True)
 class _ModuleProperties(_ItemProperties):
@@ -139,6 +143,10 @@ def canonical_full_name(self) -> str | None:
             return None
         return f'{modname}.{qualname}'
 
+    @property
+    def _groupwise_order_key(self) -> int:
+        return 10 if self.obj_type == 'exception' else 20
+
 
 @dataclasses.dataclass(frozen=False, kw_only=True, slots=True)
 class _FunctionDefProperties(_ItemProperties):
@@ -174,6 +182,21 @@ def is_final(self) -> bool:
     def is_staticmethod(self) -> bool:
         return 'staticmethod' in self.properties
 
+    @property
+    def _groupwise_order_key(self) -> int:
+        if self.obj_type == 'method':
+            if self.is_classmethod:
+                # document class methods before static methods as
+                # they usually behave as alternative constructors
+                return 48
+            if self.is_staticmethod:
+                # document static members before regular methods
+                return 49
+            return 50
+        if self.obj_type == 'property':
+            return 60
+        return 30
+
 
 @dataclasses.dataclass(frozen=False, kw_only=True, slots=True)
 class _AssignStatementProperties(_ItemProperties):
@@ -194,6 +217,10 @@ class _AssignStatementProperties(_ItemProperties):
     _obj_repr_rst: str
     _obj_type_annotation: str | None
 
+    @property
+    def _groupwise_order_key(self) -> int:
+        return 40 if self.obj_type == 'data' else 60
+
 
 @dataclasses.dataclass(frozen=False, kw_only=True, slots=True)
 class _TypeStatementProperties(_ItemProperties):
@@ -202,3 +229,7 @@ class _TypeStatementProperties(_ItemProperties):
     _obj___name__: str | None
     _obj___qualname__: str | None
     _obj___value__: str  # The aliased annotation
+
+    @property
+    def _groupwise_order_key(self) -> int:
+        return 70