From 80fb2c051cf0b8e14d2de9cd163cb4f24b1b9713 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 8 May 2021 21:53:51 +0900 Subject: [PATCH] refactor: autodoc: Remove backslashes from the tail of line --- sphinx/ext/autodoc/__init__.py | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/sphinx/ext/autodoc/__init__.py b/sphinx/ext/autodoc/__init__.py index ff6475c9442..8002729a3ee 100644 --- a/sphinx/ext/autodoc/__init__.py +++ b/sphinx/ext/autodoc/__init__.py @@ -389,8 +389,8 @@ def parse_name(self) -> bool: # functions can contain a signature which is then used instead of # an autogenerated one try: - explicit_modname, path, base, args, retann = \ - py_ext_sig_re.match(self.name).groups() + matched = py_ext_sig_re.match(self.name) + explicit_modname, path, base, args, retann = matched.groups() except AttributeError: logger.warning(__('invalid signature for auto%s (%r)') % (self.objtype, self.name), type='autodoc') @@ -412,8 +412,8 @@ def parse_name(self) -> bool: self.args = args self.retann = retann - self.fullname = (self.modname or '') + \ - ('.' + '.'.join(self.objpath) if self.objpath else '') + self.fullname = ((self.modname or '') + + ('.' + '.'.join(self.objpath) if self.objpath else '')) return True def import_object(self, raiseerror: bool = False) -> bool: @@ -824,8 +824,9 @@ def document_members(self, all_members: bool = False) -> None: if self.objpath: self.env.temp_data['autodoc:class'] = self.objpath[0] - want_all = all_members or self.options.inherited_members or \ - self.options.members is ALL + want_all = (all_members or + self.options.inherited_members or + self.options.members is ALL) # find out which members are documentable members_check_module, members = self.get_object_members(want_all) @@ -841,8 +842,7 @@ def document_members(self, all_members: bool = False) -> None: classes.sort(key=lambda cls: cls.priority) # give explicitly separated module name, so that members # of inner classes can be documented - full_mname = self.modname + '::' + \ - '.'.join(self.objpath + [mname]) + full_mname = self.modname + '::' + '.'.join(self.objpath + [mname]) documenter = classes[-1](self.directive, full_mname, self.indent) memberdocumenters.append((documenter, isattr)) @@ -1967,8 +1967,8 @@ def document_members(self, all_members: bool = False) -> None: pass def get_real_modname(self) -> str: - return self.get_attr(self.parent or self.object, '__module__', None) \ - or self.modname + real_modname = self.get_attr(self.parent or self.object, '__module__', None) + return real_modname or self.modname def get_module_comment(self, attrname: str) -> Optional[List[str]]: try: @@ -2033,8 +2033,7 @@ class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter): # type: @classmethod def can_document_member(cls, member: Any, membername: str, isattr: bool, parent: Any ) -> bool: - return inspect.isroutine(member) and \ - not isinstance(parent, ModuleDocumenter) + return inspect.isroutine(member) and not isinstance(parent, ModuleDocumenter) def import_object(self, raiseerror: bool = False) -> bool: ret = super().import_object(raiseerror) @@ -2469,8 +2468,8 @@ def import_object(self, raiseerror: bool = False) -> bool: return ret def get_real_modname(self) -> str: - return self.get_attr(self.parent or self.object, '__module__', None) \ - or self.modname + real_modname = self.get_attr(self.parent or self.object, '__module__', None) + return real_modname or self.modname def should_suppress_value_header(self) -> bool: if super().should_suppress_value_header(): @@ -2571,8 +2570,8 @@ def document_members(self, all_members: bool = False) -> None: pass def get_real_modname(self) -> str: - return self.get_attr(self.parent or self.object, '__module__', None) \ - or self.modname + real_modname = self.get_attr(self.parent or self.object, '__module__', None) + return real_modname or self.modname def add_directive_header(self, sig: str) -> None: super().add_directive_header(sig)