src/pyams_utils/request.py
changeset 72 9049384a2bd4
parent 23 53a3bfbe6e41
child 100 119b9c2f3022
--- a/src/pyams_utils/request.py	Tue Nov 15 10:43:55 2016 +0100
+++ b/src/pyams_utils/request.py	Fri Nov 18 15:28:54 2016 +0100
@@ -28,7 +28,8 @@
 def get_request(raise_exception=True):
     """Get current request
 
-    Raises a NoInteraction exception if there is no active request"""
+    Raises a NoInteraction exception if there is no active request.
+    """
     request = get_current_request()
     if (request is None) and raise_exception:
         raise MissingRequestError("No request")
@@ -56,13 +57,19 @@
 
 
 def get_annotations(request):
-    """Define 'annotations' request property"""
+    """Define 'annotations' request property
+
+    This function is automatically defined as a custom request method on package include.
+    """
     alsoProvides(request, IAttributeAnnotatable)
     return IAnnotations(request)
 
 
 def get_debug(request):
-    """Define 'debug' request property"""
+    """Define 'debug' request property
+
+    This function is automatically defined as a custom request method on package include.
+    """
     class Debug():
         def __init__(self):
             self.showTAL = False
@@ -71,12 +78,23 @@
 
 
 def get_request_data(request, key, default=None):
-    """Get data associated with request"""
+    """Get data associated with request
+
+    :param request: the request containing requested data
+    :param str key: request data annotation key
+    :param object default: the default value when data is missing
+    :return: the requested value, or *default*
+    """
     annotations = request.annotations
     return annotations.get(key, default)
 
 
 def set_request_data(request, key, value):
-    """Associate data with request"""
+    """Associate data with request
+
+    :param request: the request in which to set data
+    :param str key: request data annotation key
+    :param object value: the value to be set in request annotation
+    """
     annotations = request.annotations
     annotations[key] = value