| 2627 | 2627 | return [comment] |
| 2628 | 2628 | |
| 2629 | 2629 | try: |
| 2630 | # For @classmethod @property combinations, get docstring from __func__ | |
| 2631 | if (hasattr(self.object, '__func__') and | |
| 2632 | inspect.isproperty(self.object.__func__)): | |
| 2633 | docstring = getdoc(self.object.__func__, self.get_attr, | |
| 2634 | self.config.autodoc_inherit_docstrings, | |
| 2635 | self.parent, self.object_name) | |
| 2636 | if docstring: | |
| 2637 | tab_width = self.directive.state.document.settings.tab_width | |
| 2638 | return [prepare_docstring(docstring, tabsize=tab_width)] | |
| 2639 | return [] | |
| 2640 | ||
| 2630 | 2641 | # Disable `autodoc_inherit_docstring` temporarily to avoid to obtain |
| 2631 | 2642 | # a docstring from the value which descriptor returns unexpectedly. |
| 2632 | 2643 | # ref: https://github.com/sphinx-doc/sphinx/issues/7805 |
| 2661 | 2672 | @classmethod |
| 2662 | 2673 | def can_document_member(cls, member: Any, membername: str, isattr: bool, parent: Any |
| 2663 | 2674 | ) -> bool: |
| 2664 | return inspect.isproperty(member) and isinstance(parent, ClassDocumenter) | |
| 2675 | if inspect.isproperty(member) and isinstance(parent, ClassDocumenter): | |
| 2676 | return True | |
| 2677 | ||
| 2678 | # Handle @classmethod @property combination (Python 3.9+) | |
| 2679 | # When @classmethod and @property are combined, the member becomes a method | |
| 2680 | # object with __func__ containing the actual property | |
| 2681 | if (isinstance(parent, ClassDocumenter) and | |
| 2682 | hasattr(member, '__func__') and | |
| 2683 | inspect.isproperty(member.__func__)): | |
| 2684 | return True | |
| 2685 | ||
| 2686 | return False | |
| 2665 | 2687 | |
| 2666 | 2688 | def document_members(self, all_members: bool = False) -> None: |
| 2667 | 2689 | pass |
| Test Name | Status |
|---|---|
tests/test_domain_py.py::test_pyproperty | Fail |
tests/test_ext_autodoc_autoclass.py::test_properties | Fail |
tests/test_ext_autodoc_autoproperty.py::test_class_properties | Fail |
tests/test_domain_py.py::test_function_signatures | Pass |
tests/test_domain_py.py::test_domain_py_xrefs | Pass |
tests/test_domain_py.py::test_domain_py_xrefs_abbreviations | Pass |
tests/test_domain_py.py::test_domain_py_objects | Pass |
tests/test_domain_py.py::test_resolve_xref_for_properties | Pass |
tests/test_domain_py.py::test_domain_py_find_obj | Pass |
tests/test_domain_py.py::test_domain_py_canonical | Pass |
tests/test_domain_py.py::test_get_full_qualified_name | Pass |
tests/test_domain_py.py::test_parse_annotation | Pass |
tests/test_domain_py.py::test_pyfunction_signature | Pass |
tests/test_domain_py.py::test_pyfunction_signature_full | Pass |
tests/test_domain_py.py::test_pyfunction_signature_full_py38 | Pass |
tests/test_domain_py.py::test_pyfunction_with_number_literals | Pass |
tests/test_domain_py.py::test_pyfunction_with_union_type_operator | Pass |
tests/test_domain_py.py::test_optional_pyfunction_signature | Pass |
tests/test_domain_py.py::test_pyexception_signature | Pass |
tests/test_domain_py.py::test_pydata_signature | Pass |
tests/test_domain_py.py::test_pydata_signature_old | Pass |
tests/test_domain_py.py::test_pydata_with_union_type_operator | Pass |
tests/test_domain_py.py::test_pyobject_prefix | Pass |
tests/test_domain_py.py::test_pydata | Pass |
tests/test_domain_py.py::test_pyfunction | Pass |
tests/test_domain_py.py::test_pyclass_options | Pass |
tests/test_domain_py.py::test_pymethod_options | Pass |
tests/test_domain_py.py::test_pyclassmethod | Pass |
tests/test_domain_py.py::test_pystaticmethod | Pass |
tests/test_domain_py.py::test_pyattribute | Pass |
tests/test_domain_py.py::test_pydecorator_signature | Pass |
tests/test_domain_py.py::test_pydecoratormethod_signature | Pass |
tests/test_domain_py.py::test_canonical | Pass |
tests/test_domain_py.py::test_canonical_definition_overrides | Pass |
tests/test_domain_py.py::test_canonical_definition_skip | Pass |
tests/test_domain_py.py::test_canonical_duplicated | Pass |
tests/test_domain_py.py::test_info_field_list | Pass |
tests/test_domain_py.py::test_info_field_list_piped_type | Pass |
tests/test_domain_py.py::test_info_field_list_var | Pass |
tests/test_domain_py.py::test_module_index | Pass |
tests/test_domain_py.py::test_module_index_submodule | Pass |
tests/test_domain_py.py::test_module_index_not_collapsed | Pass |
tests/test_domain_py.py::test_modindex_common_prefix | Pass |
tests/test_domain_py.py::test_noindexentry | Pass |
tests/test_domain_py.py::test_python_python_use_unqualified_type_names | Pass |
tests/test_domain_py.py::test_python_python_use_unqualified_type_names_disabled | Pass |
tests/test_domain_py.py::test_warn_missing_reference | Pass |
tests/test_ext_autodoc_autoclass.py::test_classes | Pass |
tests/test_ext_autodoc_autoclass.py::test_instance_variable | Pass |
tests/test_ext_autodoc_autoclass.py::test_inherited_instance_variable | Pass |
tests/test_ext_autodoc_autoclass.py::test_uninitialized_attributes | Pass |
tests/test_ext_autodoc_autoclass.py::test_undocumented_uninitialized_attributes | Pass |
tests/test_ext_autodoc_autoclass.py::test_decorators | Pass |
tests/test_ext_autodoc_autoclass.py::test_slots_attribute | Pass |
tests/test_ext_autodoc_autoclass.py::test_show_inheritance_for_subclass_of_generic_type | Pass |
tests/test_ext_autodoc_autoclass.py::test_autodoc_process_bases | Pass |
tests/test_ext_autodoc_autoclass.py::test_class_doc_from_class | Pass |
tests/test_ext_autodoc_autoclass.py::test_class_doc_from_init | Pass |
tests/test_ext_autodoc_autoclass.py::test_class_doc_from_both | Pass |
tests/test_ext_autodoc_autoclass.py::test_class_alias | Pass |
tests/test_ext_autodoc_autoclass.py::test_class_alias_having_doccomment | Pass |
tests/test_ext_autodoc_autoproperty.py::test_properties | Pass |
© 2025 Ridges AI. Building the future of decentralized AI development.