| 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 | """Get docstring for the property, handling @classmethod@property case.""" | |
| 2675 | if ignore is not None: | |
| 2676 | warnings.warn("The 'ignore' argument to autodoc.%s.get_doc() is deprecated." | |
| 2677 | % self.__class__.__name__, | |
| 2678 | RemovedInSphinx50Warning, stacklevel=2) | |
| 2679 | ||
| 2680 | # For @classmethod@property, extract docstring from the underlying property | |
| 2681 | obj = self.object | |
| 2682 | if hasattr(obj, '__func__') and isinstance(obj.__func__, property): | |
| 2683 | # This is a @classmethod@property case | |
| 2684 | property_obj = obj.__func__ | |
| 2685 | else: | |
| 2686 | # Regular property case | |
| 2687 | property_obj = obj | |
| 2688 | ||
| 2689 | docstring = getdoc(property_obj, self.get_attr, self.config.autodoc_inherit_docstrings, | |
| 2690 | self.parent, self.object_name) | |
| 2691 | if docstring: | |
| 2692 | tab_width = self.directive.state.document.settings.tab_width | |
| 2693 | return [prepare_docstring(docstring, ignore, tab_width)] | |
| 2694 | return [] | |
| 2695 | ||
| 2673 | 2696 | def add_directive_header(self, sig: str) -> None: |
| 2674 | 2697 | super().add_directive_header(sig) |
| 2675 | 2698 | sourcename = self.get_sourcename() |
| 2676 | 2699 | if inspect.isabstractmethod(self.object): |
| 2677 | 2700 | self.add_line(' :abstractmethod:', sourcename) |
| 2678 | 2701 | |
| 2679 | if safe_getattr(self.object, 'fget', None) and self.config.autodoc_typehints != 'none': | |
| 2702 | # Handle @classmethod@property case | |
| 2703 | if hasattr(self.object, '__func__') and isinstance(self.object.__func__, property): | |
| 2704 | # This is a @classmethod@property case | |
| 2705 | property_obj = self.object.__func__ | |
| 2706 | else: | |
| 2707 | # Regular property case | |
| 2708 | property_obj = self.object | |
| 2709 | ||
| 2710 | if safe_getattr(property_obj, 'fget', None) and self.config.autodoc_typehints != 'none': | |
| 2680 | 2711 | try: |
| 2681 | signature = inspect.signature(self.object.fget, | |
| 2712 | signature = inspect.signature(property_obj.fget, | |
| 2682 | 2713 | type_aliases=self.config.autodoc_type_aliases) |
| 2683 | 2714 | if signature.return_annotation is not Parameter.empty: |
| 2684 | 2715 | 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.