IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

refactor: autodoc: Add type annotation for DataDocumenterMixinBase.object

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-11-23 14:55:27 +09:00
parent b2f92e7c1d
commit 782e3733fc
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
sphinx/ext/autodoc/__init__.py
View File

@ -1701,6 +1701,9 @@ class ExceptionDocumenter(ClassDocumenter):
class DataDocumenterMixinBase: class DataDocumenterMixinBase:
# define types of instance variables
object = None # type: Any
def should_suppress_directive_header(self) -> bool: def should_suppress_directive_header(self) -> bool:
"""Check directive header should be suppressed.""" """Check directive header should be suppressed."""
return False return False
@ -1717,12 +1720,12 @@ class NewTypeMixin(DataDocumenterMixinBase):
""" """
def should_suppress_directive_header(self) -> bool: def should_suppress_directive_header(self) -> bool:
return (inspect.isNewType(self.object) or # type: ignore return (inspect.isNewType(self.object) or
super().should_suppress_directive_header()) super().should_suppress_directive_header())
def update_content(self, more_content: StringList) -> None: def update_content(self, more_content: StringList) -> None:
if inspect.isNewType(self.object): # type: ignore if inspect.isNewType(self.object):
supertype = restify(self.object.__supertype__) # type: ignore supertype = restify(self.object.__supertype__)
more_content.append(_('alias of %s') % supertype, '') more_content.append(_('alias of %s') % supertype, '')
more_content.append('', '') more_content.append('', '')
@ -1736,7 +1739,7 @@ class TypeVarMixin(DataDocumenterMixinBase):
""" """
def should_suppress_directive_header(self) -> bool: def should_suppress_directive_header(self) -> bool:
return (isinstance(self.object, TypeVar) or # type: ignore return (isinstance(self.object, TypeVar) or
super().should_suppress_directive_header()) super().should_suppress_directive_header())
def get_doc(self, encoding: str = None, ignore: int = None) -> List[List[str]]: def get_doc(self, encoding: str = None, ignore: int = None) -> List[List[str]]:
@ -1745,8 +1748,8 @@ class TypeVarMixin(DataDocumenterMixinBase):
% self.__class__.__name__, % self.__class__.__name__,
RemovedInSphinx50Warning, stacklevel=2) RemovedInSphinx50Warning, stacklevel=2)
if isinstance(self.object, TypeVar): # type: ignore if isinstance(self.object, TypeVar):
if self.object.__doc__ != TypeVar.__doc__: # type: ignore if self.object.__doc__ != TypeVar.__doc__:
return super().get_doc() # type: ignore return super().get_doc() # type: ignore
else: else:
return [] return []
@ -1754,13 +1757,13 @@ class TypeVarMixin(DataDocumenterMixinBase):
return super().get_doc() # type: ignore return super().get_doc() # type: ignore
def update_content(self, more_content: StringList) -> None: def update_content(self, more_content: StringList) -> None:
if isinstance(self.object, TypeVar): # type: ignore if isinstance(self.object, TypeVar):
attrs = [repr(self.object.__name__)] # type: ignore attrs = [repr(self.object.__name__)]
for constraint in self.object.__constraints__: # type: ignore for constraint in self.object.__constraints__:
attrs.append(stringify_typehint(constraint)) attrs.append(stringify_typehint(constraint))
if self.object.__covariant__: # type: ignore if self.object.__covariant__:
attrs.append("covariant=True") attrs.append("covariant=True")
if self.object.__contravariant__: # type: ignore if self.object.__contravariant__:
attrs.append("contravariant=True") attrs.append("contravariant=True")
more_content.append(_('alias of TypeVar(%s)') % ", ".join(attrs), '') more_content.append(_('alias of TypeVar(%s)') % ", ".join(attrs), '')