sphinx-compatible docstrings

gluon/restricted.py

@@ -2,9 +2,12 @@
 # -*- coding: utf-8 -*-
 
 """
-This file is part of the web2py Web Framework
-Copyrighted by Massimo Di Pierro <mdipierro@cs.depaul.edu>
-License: LGPLv3 (http://www.gnu.org/licenses/lgpl.html)
+| This file is part of the web2py Web Framework
+| Copyrighted by Massimo Di Pierro <mdipierro@cs.depaul.edu>
+| License: LGPLv3 (http://www.gnu.org/licenses/lgpl.html)
+
+Restricted environment to execute application's code
+-----------------------------------------------------
 """
 
 import sys
@@ -26,7 +29,7 @@ __all__ = ['RestrictedError', 'restricted', 'TicketStorage', 'compile2']
 class TicketStorage(Storage):
 
     """
-    defines the ticket object and the default values of its members (None)
+    Defines the ticket object and the default values of its members (None)
     """
 
     def __init__(
@@ -40,7 +43,7 @@ class TicketStorage(Storage):
 
     def store(self, request, ticket_id, ticket_data):
         """
-        stores the ticket. It will figure out if this must be on disk or in db
+        Stores the ticket. It will figure out if this must be on disk or in db
         """
         if self.db:
             self._store_in_db(request, ticket_id, ticket_data)
@@ -51,12 +54,12 @@ class TicketStorage(Storage):
         self.db._adapter.reconnect()
         try:
             table = self._get_table(self.db, self.tablename, request.application)
-            id = table.insert(ticket_id=ticket_id,
+            table.insert(ticket_id=ticket_id,
                          ticket_data=cPickle.dumps(ticket_data),
                          created_datetime=request.now)
             self.db.commit()
             message = 'In FILE: %(layer)s\n\n%(traceback)s\n'
-        except Exception, e:
+        except Exception:
             self.db.rollback()
             message =' Unable to store in FILE: %(layer)s\n\n%(traceback)s\n'
         self.db.close()
@@ -111,8 +114,8 @@ class TicketStorage(Storage):
 
 class RestrictedError(Exception):
     """
-    class used to wrap an exception that occurs in the restricted environment
-    below. the traceback is used to log the exception and generate a ticket.
+    Class used to wrap an exception that occurs in the restricted environment
+    below. The traceback is used to log the exception and generate a ticket.
     """
 
     def __init__(
@@ -123,7 +126,7 @@ class RestrictedError(Exception):
         environment=None,
     ):
         """
-        layer here is some description of where in the system the exception
+        Layer here is some description of where in the system the exception
         occurred.
         """
         if environment is None:
@@ -148,7 +151,7 @@ class RestrictedError(Exception):
 
     def log(self, request):
         """
-        logs the exception.
+        Logs the exception.
         """
 
         try:
@@ -168,7 +171,7 @@ class RestrictedError(Exception):
 
     def load(self, request, app, ticket_id):
         """
-        loads a logged exception.
+        Loads a logged exception.
         """
         ticket_storage = TicketStorage(db=request.tickets_db)
         d = ticket_storage.load(request, app, ticket_id)
@@ -201,8 +204,8 @@ def compile2(code, layer):
 
 def restricted(code, environment=None, layer='Unknown'):
     """
-    runs code in environment and returns the output. if an exception occurs
-    in code it raises a RestrictedError containing the traceback. layer is
+    Runs code in environment and returns the output. If an exception occurs
+    in code it raises a RestrictedError containing the traceback. Layer is
     passed to RestrictedError to identify where the error occurred.
     """
     if environment is None: