Merge pull request #8614 from tk0miya/deprecate_AttributeDocumenter_i…

…sinstanceattribute refactor: Deprecate AttributeDocumenter.isinstanceattribute()
sphinx-doc · Dec 30, 2020 · 21698c1 · 21698c1
2 parents c994126 + c0f923e
commit 21698c1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/CHANGES b/CHANGES
@@ -10,6 +10,7 @@ Incompatible changes
 Deprecated
 ----------
 
+* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
 * ``sphinx.ext.autodoc.importer.get_module_members()``
 
 Features added

diff --git 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

diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py
@@ -2362,6 +2362,8 @@ def document_members(self, all_members: bool = False) -> None:
 
     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: