Changeset 438 for trunk/packages/sipb-xen-www

Timestamp:

Apr 21, 2008, 7:22:21 PM (17 years ago)

Author:

ecprice

Message:

Remove extraneous whitespace and add documentation

File:

• trunk/packages/sipb-xen-www/code/main.py (modified) (21 diffs)

trunk/packages/sipb-xen-www/code/main.py

@@ -60 +60 @@
 def helppopup(subj):
     """Return HTML code for a (?) link to a specified help topic"""
-    return ('<span class="helplink"><a href="help?subject=' + subj + 
-            '&amp;simple=true" target="_blank" ' + 
+    return ('<span class="helplink"><a href="help?subject=' + subj +
+            '&amp;simple=true" target="_blank" ' +
             'onclick="return helppopup(\'' + subj + '\')">(?)</a></span>')
 
@@ -143 +143 @@
         raise InvalidInput('name', name,
                            "Name already exists.")
-    
+
     owner = validation.testOwner(user, fields.getfirst('owner'))
 
     memory = fields.getfirst('memory')
     memory = validation.validMemory(owner, memory, on=True)
-    
+
     disk_size = fields.getfirst('disk')
     disk_size = validation.validDisk(owner, disk_size)
@@ -162 +162 @@
     if clone_from and clone_from != 'ice3':
         raise CodeError("Invalid clone image '%s'" % clone_from)
-    
+
     return dict(contact=user, name=name, memory=memory, disk_size=disk_size,
                 owner=owner, machine_type=vm_type, cdrom=cdrom, clone_from=clone_from)
@@ -187 +187 @@
 
 def getListDict(user):
+    """Gets the list of local variables used by list.tmpl."""
     machines = g.machines
     checkpoint.checkpoint('Got my machines')
@@ -229 +230 @@
     checkpoint.checkpoint('Got list dict')
     return templates.list(searchList=[d])
-            
+
 def vnc(user, fields):
     """VNC applet page.
@@ -241 +242 @@
 
     -t nat -A PREROUTING -s ! 18.181.0.60 -i eth1 -p tcp -m tcp \
-      --dport 10003 -j DNAT --to-destination 18.181.0.60:10003 
+      --dport 10003 -j DNAT --to-destination 18.181.0.60:10003
     -t nat -A POSTROUTING -d 18.181.0.60 -o eth1 -p tcp -m tcp \
-      --dport 10003 -j SNAT --to-source 18.187.7.142 
+      --dport 10003 -j SNAT --to-source 18.187.7.142
     -A FORWARD -d 18.181.0.60 -i eth1 -o eth1 -p tcp -m tcp \
       --dport 10003 -j ACCEPT
@@ -251 +252 @@
     """
     machine = validation.testMachineId(user, fields.getfirst('machine_id'))
-    
+
     TOKEN_KEY = "0M6W0U1IXexThi5idy8mnkqPKEq1LtEnlK/pZSn0cDrN"
 
@@ -264 +265 @@
     token = cPickle.dumps(token)
     token = base64.urlsafe_b64encode(token)
-    
+
     status = controls.statusInfo(machine)
     has_vnc = hasVnc(status)
-    
+
     d = dict(user=user,
              on=status,
@@ -277 +278 @@
 
 def getHostname(nic):
+    """Find the hostname associated with a NIC.
+
+    XXX this should be merged with the similar logic in DNS and DHCP.
+    """
     if nic.hostname and '.' in nic.hostname:
         return nic.hostname
@@ -318 +323 @@
     for disk in machine.disks:
         name = disk.guest_device_name
-        disk_fields.extend([(x % name, y % name) for x, y in 
+        disk_fields.extend([(x % name, y % name) for x, y in
                             disk_fields_template])
         data_dict['%s_size' % name] = "%0.1f GiB" % (disk.size / 1024.)
@@ -353 +358 @@
 
 def modifyDict(user, fields):
+    """Modify a machine as specified by CGI arguments.
+
+    Return a list of local variables for modify.tmpl.
+    """
     olddisk = {}
     transaction = ctx.current.create_transaction()
@@ -370 +379 @@
             memory = validation.validMemory(user, memory, machine, on=False)
             machine.memory = memory
- 
+
         disksize = validation.testDisk(user, fields.getfirst('disk'))
         if disksize is not None:
@@ -379 +388 @@
                 disk.size = disksize
                 ctx.current.save(disk)
-        
+
         if owner is not None:
             machine.owner = owner
@@ -388 +397 @@
         if contact is not None:
             machine.contact = contact
-            
+
         ctx.current.save(machine)
         transaction.commit()
@@ -401 +410 @@
                 command=command,
                 machine=machine)
-    
+
 def modify(user, fields):
     """Handler for modifying attributes of a machine."""
@@ -420 +429 @@
     info_dict['result'] = result
     return templates.info(searchList=[info_dict])
-    
+
 
 def helpHandler(user, fields):
@@ -426 +435 @@
     simple = fields.getfirst('simple')
     subjects = fields.getlist('subject')
-    
+
     help_mapping = dict(paravm_console="""
 ParaVM machines do not support local console access over VNC.  To
@@ -461 +470 @@
 """
                    )
-    
+
     if not subjects:
         subjects = sorted(help_mapping.keys())
-        
+
     d = dict(user=user,
              simple=simple,
              subjects=subjects,
              mapping=help_mapping)
-    
+
     return templates.help(searchList=[d])
-    
+
 
 def badOperation(u, e):
+    """Function called when accessing an unknown URI."""
     raise CodeError("Unknown operation")
 
 def infoDict(user, machine):
+    """Get the variables used by info.tmpl."""
     status = controls.statusInfo(machine)
     checkpoint.checkpoint('Getting status info')
@@ -523 +534 @@
     nic_fields = getNicInfo(machine_info, machine)
     nic_point = display_fields.index('NIC_INFO')
-    display_fields = (display_fields[:nic_point] + nic_fields + 
+    display_fields = (display_fields[:nic_point] + nic_fields +
                       display_fields[nic_point+1:])
 
     disk_fields = getDiskInfo(machine_info, machine)
     disk_point = display_fields.index('DISK_INFO')
-    display_fields = (display_fields[:disk_point] + disk_fields + 
+    display_fields = (display_fields[:disk_point] + disk_fields +
                       display_fields[disk_point+1:])
-    
+
     main_status['memory'] += ' MiB'
     for field, disp in display_fields:
@@ -584 +595 @@
 
 def printHeaders(headers):
+    """Print a dictionary as HTTP headers."""
     for key, value in headers.iteritems():
         print '%s: %s' % (key, value)
@@ -594 +606 @@
     return username
 
-def main(operation, user, fields):    
+def main(operation, user, fields):
     start_time = time.time()
     fun = mapping.get(operation, badOperation)