eric: comparison DocumentationTools/ModuleDocumentor.py

-:b0996e4a289e
+:1d8dd9706f46
 """
 import sys
 import re
-import TemplatesListsStyle
+from . import TemplatesListsStyle
-import TemplatesListsStyleCSS
+from . import TemplatesListsStyleCSS
 from Utilities import html_uencode
 from Utilities.ModuleParser import RB_SOURCE
 _signal = re.compile(r"""
 self.__formatDescription(self.module.description),
 'GlobalsList' : globalsList,
 'ClassList' : classList,
 'FunctionList' : functionList,
 }
-except TagError, e:
+except TagError as e:
 sys.stderr.write("Error in tags of description of module %s.\n" % \
 self.module.name)
 sys.stderr.write("%s\n" % e)
 return ""
 """
 Private method to generate the section listing all classes of the module.
 @return The classes list section. (string)
 """
-names = self.module.classes.keys()
+names = sorted(list(self.module.classes.keys()))
-names.sort()
 if names:
 self.empty = False
 s = self.__genListSection(names, self.module.classes)
 else:
 s = self.listEntryNoneTemplate
 Private method to generate the section listing all modules of the file
 (Ruby only).
 @return The modules list section. (string)
 """
-names = self.module.modules.keys()
+names = sorted(list(self.module.modules.keys()))
-names.sort()
 if names:
 self.empty = False
 s = self.__genListSection(names, self.module.modules)
 else:
 s = self.listEntryNoneTemplate
 """
 Private method to generate the section listing all functions of the module.
 @return The functions list section. (string)
 """
-names = self.module.functions.keys()
+names = sorted(list(self.module.functions.keys()))
-names.sort()
 if names:
 self.empty = False
 s = self.__genListSection(names, self.module.functions)
 else:
 s = self.listEntryNoneTemplate
 """
 Private method to generate the document section with details about classes.
 @return The classes details section. (string)
 """
-classNames = self.module.classes.keys()
+classNames = sorted(list(self.module.classes.keys()))
-classNames.sort()
 classes = []
 for className in classNames:
 _class = self.module.classes[className]
 supers = _class.super
 if len(supers) > 0:
 'ClassDescription' : self.__formatDescription(_class.description),
 'GlobalsList' : globalsList,
 'MethodList' : methList,
 'MethodDetails' : methBodies,
 }
-except TagError, e:
+except TagError as e:
 sys.stderr.write("Error in tags of description of class %s.\n" % \
 className)
 sys.stderr.write("%s\n" % e)
 clsBody = ""
 @param className Name of the class containing the method. (string)
 @return The method list and method details section. (tuple of two string)
 """
 methList = []
 methBodies = []
-methods = obj.methods.keys()
+methods = sorted(list(obj.methods.keys()))
-methods.sort()
-# first do the constructor
 if '__init__' in methods:
 methods.remove('__init__')
 try:
 methBody = self.constructorTemplate % { \
 'Anchor' : className,
 'Method' : '__init__',
 'MethodDescription' : \
 self.__formatDescription(obj.methods['__init__'].description),
 'Params' : ', '.join(obj.methods['__init__'].parameters[1:]),
 }
-except TagError, e:
+except TagError as e:
 sys.stderr.write("Error in tags of description of method %s.%s.\n" % \
 (className, '__init__'))
 sys.stderr.write("%s\n" % e)
 methBody = ""
 methBodies.append(methBody)
 'Method' : obj.methods[method].name,
 'MethodDescription' : \
 self.__formatDescription(obj.methods[method].description),
 'Params' : ', '.join(obj.methods[method].parameters[1:]),
 }
-except TagError, e:
+except TagError as e:
 sys.stderr.write("Error in tags of description of method %s.%s.\n" % \
 (className, method))
 sys.stderr.write("%s\n" % e)
 methBody = ""
 methBodies.append(methBody)
 """
 Private method to generate the document section with details about Ruby modules.
 @return The Ruby modules details section. (string)
 """
-rbModulesNames = self.module.modules.keys()
+rbModulesNames = sorted(list(self.module.modules.keys()))
-rbModulesNames.sort()
 rbModules = []
 for rbModuleName in rbModulesNames:
 rbModule = self.module.modules[rbModuleName]
 globalsList = self.__genGlobalsListSection(rbModule)
 methList, methBodies = self.__genMethodSection(rbModule, rbModuleName)
 'ClassesList' : classList,
 'ClassesDetails' : classBodies,
 'FunctionsList' : methList,
 'FunctionsDetails' : methBodies,
 }
-except TagError, e:
+except TagError as e:
 sys.stderr.write("Error in tags of description of Ruby module %s.\n" % \
 rbModuleName)
 sys.stderr.write("%s\n" % e)
 rbmBody = ""
 @param obj Reference to the object being formatted.
 @param modName Name of the Ruby module containing the classes. (string)
 @return The classes list and classes details section. (tuple of two string)
 """
-classNames = obj.classes.keys()
+classNames = sorted(list(obj.classes.keys()))
-classNames.sort()
 classes = []
 for className in classNames:
 _class = obj.classes[className]
 supers = _class.super
 if len(supers) > 0:
 'ClassSuper' : supers,
 'ClassDescription' : self.__formatDescription(_class.description),
 'MethodList' : methList,
 'MethodDetails' : methBodies,
 }
-except TagError, e:
+except TagError as e:
 sys.stderr.write("Error in tags of description of class %s.\n" % \
 className)
 sys.stderr.write("%s\n" % e)
 clsBody = ""
 Private method to generate the document section with details about functions.
 @return The functions details section. (string)
 """
 funcBodies = []
-funcNames = self.module.functions.keys()
+funcNames = sorted(list(self.module.functions.keys()))
-funcNames.sort()
 for funcName in funcNames:
 try:
 funcBody = self.functionTemplate % { \
 'Anchor' : funcName,
 'Function' : self.module.functions[funcName].name,
 'FunctionDescription' : self.__formatDescription(\
 self.module.functions[funcName].description),
 'Params' : ', '.join(self.module.functions[funcName].parameters),
 }
-except TagError, e:
+except TagError as e:
 sys.stderr.write("Error in tags of description of function %s.\n" % \
 funcName)
 sys.stderr.write("%s\n" % e)
 funcBody = ""
 list section.
 @param template The template to be used for the list. (string)
 @return The list section. (string)
 """
 lst = []
-keys = dictionary.keys()
+keys = sorted(list(dictionary.keys()))
-keys.sort()
 for key in keys:
 lst.append(template % { \
 'Name' : key,
 'Description' : html_uencode('\n'.join(dictionary[key])),
 })
 """
 start = desc.find('{@')
 while start != -1:
 stop = desc.find('}', start + 2)
 if stop == -1:
-raise TagError, "Unterminated inline tag.\n%s" % desc
+raise TagError("Unterminated inline tag.\n%s" % desc)
 tagText = desc[start + 1:stop]
 if tagText.startswith('@link'):
 parts = tagText.split(None, 1)
 if len(parts) < 2:
-raise TagError, "Wrong format in inline tag %s.\n%s" % \
+raise TagError("Wrong format in inline tag %s.\n%s" % \
-(parts[0], desc)
+(parts[0], desc))
 formattedTag = self.__formatCrossReferenceEntry(parts[1])
 desc = desc.replace("{%s}" % tagText, formattedTag)
 else:
 tag = tagText.split(None, 1)[0]
-raise TagError, "Unknown inline tag encountered, %s.\n%s" % \
+raise TagError("Unknown inline tag encountered, %s.\n%s" % \
-(tag, desc)
+(tag, desc))
 start = desc.find('{@')
 return desc
 if desc:
 if desc.startswith("@param") or desc.startswith("@keyparam"):
 inTagSection = True
 parts = desc.split(None, 2)
 if len(parts) < 2:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 paramName = parts[1]
 if parts[0] == "@keyparam":
 paramName += '='
 try:
 paramList.append([paramName, [parts[2]]])
 lastItem = paramList[-1][1]
 elif desc.startswith("@return"):
 inTagSection = True
 parts = desc.split(None, 1)
 if len(parts) < 2:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 returns = [parts[1]]
 lastItem = returns
 elif desc.startswith("@exception") or \
 desc.startswith("@throws") or \
 desc.startswith("@raise"):
 inTagSection = True
 parts = desc.split(None, 2)
 if len(parts) < 2:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 excName = parts[1]
 try:
 exceptionDict[excName] = [parts[2]]
 except IndexError:
 exceptionDict[excName] = []
 lastItem = exceptionDict[excName]
 elif desc.startswith("@signal"):
 inTagSection = True
 m = _signal(desc,0)
 if m is None:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 signalName = 1 and m.group("SignalName1") \
 or m.group("SignalName2")
 signalDesc = 1 and m.group("SignalDescription1") \
 or m.group("SignalDescription2")
 signalDict[signalName] = []
 lastItem = signalDict[signalName]
 elif desc.startswith("@event"):
 inTagSection = True
 m = _event(desc,0)
 if m is None:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 eventName = 1 and m.group("EventName1") \
 or m.group("EventName2")
 eventDesc = 1 and m.group("EventDescription1") \
 or m.group("EventDescription2")
 eventDict[eventName] = []
 lastItem = eventDict[eventName]
 elif desc.startswith("@deprecated"):
 inTagSection = True
 parts = desc.split(None, 1)
 if len(parts) < 2:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 deprecated = [parts[1]]
 lastItem = deprecated
 elif desc.startswith("@author"):
 inTagSection = True
 parts = desc.split(None, 1)
 if len(parts) < 2:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 authorInfo = [parts[1]]
 lastItem = authorInfo
 elif desc.startswith("@since"):
 inTagSection = True
 parts = desc.split(None, 1)
 if len(parts) < 2:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 sinceInfo = [parts[1]]
 lastItem = sinceInfo
 elif desc.startswith("@see"):
 inTagSection = True
 parts = desc.split(None, 1)
 if len(parts) < 2:
-raise TagError, "Wrong format in %s line.\n" % parts[0]
+raise TagError("Wrong format in %s line.\n" % parts[0])
 seeList.append([parts[1]])
 lastItem = seeList[-1]
 elif desc.startswith("@@"):
 lastItem.append(desc[1:])
 elif desc.startswith("@"):
 tag = desc.split(None, 1)[0]
-raise TagError, "Unknown tag encountered, %s.\n" % tag
+raise TagError("Unknown tag encountered, %s.\n" % tag)
 else:
 lastItem.append(ditem)
 elif not inTagSection:
 lastItem.append(ditem)

Mercurial Repositories > eric / file comparison

comparison: DocumentationTools/ModuleDocumentor.py

DocumentationTools/ModuleDocumentor.py