Some clean-up in CGIWrapper.

Author: Cito

CGIWrapper/AdminPage.py

@@ -56,7 +56,7 @@ def writeHeader(self):
         self.writeToolbar()
 
     def writeBody(self):
-        raise NotImplementedError, 'Should be overridden in a subclass'
+        raise NotImplementedError('Should be overridden in a subclass')
 
     def writeFooter(self):
         self.writeln('''
@@ -75,10 +75,10 @@ def bodyTags(self):
     def writeBanner(self):
         self.writeln('''
         <table align="center" bgcolor="#202080" cellpadding="5" cellspacing="0" width="100%%">
-                <tr><td align="center" style="color:white;font-weight:bold;font-family:Tahoma,Verdana,Arial,Helvetica,sans-serif">
-                        <div style="font-size:14pt">CGI Wrapper</div>
-                        <div style="font-size:16pt">%s</div>
-                </td></tr>
+            <tr><td align="center" style="color:white;font-weight:bold;font-family:Tahoma,Verdana,Arial,Helvetica,sans-serif">
+                <div style="font-size:14pt">CGI Wrapper</div>
+                <div style="font-size:16pt">%s</div>
+            </td></tr>
         </table>''' % self.title())
 
     def writeToolbar(self):

CGIWrapper/CGIWrapper.py

@@ -102,7 +102,7 @@ This is where the wrapper always looks for the CGI scripts. This location would
 
 <dl>
 <dt><b>ChangeDir</b>
-&nbsp; <code> = 1</code></dt>
+&nbsp; <code> = True</code></dt>
 <dd>
 If true, the current working directory is changed to the same directory as the target script. Otherwise, the current working directory is left alone and likely to be the same as the CGI Wrapper.
 </dd>
@@ -126,7 +126,7 @@ This is the index into <code>sys.path</code> where the <code>ExtraPath</code> va
 
 <dl>
 <dt><b>LogScripts</b>
-&nbsp; <code> = 1</code></dt>
+&nbsp; <code> = True</code></dt>
 <dd>
 If true, then the execution of each script is logged with useful information such as time, duration and whether or not an error occurred.
 </dd>
@@ -161,7 +161,7 @@ This is the list of class names that CGI Wrapper looks for after executing a scr
 
 <dl>
 <dt><b>ShowDebugInfoOnErrors</b>
-&nbsp; <code> = 1</code></dt>
+&nbsp; <code> = True</code></dt>
 <dd>
 If true, then the uncaught exceptions will not only display a message for the user, but debugging information for the developer as well. This includes the traceback, HTTP headers, CGI form fields, environment and process ids.
 </dd>
@@ -177,7 +177,7 @@ This is the error message that is displayed to the user when an uncaught excepti
 
 <dl>
 <dt><b>LogErrors</b>
-&nbsp; <code> = 1</code></dt>
+&nbsp; <code> = True</code></dt>
 <dd>
 If true, then CGI Wrapper logs exceptions. Each entry contains the date &amp; time, filename, pathname, exception name &amp; data, and the HTML error message filename (assuming there is one).
 </dd>
@@ -193,7 +193,7 @@ This is the name of the file where CGI Wrapper logs exceptions if <code>LogError
 
 <dl>
 <dt><b>SaveErrorMessages</b>
-&nbsp; <code> = 1</code></dt>
+&nbsp; <code> = True</code></dt>
 <dd>
 If true, then errors (e.g., uncaught exceptions) will produce an HTML file with both the user message and debugging information. Developers/administrators can view these files after the fact, to see the details of what went wrong.
 </dd>
@@ -209,7 +209,7 @@ This is the name of the directory where HTML error messages get stored if <code>
 
 <dl>
 <dt><b>EmailErrors</b>
-&nbsp; <code> = 0</code></dt>
+&nbsp; <code> = False</code></dt>
 <dd>
 If true, error messages are e-mail out according to the ErrorEmailServer and ErrorEmailHeaders settings. This setting defaults to false because the other settings need to be configured first.
 </dd>
@@ -273,8 +273,8 @@ A list of IP addresses or networks from which admin scripts can be accessed.
 
 <p>The resulting page will look something like the following. (Note: Those links aren't real!)</p>
 
-<table cellspacing="2" align="center">
-<tr><th align="right">Size</th><th rowspan="8">&nbsp;</th><th align="left">Script</th><th rowspan="8">&nbsp;</th><th align="left">View</th></tr>
+<table cellspacing="0" cellpadding="4" border="1" align="center">
+<tr><th align="right">Size</th><th align="left">Script</th><th align="left">View</th></tr>
 <tr><td align="right">96</td><td><a href="Hello">Hello</a></td><td><a href="View?filename=Hello">view</a></td></tr>
 <tr><td align="right">167</td><td><a href="Time">Time</a></td><td><a href="View?filename=Time">view</a></td></tr>
 <tr><td align="right">210</td><td><a href="Error">Error</a></td><td><a href="View?filename=Error">view</a></td></tr>

CGIWrapper/Docs/UsersGuide.phtml

@@ -1,5 +1,5 @@
 
-if fields.has_key('bgcolor'):
+if 'bgcolor' in fields:
     bgcolor = fields['bgcolor'].value
     bgcolorArg = 'bgcolor="%s"' % bgcolor
 else:
@@ -8,17 +8,17 @@
 
 print '''<!DOCTYPE HTML SYSTEM>
 <html>
-        <head>
-                <title>Colors</title>
-        </head>
-        <body %s>
-                <h1 align="center">Colors</h1>
-                <center>
-                <form action="Colors">
-                        bgcolor: <input type="text" name="bgcolor" value="%s">
-                        <input type="submit" value="Go">
-                </form>
-                <table cellspacing="2" cellpadding="2">
+    <head>
+        <title>Colors</title>
+    </head>
+    <body %s>
+        <h1 align="center">Colors</h1>
+        <center>
+        <form action="Colors">
+            bgcolor: <input type="text" name="bgcolor" value="%s">
+            <input type="submit" value="Go">
+        </form>
+        <table cellspacing="2" cellpadding="2">
 ''' % (bgcolorArg, bgcolor)
 
 space = '&nbsp;'*10
@@ -35,15 +35,12 @@
             # Compute brightness given RGB
             brightness = (0.3*r**gamma + 0.6*g**gamma + 0.1*b**gamma)**(1/gamma)
             # We then use brightness to determine a good font color for high contrast
-            if brightness < 0.5:
-                textcolor = 'white'
-            else:
-                textcolor = 'black'
+            textcolor = brightness < 0.5 and 'white' or 'black'
             print '<td style="color:%s;background-color:%s;">%s</td>' % (textcolor, color, color)
         print '</tr>'
 
 print '''
-                </table>
-                </center>
-        </body>
+        </table>
+        </center>
+    </body>
 </html>'''

CGIWrapper/Examples/Colors.py

@@ -1,52 +1,42 @@
 import os
+from operator import itemgetter
 from stat import ST_SIZE
 
 print '''%s
 <html>
-        <head>
-                <title>Webware CGI Examples Directory</title>
-        </head>
-        <body>
-                <h1 align="center">Webware CGI Examples</h1>
+    <head>
+        <title>Webware CGI Examples Directory</title>
+    </head>
+    <body>
+        <h1 align="center">Webware CGI Examples</h1>
 ''' % wrapper.docType()
 
-def sizeSorter(a, b):
-    """Sort by size
-
-    Used for sorting when the elements are dictionaries and the
-    attribute to sort by is 'size'.
-
-    """
-    return int(a['size'] - b['size'])
-
 # Create a list of dictionaries, where each dictionary stores information about
 # a particular script.
-scripts = []
-for filename in os.listdir(os.curdir):
-    if len(filename) > 3 and filename[-3:] == '.py':
-        script = {}
-        script['pathname']  = filename
-        script['size']      = os.stat(script['pathname'])[ST_SIZE]
-        script['shortname'] = filename[:-3]
-        scripts.append(script)
-scripts.sort(sizeSorter)
+scripts = sorted((dict(pathname=filename,
+    shortname=filename[:-3], size=os.stat(filename)[ST_SIZE])
+    for filename in os.listdir(os.curdir)
+    if len(filename) > 3 and filename.endswith('.py')),
+    key=itemgetter('size'))
 
-print '<table cellspacing="2" cellpadding="2" align="center">'
-print '<tr>',
-print '<th align="right">Size</th>',
-print '<th align="left">Script</th>',
-print '<th align="left">View</th>',
-print '</tr>'
 
-for script in scripts:
-    print '<tr>',
-    print '<td align=right> %d </td>' % script['size'],
-    print '<td> <a href="%s">%s</a> </td>' % (script['shortname'], script['shortname']),
-    print '<td> <a href="View?filename=%s">view</a> </td>' % script['shortname'],
-    print '</tr>'
-
-print '</table>'
+print '''\
+        <table cellspacing="0" cellpadding="4" border="1" align="center">
+            <tr>
+                <th align="right">Size</th>
+                <th align="left">Script</th>
+                <th align="left">View</th>
+            </tr>'''
 
-print '''
-        </body>
+for script in scripts:
+    print '''\
+            <tr>
+                <td align=right>%(size)d</td>
+                <td><a href="%(shortname)s">%(shortname)s</a></td>
+                <td><a href="View?filename=%(shortname)s">view</a></td>
+            </tr>''' % script
+
+print '''\
+        </table>
+    </body>
 </html>'''

CGIWrapper/Examples/Directory.py

@@ -1,9 +1,8 @@
 """Error.py
 
-This program specifically imports a module with an unknown name,
-which causes Python to throw an exception.  Consequently, you can
-see how CGI Wrapper handles errors.
+This program causes Python to throw an exception.
+Consequently, you can see how CGI Wrapper handles errors.
 
 """
 
-import UnknownModuleName
+raise StandardError('Error example')

CGIWrapper/Examples/Error.py

@@ -1,11 +1,11 @@
 
 print '''%s
 <html>
-        <head>
-                <title>Hello, word!</title>
-        </head>
-        <body>
-                <h1 align="center">Hello, World!</h1>
-                <p align="center">This is CGI Wrapper %s speaking...</p>
-        </body>
+    <head>
+        <title>Hello, word!</title>
+    </head>
+    <body>
+        <h1 align="center">Hello, World!</h1>
+        <p align="center">This is CGI Wrapper %s speaking...</p>
+    </body>
 </html>''' % (wrapper.docType(), wrapper.version())

CGIWrapper/Examples/Hello.py

@@ -1,17 +1,15 @@
 
 print '''%s
 <html>
-        <head>
-                <title>Python Introspection</title>
-        </head>
-        <body>
-                <h2>Basic Python Introspection</h2>
+    <head>
+        <title>Python Introspection</title>
+    </head>
+    <body>
+        <h2>Basic Python Introspection</h2>
 ''' % wrapper.docType()
 
 def printKeys(name, obj):
-    keys = obj.keys()
-    keys.sort()
-    print '<p> <b>%s</b> = %s' % (name, ', '.join(keys))
+    print '<p> <b>%s</b> = %s' % (name, ', '.join(sorted(obj)))
 
 printKeys('globals', globals())
 printKeys('locals', locals())
@@ -21,8 +19,8 @@ def printKeys(name, obj):
 printKeys('wrapper.__dict__', wrapper.__dict__)
 
 print '''
-                <hr>
-                <p>Note that the <a href="Error">Error</a> script
-                results in a much better display of introspection.</p>
-        </body>
+        <hr>
+        <p>Note that the <a href="Error">Error</a> script
+        results in a much better display of introspection.</p>
+    </body>
 </html>'''

CGIWrapper/Examples/Introspect.py

@@ -3,11 +3,11 @@
 
 print '''%s
 <html>
-        <head>
-                <title>Time</title>
-        </head>
-        <body>
-        <h3>Current Time</h3>
-        <p>%s</p>
-        </body>
-</html>''' % (wrapper.docType(), time.asctime(time.localtime(time.time())))
+    <head>
+        <title>Time</title>
+    </head>
+    <body>
+    <h3>Current Time</h3>
+    <p>%s</p>
+    </body>
+</html>''' % (wrapper.docType(), time.asctime(time.localtime()))

CGIWrapper/Examples/Time.py

@@ -2,21 +2,23 @@
 
 print '''%s
 <html>
-        <head>
-                <title>Webware View CGI Source</title>
-        </head>
-        <body>
-                <h1>Webware View CGI Source</h1>
+    <head>
+        <title>Webware View CGI Source</title>
+    </head>
+    <body>
+        <h1>Webware View CGI Source</h1>
 ''' % wrapper.docType()
 
 if not fields.has_key('filename'):
     print '<p>No filename specified.</p>'
 else:
-    if fields.has_key('tabSize'):
+    if 'tabSize' in fields:
         tabSize = int(fields['tabSize'].value)
     else:
         tabSize = 4
-    filename = os.path.basename(fields['filename'].value) + '.py'
+    filename = os.path.basename(fields['filename'].value)
+    if not filename.endswith('.py'):
+        fielname += '.py'
     try:
         contents = open(filename).read()
     except IOError:

CGIWrapper/Examples/View.py

@@ -3,7 +3,7 @@
 version = ('X', 'Y', 0)
 
 docs = [
-        {'name': "User's Guide", 'file': 'UsersGuide.html'},
+{'name': "User's Guide", 'file': 'UsersGuide.html'},
 ]
 
 status = 'stable'

CGIWrapper/Properties.py

@@ -4,10 +4,10 @@
 
 print '''%s
 <html>
-        <head>
-                <title>Access denied</title>
-        </head>
-        <body>
-                <h1>Access denied</h1>
-        </body>
+    <head>
+        <title>Access denied</title>
+    </head>
+    <body>
+        <h1>Access denied</h1>
+    </body>
 </html>''' % wrapper.docType()