Fix sphinx-doc#8583: autodoc: Unnecessary object comparision via ``__…

…eq__`` method It should be compared by `is` keyword instead.
tk0miya · Dec 24, 2020 · 5c39d0c · 5c39d0c
1 parent 0432604
commit 5c39d0c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/CHANGES b/CHANGES
@@ -22,6 +22,7 @@ Bugs fixed
 * #8567: autodoc: Instance attributes are incorrectly added to Parent class
 * #8566: autodoc: The ``autodoc-process-docstring`` event is emitted to the
   alias classes unexpectedly
+* #8583: autodoc: Unnecessary object comparision via ``__eq__`` method
 * #8565: linkcheck: Fix PriorityQueue crash when link tuples are not
   comparable
 

diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py
@@ -1829,7 +1829,7 @@ def import_object(self, raiseerror: bool = False) -> bool:
                 return False
 
     def should_suppress_value_header(self) -> bool:
-        return (self.object == UNINITIALIZED_ATTR or
+        return (self.object is UNINITIALIZED_ATTR or
                 super().should_suppress_value_header())
 
     def get_doc(self, encoding: str = None, ignore: int = None) -> List[List[str]]: