Changeset 454 for branches

Timestamp:

09/01/08 16:40:15 (4 years ago)

Author:

apdavison

Message:

Ported changes to wikidoc.py from 0.3 branch

Location:

branches/0.4

Files:

• doc/wikidoc.py (modified) (4 diffs)
• test/VAbenchmarks.py (modified) (2 diffs)

branches/0.4/doc/wikidoc.py

@@ -2 +2 @@
 """Writes documentation for the API in Wiki format."""
 
+import os
 import sys
-import pyNN.common
+from pyNN import common
 import types, string, re, logging
 import math
-
-#-- Set up logging -------------------------------------------------------------
-logging.basicConfig(level=logging.DEBUG,
-                    format='%(asctime)s %(levelname)-8s %(message)s',
-                    datefmt='%Y%m%d-%H%M%S',
-                    filename='wikidoc.log',
-                    filemode='w')
-# define a Handler which writes WARNING messages or higher to the sys.stderr
-console = logging.StreamHandler()
-console.setLevel(logging.WARNING)
-# set a format which is simpler for console use
-formatter = logging.Formatter('%(message)s')
-# tell the handler to use this format
-console.setFormatter(formatter)
-# add the handler to the root logger
-logging.getLogger('').addHandler(console)
+#import imp
+
+# Rather painful way of importing
+#this_file = os.path.abspath(__file__)
+#common_file = os.path.join(os.path.split(os.path.split(this_file)[0])[0],'common.py')
+#common = imp.load_source('common', common_file)
 
 #-- Define global data ---------------------------------------------------------
@@ -36 +27 @@
 leftdblquote = re.compile(r'"\b')
 camelcase = re.compile(r'(\b([A-Z][a-z]+){2,99})')
-
-classes = {}
-functions = []
-data = []
-
-#-- Process command line parameters --------------------------------------------
-if len(sys.argv) > 1:
-    output = sys.argv[1]
-else:
-    output = 'wiki'
-logging.info('Generating API documentation in %s format' % output)
-
-#-- Define templates -----------------------------------------------------------
-if output == 'wiki':
-    default_arg_fmt  = '%s<span style="color:grey;">=%s</span>'
-    func_sig_fmt     = '%s(<span style="font-weight:normal;">%s</span>)'
-    function_fmt     = '\n====<span style="color:#0066ff;">%s</span>====\n'
-    method_fmt       = '\n====<span style="color:#8888ff;">%s</span>====\n'
-    staticmethod_fmt = '\n====<span style="color:#0066ff;">%s</span> (static)====\n'
-    dict_fmt         = "\n\n'''%s''' = {\n"
-    dict_fmt_end     = '}\n'
-    data_element_fmt = "\n'''%s''' = %s\n"
-    table_begin      = "{|\n"
-    table_end        = "|}\n"
-    table_row_fmt    = "| &nbsp;&nbsp;&nbsp; || %s ||: %s\n|-\n"
-    category_fmt     = '\n==%s==\n'
-    class_fmt        = '\n===<span style="color:green">%s</span>===\n'
-    horiz_line       = '\n----\n'
-elif output == 'trac':
-    default_arg_fmt  = '%s=%s'
-    func_sig_fmt     = '%s(%s)'
-    function_fmt     = '\n=== %s ===\n'
-    method_fmt       = '\n=== %s ===\n'
-    staticmethod_fmt = '\n=== %s ===\n'
-    dict_fmt         = "\n\n'''%s''' = {\n"
-    dict_fmt_end     = '}\n'
-    data_element_fmt = "\n'''%s''' = %s\n"
-    table_begin      = "\n"
-    table_end        = "\n"
-    table_row_fmt    = "|| %s ||: %s ||\n"
-    category_fmt     = '\n= %s =\n'
-    class_fmt        = '\n== %s ==\n'
-    horiz_line       = '\n----\n'
-elif output == 'latex':
-    default_arg_fmt  = '%s{\\color{grey}=%s}'
-    func_sig_fmt     = '%s(\\mdseries %s)'
-    function_fmt     = '\n\\paragraph*{\\color{brightblue}{%s}}\n'
-    method_fmt       = '\n\\paragraph*{\\color{brightblue}{%s}}\n'
-    staticmethod_fmt = '\n\\paragraph*{\\color{brightblue}{%s} (static)}\n'
-    dict_fmt         = '\n\\textbf{%s} = $\\lbrace$\n\n'
-    dict_fmt_end     = '$\\rbrace$\n'
-    data_element_fmt = "\n\\textbf{%s} = %s\n"
-    table_begin      = "\\begin{tabular}{lll}\n"
-    table_end        = "\\end{tabular}\n"
-    table_row_fmt    = '& %s & :%s\\\\\n'
-    category_fmt     = '\n\\subsection{%s}\n'
-    class_fmt        = '\n\\subsubsection*{%s}\n'
-    horiz_line       = ''
-             
+newline = "\n"
+ 
 #-- Define functions -----------------------------------------------------------
 
 def _(str):
     """Remove extraneous whitespace."""
+    global newline
     lines = str.strip().split('\n')
     lines = [line.strip() for line in lines]
@@ -113 +48 @@
     return "%s(%s)" % (fname, string.join(args,', '))
 
-def func_sig(func):
+def func_sig(func, default_arg_fmt, func_sig_fmt):
     """Adapted from http://www.lemburg.com/python/hack.py, by  Marc-André Lemburg
        Returns the signature of a Python function/method as string.
@@ -159 +94 @@
 #-- Main block -----------------------------------------------------------------
 
-# gather information from the common module
-logging.info("Gathering information from the common module.")
-for entry in dir(pyNN.common):
-    if entry not in exclude:
-        instance = eval('pyNN.common.%s' % entry)
-        entry_type = type(instance)
-        logging.info('  %-30s %s' % (entry,entry_type))
-        if entry_type in [types.ClassType, types.TypeType]:
-            classes[entry] = { 'methods': [], 'data': [], 'staticmethods': [] }
-            for classentry in dir(instance):
-                if classentry not in exclude and (classentry[0] != '_' or classentry[0:2] == '__'): # don't include private methods
-                    classentry_type = type(eval('pyNN.common.%s.%s' % (entry,classentry)))
-                    logging.info('    %-28s %s' % (classentry,classentry_type))
-                    if classentry_type == types.MethodType:
-                        classes[entry]['methods'].append(classentry)
-                    elif classentry_type == types.FunctionType:
-                        classes[entry]['staticmethods'].append(classentry)
+def apidoc(output):
+    global newline
+    classes = {}
+    functions = []
+    data = []
+    
+    #-- Define templates -----------------------------------------------------------
+    if output == 'wiki':
+        default_arg_fmt  = '%s<span style="color:grey;">=%s</span>'
+        func_sig_fmt     = '%s(<span style="font-weight:normal;">%s</span>)'
+        function_fmt     = '\n====<span style="color:#0066ff;">%s</span>====\n'
+        method_fmt       = '\n====<span style="color:#8888ff;">%s</span>====\n'
+        staticmethod_fmt = '\n====<span style="color:#0066ff;">%s</span> (static)====\n'
+        dict_fmt         = "\n\n'''%s''' = {\n"
+        dict_fmt_end     = '}\n'
+        data_element_fmt = "\n'''%s''' = %s\n"
+        table_begin      = "{|\n"
+        table_end        = "|}\n"
+        table_row_fmt    = "| &nbsp;&nbsp;&nbsp; || %s ||: %s\n|-\n"
+        category_fmt     = '\n==%s==\n'
+        class_fmt        = '\n===<span style="color:green">%s</span>===\n'
+        horiz_line       = '\n----\n'
+        docstr_fmt       = '%s'
+    elif output == 'trac':
+        default_arg_fmt  = '%s=%s'
+        func_sig_fmt     = '%s(%s)'
+        function_fmt     = '\n=== %s ===\n'
+        method_fmt       = '\n=== %s ===\n'
+        staticmethod_fmt = '\n=== %s ===\n'
+        dict_fmt         = "\n\n'''%s''' = {\n"
+        dict_fmt_end     = '}\n'
+        data_element_fmt = "\n'''%s''' = %s\n"
+        table_begin      = "\n"
+        table_end        = "\n"
+        table_row_fmt    = "|| %s ||: %s ||\n"
+        category_fmt     = '\n= %s =\n'
+        class_fmt        = '\n== %s ==\n'
+        horiz_line       = '\n----\n'
+        docstr_fmt       = '%s'
+    elif output == 'latex':
+        default_arg_fmt  = '%s{\\color{grey}=%s}'
+        func_sig_fmt     = '%s(\\mdseries %s)'
+        function_fmt     = '\n\\paragraph*{\\color{brightblue}{%s}}\n'
+        method_fmt       = '\n\\paragraph*{\\color{brightblue}{%s}}\n'
+        staticmethod_fmt = '\n\\paragraph*{\\color{brightblue}{%s} (static)}\n'
+        dict_fmt         = '\n\\textbf{%s} = $\\lbrace$\n\n'
+        dict_fmt_end     = '$\\rbrace$\n'
+        data_element_fmt = "\n\\textbf{%s} = %s\n"
+        table_begin      = "\\begin{tabular}{lll}\n"
+        table_end        = "\\end{tabular}\n"
+        table_row_fmt    = '& %s & :%s\\\\\n'
+        category_fmt     = '\n\\subsection{%s}\n'
+        class_fmt        = '\n\\subsubsection*{%s}\n'
+        horiz_line       = ''
+        docstr_fmt       = '%s'
+    elif output == 'reportlab_xml':
+        newline          = "<br/>\n"
+        default_arg_fmt  = '%s<font color="gray">=%s</font>'
+        func_sig_fmt     = '<b>%s</b>(%s)'
+        function_fmt     = '\n<para style="FunctionDef"> %s </para>\n'
+        method_fmt       = function_fmt
+        staticmethod_fmt = function_fmt
+        dict_fmt         = '\n\n<para><b>%s</b> = { '
+        dict_fmt_end     = '}</para>\n'
+        data_element_fmt = "<para><b>%s</b> = %s</para>"
+        table_begin      = ''#"<table>["
+        table_end        = ''#"]</table>"
+        #table_row_fmt    = "[ '%s', ':', '%s'],\n"
+        table_row_fmt    = "'%s': %s, "
+        category_fmt     = '\n<para style="Category">%s</para>\n'
+        class_fmt        = '\n<para style="Class">%s</para>\n'
+        horiz_line       = ''
+        docstr_fmt       = '<para>%s</para>'
+    
+    # gather information from the common module
+    logging.info("Gathering information from the common module.")
+    for entry in dir(common):
+        if entry not in exclude:
+            instance = eval('common.%s' % entry)
+            entry_type = type(instance)
+            logging.info('  %-30s %s' % (entry,entry_type))
+            if entry_type in [types.ClassType, types.TypeType]:
+                classes[entry] = { 'methods': [], 'data': [], 'staticmethods': [] }
+                for classentry in dir(instance):
+                    if classentry not in exclude and (classentry[0] != '_' or classentry[0:2] == '__'): # don't include private methods
+                        classentry_type = type(eval('common.%s.%s' % (entry,classentry)))
+                        logging.info('    %-28s %s' % (classentry,classentry_type))
+                        if classentry_type == types.MethodType:
+                            classes[entry]['methods'].append(classentry)
+                        elif classentry_type == types.FunctionType:
+                            classes[entry]['staticmethods'].append(classentry)
+                        else:
+                            classes[entry]['data'].append(classentry)
                     else:
-                        classes[entry]['data'].append(classentry)
+                        logging.info('    %-28s excluded' % classentry)
+            elif  entry_type == types.FunctionType:
+                functions.append(entry)
+            elif entry_type == types.ModuleType:
+                pass
+            else:
+                data.append(entry)
+        else:
+            logging.info('  %-30s excluded' % entry)
+    
+    # output starts here
+    outputStr = ''
+    if output == 'latex':
+        outputStr += '\definecolor{brightblue}{rgb}{0.0,0.38,1.0}\n'
+        outputStr += '\definecolor{paleblue}{rgb}{0.5,0.5,1.0}\n'
+        outputStr += '\definecolor{grey}{rgb}{0.5,0.5,0.5}\n'
+        
+    logging.info("==== FUNCTIONS ====")
+    outputStr += category_fmt % "Functions"
+    for funcname in functions:
+        funcinst = eval('common.%s' % funcname)
+        outputStr += function_fmt % func_sig(funcinst, default_arg_fmt, func_sig_fmt)
+        if funcinst.__doc__:
+            outputStr += docstr_fmt % _(funcinst.__doc__.strip())
+       
+    logging.info("==== CLASSES ====")
+    # sort classes by type:
+    error_classes = {}
+    celltype_classes = {}
+    other_classes = {}
+    for classname in classes.keys():
+        if classname.find('Error') > -1:
+            error_classes[classname] = classes[classname]
+        elif issubclass(eval('common.%s' % classname),common.StandardCellType):
+            celltype_classes[classname] = classes[classname]
+        else:
+            other_classes[classname] = classes[classname]
+    
+    logging.info('Sorting classes...')
+    logging.info('Error classes:    %s' % ', '.join(error_classes.keys()))
+    logging.info('Celltype classes: %s' % ', '.join(celltype_classes.keys()))
+    logging.info('Other classes:    %s' % ', '.join(other_classes.keys()))
+    
+    # Now iterate through the classes
+    outputStr += category_fmt % "Classes"
+    for classes in [celltype_classes, other_classes, error_classes]:
+        classlist = classes.keys()
+        classlist.sort()
+        for classname in classlist:
+            outputStr += class_fmt % classname
+            docstr = eval('common.%s.__doc__' % classname)
+            if docstr:
+                outputStr += docstr_fmt % _(docstr)
+            for methodname in classes[classname]['methods']:
+                methodinst = eval('common.%s.%s' % (classname,methodname))
+                fs = func_sig(methodinst, default_arg_fmt, func_sig_fmt)
+                if fs:
+                    outputStr += method_fmt % fs
+                    if methodinst.__doc__:
+                        outputStr += docstr_fmt % _(methodinst.__doc__.strip())
+            for methodname in classes[classname]['staticmethods']:
+                methodinst = eval('common.%s.%s' % (classname,methodname))
+                fs = func_sig(methodinst, default_arg_fmt, func_sig_fmt)
+                if fs:
+                    outputStr += staticmethod_fmt % fs
+                    if methodinst.__doc__:
+                        outputStr += docstr_fmt % _(methodinst.__doc__.strip())
+            for element in classes[classname]['data']:
+                instance = eval('common.%s.%s' % (classname,element))
+                if type(instance) == types.DictType:
+                    outputStr += dict_fmt % element
+                    if len(instance) > 0:
+                        outputStr += table_begin
+                        for k,v in instance.items():
+                            if output == 'latex':
+                                v = str(v).replace('{',' $\\lbrace$').replace('}',' $\\rbrace$')
+                                outputStr += table_row_fmt % (k,v)
+                            elif output == 'wiki':
+                                outputStr += table_row_fmt % ('&quot;%s&quot;' % k,v)
+                            elif output == 'trac':
+                                outputStr += table_row_fmt % ("'%s'" % k,v)
+                            elif output == 'reportlab_xml':
+                                outputStr += table_row_fmt % ("'%s'" % k,v)
+                        outputStr += table_end
+                    outputStr += dict_fmt_end
                 else:
-                    logging.info('    %-28s excluded' % classentry)
-        elif  entry_type == types.FunctionType:
-            functions.append(entry)
-        elif entry_type == types.ModuleType:
-            pass
+                    outputStr +=  data_element_fmt % (element, instance)
+                    
+            outputStr += horiz_line
+    
+    logging.info("==== DATA ====")
+    outputStr += category_fmt % "Data"
+    for element in data:
+        instance = eval('common.%s' % element)
+        if type(instance) == types.DictType:
+            outputStr += dict_fmt % element
+            outputStr += table_begin
+            for k,v in instance.items():
+                if output == 'latex':
+                    v = str(v).replace('{',' $\\lbrace$').replace('}',' $\\rbrace$')
+                outputStr += table_row_fmt % (k,v)
+            outputStr += table_end
+            outputStr += dict_fmt_end
         else:
-            data.append(entry)
+            outputStr +=  data_element_fmt % (element, instance)
+        
+    if output == 'latex':
+        outputStr = outputStr.replace('_','\_')
+        outputStr = outputStr.replace('>','$>$')
+        outputStr = outputStr.replace('<','$<$')
+        outputStr = leftquote.sub('`',outputStr)
+        outputStr = leftdblquote.sub('``',outputStr)
+    if output == 'trac':
+        outputStr = outputStr.replace('__','!__')
+        outputStr = camelcase.sub(r'!\1',outputStr)
+    
+    return outputStr
+
+# ==============================================================================
+if __name__ == "__main__":
+    
+    #-- Set up logging -------------------------------------------------------------
+    logging.basicConfig(level=logging.DEBUG,
+                        format='%(asctime)s %(levelname)-8s %(message)s',
+                        datefmt='%Y%m%d-%H%M%S',
+                        filename='wikidoc.log',
+                        filemode='w')
+    # define a Handler which writes WARNING messages or higher to the sys.stderr
+    console = logging.StreamHandler()
+    console.setLevel(logging.WARNING)
+    # set a format which is simpler for console use
+    formatter = logging.Formatter('%(message)s')
+    # tell the handler to use this format
+    console.setFormatter(formatter)
+    # add the handler to the root logger
+    logging.getLogger('').addHandler(console)
+    
+    #-- Process command line parameters --------------------------------------------
+    if len(sys.argv) > 1:
+        output = sys.argv[1]
     else:
-        logging.info('  %-30s excluded' % entry)
-
-# output starts here
-outputStr = ''
-if output == 'latex':
-    outputStr += '\definecolor{brightblue}{rgb}{0.0,0.38,1.0}\n'
-    outputStr += '\definecolor{paleblue}{rgb}{0.5,0.5,1.0}\n'
-    outputStr += '\definecolor{grey}{rgb}{0.5,0.5,0.5}\n'
-
-logging.info("==== DATA ====")
-outputStr += category_fmt % "Data"
-for element in data:
-    instance = eval('pyNN.common.%s' % element)
-    if type(instance) == types.DictType:
-        outputStr += dict_fmt % element
-        outputStr += table_begin
-        for k,v in instance.items():
-            if output == 'latex':
-                v = str(v).replace('{',' $\\lbrace$').replace('}',' $\\rbrace$')
-            outputStr += table_row_fmt % (k,v)
-        outputStr += table_end
-        outputStr += dict_fmt_end
-    else:
-        outputStr +=  data_element_fmt % (element, instance)
-    
-logging.info("==== FUNCTIONS ====")
-outputStr += category_fmt % "Functions"
-for funcname in functions:
-    funcinst = eval('pyNN.common.%s' % funcname)
-    outputStr += function_fmt % func_sig(funcinst)
-    if funcinst.__doc__:
-        outputStr += _(funcinst.__doc__.strip())
-   
-logging.info("==== CLASSES ====")
-# sort classes by type:
-error_classes = {}
-celltype_classes = {}
-other_classes = {}
-for classname in classes.keys():
-    if classname.find('Error') > -1:
-        error_classes[classname] = classes[classname]
-    elif issubclass(eval('pyNN.common.%s' % classname),pyNN.common.StandardCellType):
-        celltype_classes[classname] = classes[classname]
-    else:
-        other_classes[classname] = classes[classname]
-
-logging.info('Sorting classes...')
-logging.info('Error classes:    %s' % ', '.join(error_classes.keys()))
-logging.info('Celltype classes: %s' % ', '.join(celltype_classes.keys()))
-logging.info('Other classes:    %s' % ', '.join(other_classes.keys()))
-
-# Now iterate through the classes
-outputStr += category_fmt % "Classes"
-for classes in [celltype_classes, other_classes, error_classes]:
-    classlist = classes.keys()
-    classlist.sort()
-    for classname in classlist:
-        outputStr += class_fmt % classname
-        docstr = eval('pyNN.common.%s.__doc__' % classname)
-        if docstr:
-            outputStr += _(docstr)
-        for methodname in classes[classname]['methods']:
-            methodinst = eval('pyNN.common.%s.%s' % (classname,methodname))
-            fs = func_sig(methodinst)
-            if fs:
-                outputStr += method_fmt % fs
-                if methodinst.__doc__:
-                    outputStr += _(methodinst.__doc__.strip())
-        for methodname in classes[classname]['staticmethods']:
-            methodinst = eval('pyNN.common.%s.%s' % (classname,methodname))
-            fs = func_sig(methodinst)
-            if fs:
-                outputStr += staticmethod_fmt % fs
-                if methodinst.__doc__:
-                    outputStr += _(methodinst.__doc__.strip())
-        for element in classes[classname]['data']:
-            instance = eval('pyNN.common.%s.%s' % (classname,element))
-            if type(instance) == types.DictType:
-                outputStr += dict_fmt % element
-                if len(instance) > 0:
-                    outputStr += table_begin
-                    for k,v in instance.items():
-                        if output == 'latex':
-                            v = str(v).replace('{',' $\\lbrace$').replace('}',' $\\rbrace$')
-                            outputStr += table_row_fmt % (k,v)
-                        elif output == 'wiki':
-                            outputStr += table_row_fmt % ('&quot;%s&quot;' % k,v)
-                        elif output == 'trac':
-                            outputStr += table_row_fmt % ("'%s'" % k,v)
-                    outputStr += table_end
-                outputStr += dict_fmt_end
-            else:
-                outputStr +=  data_element_fmt % (element, instance)
-                
-        outputStr += horiz_line
-    
-if output == 'latex':
-    outputStr = outputStr.replace('_','\_')
-    outputStr = outputStr.replace('>','$>$')
-    outputStr = outputStr.replace('<','$<$')
-    outputStr = leftquote.sub('`',outputStr)
-    outputStr = leftdblquote.sub('``',outputStr)
-if output == 'trac':
-    outputStr = outputStr.replace('__','!__')
-    outputStr = camelcase.sub(r'!\1',outputStr)
-
-print outputStr
+        output = 'wiki'
+    logging.info('Generating API documentation in %s format' % output)
+    print apidoc(output)

branches/0.4/test/VAbenchmarks.py

@@ -23 +23 @@
 
 if len(sys.argv) < 3:
-    print "Usage: python VAbenchmarks.py <simulator> <benchmark>\n\n<simulator> is either neuron, nest1, nest2 or pcsim\n<benchmark> is either CUBA or COBA."
+    print """Usage: python VAbenchmarks.py <simulator> <benchmark>
+    
+    <simulator> is either neuron, nest1, nest2 or pcsim
+    <benchmark> is either CUBA or COBA."""
     sys.exit(1)
 simulator = sys.argv[-2]
@@ -194 +197 @@
 writeCPUTime = Timer.elapsedTime()
 
-tmp_string = "%d e→e  %d e→i  %d i→e  %d i→i" % (len(connections['e2e']), len(connections['e2i']), len(connections['i2e']), len(connections['i2i']))
+tmp_string = "%d e→e  %d e→i  %d i→e  %d i→i" % (len(connections['e2e']), len(connections['e2i']),
+                                                 len(connections['i2e']), len(connections['i2i']))
 
 nprint("\n--- Vogels-Abbott Network Simulation ---")