refactor: Deprecate AttributeDocumenter.isinstanceattribute()

2025-02-25 18:55:22 -06:00 · 2020-12-29 20:06:29 +09:00
parent ae9768385a
commit c0f923ee6c
3 changed files with 8 additions and 0 deletions
--- a/1
+++ b/1
@@ -10,6 +10,7 @@ Incompatible changes
 Deprecated
 ----------

+* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
 * ``sphinx.ext.autodoc.importer.get_module_members()``

 Features added
--- a/doc/extdev/deprecated.rst
+++ b/doc/extdev/deprecated.rst
@@ -26,6 +26,11 @@ The following is a list of deprecated interfaces.
     - (will be) Removed
     - Alternatives

+   * - ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
+     - 3.5
+     - 5.0
+     - N/A
+
   * - ``sphinx.ext.autodoc.importer.get_module_members()``
     - 3.5
     - 5.0
--- a/sphinx/ext/autodoc/init.py
+++ b/sphinx/ext/autodoc/init.py
@@ -2362,6 +2362,8 @@ class AttributeDocumenter(GenericAliasMixin, NewTypeMixin, SlotsMixin,  # type:

    def isinstanceattribute(self) -> bool:
        """Check the subject is an instance attribute."""
+        warnings.warn('AttributeDocumenter.isinstanceattribute() is deprecated.',
+                      RemovedInSphinx50Warning)
        # uninitialized instance variable (PEP-526)
        with mock(self.config.autodoc_mock_imports):
            try: