Add documentation
authorMikko Värri <vmj@linuxbox.fi>
Sun, 19 Sep 2010 20:46:49 +0000 (23:46 +0300)
committerMikko Värri <vmj@linuxbox.fi>
Sun, 19 Sep 2010 20:46:49 +0000 (23:46 +0300)
recycloid_api/views.py

index 85eaeb8..6e7a422 100644 (file)
@@ -119,6 +119,13 @@ def __limit(request, queryset):
 
 
 def __response(request, context):
+    """
+    Determines the format of the response and returns that.
+
+    :param request: HttpRequest
+    :param context: context
+    :return: HttpResponse
+    """
     mimetype, encoding = __response_format(request)
     if mimetype:
         return render_to_response(response_template[mimetype], context, mimetype=mimetype)
@@ -131,7 +138,7 @@ def __add(obj, key, reg, context):
     Adds obj to context if it is not there already.
 
     :param obj:  recycloid_models.models.IdentifiedModel instance
-    :param key:  
+    :param key:  'servers', 'owners', ... The key under which to add the object into context
     :param reg:  dict where to register which objects have been added to context
     :param objs:  list where to add obj, unless it already is there
     """
@@ -145,27 +152,74 @@ def __add(obj, key, reg, context):
     return
 
 def __add_owner_related(owner, reg, context):
+    """
+    Adds stash owner related objects to the context. I.e. the server.
+
+    :param owner: recycloid_models.models.StashOwner instance
+    :param reg: dict where to register which objects have been added to context
+    :param context: context
+    :return: None
+    """
     __add(owner.server, 'servers', reg, context)
     return
 
 def __add_stash_related(stash, reg, context):
+    """
+    Adds stash related objects to the context.  I.e. the stash owner
+    (and those related to that owner) and the stash server.
+
+    :param stash: recycloid_models.models.Stash instance
+    :param reg: dict where to register which objects have been added to context
+    :param context: context
+    :return: None
+    """
     __add_owner_related(stash.owner, reg, context)
     __add(stash.server, 'servers', reg, context)
     __add(stash.owner, 'owners', reg, context)
     return
 
 def __add_item_related(item, reg, context):
+    """
+    Adds stash item related objects to the context.  I.e. the stash
+    and those related to that stash.
+
+    :param item: recycloid_models.models.StashItem instance
+    :param reg: dict where to register which objects have been added to context
+    :param context: context
+    :return: None
+    """
     __add_stash_related(item.stash, reg, context)
     __add(item.stash, 'stashes', reg, context)
     return
 
 def __add_image_related(image, reg, context):
+    """
+    Adds stash item image related objects to the context. I.e. the
+    item and those related to that item.
+
+    :param image: recycloid_models.models.StashItemImage instance
+    :param reg: dict where to register which objects have been added to context
+    :param context: context
+    :return: None
+    """
     __add_item_related(image.item, reg, context)
     __add(image.item, 'items', reg, context)
     return
 
 
 def __object_list_response(request, objects, name, add_related_func):
+    """
+    Returns a list of objects (the objects QuerySet), possibly slicing
+    that list to a requested page (the 'offset' and 'limit' request
+    parameters), and possibly adding any referenced objects to the
+    response.
+
+    :param request: HttpRequest
+    :param objects: QuerySet
+    :param name: 'servers', 'owners', 'stashes', 'items', or 'images'
+    :param add_related_func: Function that can add the referenced objects
+    :return: HttpRequest
+    """
     # [TODO] Search
 
     if add_related_func: