eric: comparison eric6/DocumentationTools/ModuleDocumentor.py

-:fb0ef164f536
+:698ae46f40a4
 this module.
 """
 import sys
 import re
+import contextlib
 from Utilities import html_uencode
 from Utilities.ModuleParser import RB_SOURCE, Function
 _signal = re.compile(
 Exception class raised, if an invalid documentation tag was found.
 """
 pass
-class ModuleDocument(object):
+class ModuleDocument:
 """
 Class implementing the builtin documentation generator.
 """
 def __init__(self, module, colors, stylesheet=None):
 """
 sys.stderr.write("{0}\n".format(e))
 return ""
 classesSection = self.__genClassesSection()
 functionsSection = self.__genFunctionsSection()
-if self.module.type == RB_SOURCE:
+rbModulesSection = (
-rbModulesSection = self.__genRbModulesSection()
+self.__genRbModulesSection()
-else:
+if self.module.type == RB_SOURCE else
-rbModulesSection = ""
+""
+)
 return "{0}{1}{2}{3}".format(
 modBody, classesSection, rbModulesSection, functionsSection)
 def __genListSection(self, names, sectionDict, kwSuffix=""):
 """
 self.__getShortDescription(sectionDict[name].description),
 'Deprecated':
 self.__checkDeprecated(sectionDict[name].description) and
 self.listEntryDeprecatedTemplate or "",
 }))
-if kwSuffix:
+n = ("{0} ({1})".format(name, kwSuffix) if kwSuffix
-n = "{0} ({1})".format(name, kwSuffix)
+else "{0}".format(name))
-else:
-n = "{0}".format(name)
 self.keywords.append((n, "#{0}".format(name)))
 return ''.join(lst)
 def __genGlobalsListSection(self, class_=None):
 """
 @param class_ reference to a class object (Class)
 @return The globals list section. (string)
 """
 attrNames = []
-if class_ is not None:
+scope = class_ if class_ is not None else self.module
-scope = class_
-else:
-scope = self.module
 attrNames = sorted(attr for attr in scope.globals.keys()
 if not scope.globals[attr].isSignal)
-if attrNames:
+s = (
-s = ''.join(
+''.join(
 [self.listEntrySimpleTemplate.format(**{'Name': name})
 for name in attrNames])
-else:
+if attrNames else
-s = self.listEntryNoneTemplate
+self.listEntryNoneTemplate
+)
 return self.listTemplate.format(**{'Entries': s})
 def __genClassListSection(self):
 """
 Private method to generate the section listing all classes of the
 classNames = sorted(list(self.module.classes.keys()))
 classes = []
 for className in classNames:
 _class = self.module.classes[className]
 supers = _class.super
-if len(supers) > 0:
+supers = ', '.join(supers) if len(supers) > 0 else "None"
-supers = ', '.join(supers)
-else:
-supers = 'None'
 globalsList = self.__genGlobalsListSection(_class)
 classMethList, classMethBodies = self.__genMethodSection(
 _class, className, Function.Class)
 methList, methBodies = self.__genMethodSection(
 (boolean)
 @return methods list section (string)
 """
 lst = []
 if includeInit:
-try:
+with contextlib.suppress(KeyError):
 lst.append(self.listEntryTemplate.format(
 **{'Link': "{0}.{1}".format(className, '__init__'),
 'Name': clsName,
 'Description': self.__getShortDescription(
 sectionDict['__init__'].description),
 self.listEntryDeprecatedTemplate or "",
 }))
 self.keywords.append(
 ("{0} (Constructor)".format(className),
 "#{0}.{1}".format(className, '__init__')))
-except KeyError:
-pass
 for name in names:
 lst.append(self.listEntryTemplate.format(
 **{'Link': "{0}.{1}".format(className, name),
 'Name': sectionDict[name].name,
 classNames = sorted(list(obj.classes.keys()))
 classes = []
 for className in classNames:
 _class = obj.classes[className]
 supers = _class.super
-if len(supers) > 0:
+supers = ', '.join(supers) if len(supers) > 0 else "None"
-supers = ', '.join(supers)
-else:
-supers = 'None'
 methList, methBodies = self.__genMethodSection(
 _class, className, Function.General)
 try:
 else:
 lastItem.append(ditem)
 elif not inTagSection:
 lastItem.append(ditem)
-if paragraphs:
+description = self.__genParagraphs(paragraphs) if paragraphs else ""
-description = self.__genParagraphs(paragraphs)
-else:
+parameterSect = (
-description = ""
+self.parametersListTemplate.format(
-if paramList:
-parameterSect = self.parametersListTemplate.format(
 **{'Parameters': self.__genParamDescriptionListSection(
 paramList)})
-else:
+if paramList else
-parameterSect = ""
+""
+)
-if returns:
-returnSect = self.returnsTemplate.format(
+returnSect = (
+self.returnsTemplate.format(
 html_uencode('\n'.join(returns)))
-else:
+if returns else
-returnSect = ""
+""
+)
-if returnTypes:
-returnTypesSect = self.returnTypesTemplate.format(
+returnTypesSect = (
+self.returnTypesTemplate.format(
 html_uencode('\n'.join(returnTypes)))
-else:
+if returnTypes else
-returnTypesSect = ""
+""
+)
-if yields:
-yieldSect = self.yieldsTemplate.format(
+yieldSect = (
+self.yieldsTemplate.format(
 html_uencode('\n'.join(yields)))
-else:
+if yields else
-yieldSect = ""
+""
+)
-if yieldTypes:
-yieldTypesSect = self.yieldTypesTemplate.format(
+yieldTypesSect = (
+self.yieldTypesTemplate.format(
 html_uencode('\n'.join(yieldTypes)))
-else:
+if yieldTypes else
-yieldTypesSect = ""
+""
+)
-if exceptionDict:
-exceptionSect = self.exceptionsListTemplate.format(
+exceptionSect = (
+self.exceptionsListTemplate.format(
 **{'Exceptions': self.__genDescriptionListSection(
 exceptionDict, self.exceptionsListEntryTemplate)})
-else:
+if exceptionDict else
-exceptionSect = ""
+""
+)
-if signalDict:
-signalSect = self.signalsListTemplate.format(
+signalSect = (
+self.signalsListTemplate.format(
 **{'Signals': self.__genDescriptionListSection(
 signalDict, self.signalsListEntryTemplate)})
-else:
+if signalDict else
-signalSect = ""
+""
+)
-if eventDict:
-eventSect = self.eventsListTemplate.format(
+eventSect = (
+self.eventsListTemplate.format(
 **{'Events': self.__genDescriptionListSection(
 eventDict, self.eventsListEntryTemplate)})
-else:
+if eventDict else
-eventSect = ""
+""
+)
-if deprecated:
-deprecatedSect = self.deprecatedTemplate.format(
+deprecatedSect = (
+self.deprecatedTemplate.format(
 **{'Lines': html_uencode('\n'.join(deprecated))})
-else:
+if deprecated else
-deprecatedSect = ""
+""
+)
-if authorInfo:
-authorInfoSect = self.authorInfoTemplate.format(
+authorInfoSect = (
+self.authorInfoTemplate.format(
 **{'Authors': html_uencode('\n'.join(authorInfo))})
-else:
+if authorInfo else
-authorInfoSect = ""
+""
+)
-if sinceInfo:
-sinceInfoSect = self.sinceInfoTemplate.format(
+sinceInfoSect = (
+self.sinceInfoTemplate.format(
 **{'Info': html_uencode(sinceInfo[0])})
-else:
+if sinceInfo else
-sinceInfoSect = ""
+""
+)
-if seeList:
-seeSect = self.seeListTemplate.format(
+seeSect = (
+self.seeListTemplate.format(
 **{'Links': self.__genSeeListSection(
 seeList, self.seeListEntryTemplate)})
-else:
+if seeList else
-seeSect = ''
+''
+)
 return "".join([
 deprecatedSect, description, parameterSect, returnSect,
 returnTypesSect, yieldSect, yieldTypesSect, exceptionSect,
 signalSect, eventSect, authorInfoSect, seeSect, sinceInfoSect,

Mercurial Repositories > eric / file comparison

comparison: eric6/DocumentationTools/ModuleDocumentor.py

eric6/DocumentationTools/ModuleDocumentor.py