[Repoze-dev] Repoze CVS: publisher.py

[Tres Seaver]

Update of /home/repoze/cvs/repoze.obob/repoze/obob
In directory laguna.palladion.com:/tmp/cvs-serv17163/repoze/obob

Modified Files:
	publisher.py 
Log Message:
 - Add helper API docs.

Index: publisher.py
===================================================================
RCS file: /home/repoze/cvs/repoze.obob/repoze/obob/publisher.py,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- publisher.py	12 Sep 2007 23:27:21 -0000	1.9
+++ publisher.py	12 Sep 2007 23:47:50 -0000	1.10
@@ -13,29 +13,68 @@
         self.environ = environ
 
     def setup(self):
+        """ Perform any initializtion require before request processing.
+        
+        @return None
+        """
         pass
 
     def path_elements(self):
+        """ Compute the list of path elements to be traversed.
+        
+        @return list elements       Path elements
+        """
         return [x for x in self.environ['PATH_INFO'].split('/') if x.strip()]
 
     def before_traverse(self, current, name):
+        """ Called before traversing each path element.
+        
+        @param object current       Object being traversed
+        @param object name          Name of next object
+        @return None
+        """
         pass
 
     def traverse(self, current, name):
+        """ Traverse the next path element.
+        
+        @param object current       Object being traversed
+        @param object name          Name of next object
+        @return object              Next object in traversal chain
+        """
         return current[name]
 
     def before_invoke(self, published):
+        """ Called just before invoking the published object.
+        
+        @param object publishe      Published object (end of traversal chain)
+        @return None
+        """
         pass
 
     def invoke(self, published):
+        """ Invoke the published object.
+        
+        @param object publishe      Published object (end of traversal chain)
+        @return object              Result of call
+        """
         return published()
 
     def map_result(self, result):
+        """ Map the call result onto a triple for WSGI.
+        
+        @param object result        Result of calling published object
+        @return tuple               WSGI triple: (status, headers, body_iter)
+        """
         if isinstance(result, basestring):
             result = [result]
         return '200 OK', [('Content-Type', 'text/html')], result
 
     def teardown(self):
+        """ Perform any cleanup required end of request processing
+        
+        @return None
+        """
         pass
 
 

_______________________________________________
Repoze-dev mailing list
Repoze-dev at lists.repoze.org
http://lists.repoze.org/mailman/listinfo/repoze-dev