| 31 | 31 | from sphinx.pycode import ModuleAnalyzer, PycodeError |
| 32 | 32 | from sphinx.util import inspect, logging |
| 33 | 33 | from sphinx.util.docstrings import prepare_docstring, separate_metadata |
| 34 | from sphinx.util.inspect import (evaluate_signature, getdoc, object_description, safe_getattr, | |
| 34 | from sphinx.util.inspect import (evaluate_signature, getdoc, isclassproperty, object_description, safe_getattr, | |
| 35 | 35 | stringify_signature) |
| 36 | 36 | from sphinx.util.typing import OptionSpec, get_type_hints, restify |
| 37 | 37 | from sphinx.util.typing import stringify as stringify_typehint |
| 2661 | 2661 | @classmethod |
| 2662 | 2662 | def can_document_member(cls, member: Any, membername: str, isattr: bool, parent: Any |
| 2663 | 2663 | ) -> bool: |
| 2664 | return inspect.isproperty(member) and isinstance(parent, ClassDocumenter) | |
| 2664 | return (inspect.isproperty(member) or isclassproperty(member)) and isinstance(parent, ClassDocumenter) | |
| 2665 | 2665 | |
| 2666 | 2666 | def document_members(self, all_members: bool = False) -> None: |
| 2667 | 2667 | pass |
| 2670 | 2670 | real_modname = self.get_attr(self.parent or self.object, '__module__', None) |
| 2671 | 2671 | return real_modname or self.modname |
| 2672 | 2672 | |
| 2673 | def get_doc(self, ignore: int = None) -> Optional[List[List[str]]]: | |
| 2674 | # For class properties, the docstring is in the __func__ attribute | |
| 2675 | if isclassproperty(self.object): | |
| 2676 | docstring = getdoc(self.object.__func__, self.get_attr, | |
| 2677 | self.config.autodoc_inherit_docstrings, | |
| 2678 | self.parent, self.object_name) | |
| 2679 | if docstring: | |
| 2680 | tab_width = self.directive.state.document.settings.tab_width | |
| 2681 | return [prepare_docstring(docstring, ignore, tab_width)] | |
| 2682 | else: | |
| 2683 | return [] | |
| 2684 | else: | |
| 2685 | return super().get_doc(ignore) | |
| 2686 | ||
| 2673 | 2687 | def add_directive_header(self, sig: str) -> None: |
| 2674 | 2688 | super().add_directive_header(sig) |
| 2675 | 2689 | sourcename = self.get_sourcename() |
| 2676 | if inspect.isabstractmethod(self.object): | |
| 2690 | ||
| 2691 | # For class properties, check the __func__ attribute | |
| 2692 | obj = self.object | |
| 2693 | if isclassproperty(self.object): | |
| 2694 | obj = self.object.__func__ | |
| 2695 | ||
| 2696 | if inspect.isabstractmethod(obj): | |
| 2677 | 2697 | self.add_line(' :abstractmethod:', sourcename) |
| 2678 | 2698 | |
| 2679 | if safe_getattr(self.object, 'fget', None) and self.config.autodoc_typehints != 'none': | |
| 2699 | if safe_getattr(obj, 'fget', None) and self.config.autodoc_typehints != 'none': | |
| 2680 | 2700 | try: |
| 2681 | signature = inspect.signature(self.object.fget, | |
| 2701 | signature = inspect.signature(obj.fget, | |
| 2682 | 2702 | type_aliases=self.config.autodoc_type_aliases) |
| 2683 | 2703 | if signature.return_annotation is not Parameter.empty: |
| 2684 | 2704 | objrepr = stringify_typehint(signature.return_annotation) |
| 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.