Changeset 59a1d4a for server/lib/gutenbach/server/requests.py

Timestamp:

Dec 20, 2011, 3:20:13 PM (12 years ago)

Author:

Jessica B. Hamrick <jhamrick@…>

Branches:

no-cups

Children:

aef164a

Parents:

ef8df33

git-author:

Jessica B. Hamrick <jhamrick@…> (12/20/11 15:20:13)

git-committer:

Jessica B. Hamrick <jhamrick@…> (12/20/11 15:20:13)

Message:

A litte bit of documentation

File:

• server/lib/gutenbach/server/requests.py (modified) (9 diffs)

server/lib/gutenbach/server/requests.py

@@ -73 +73 @@
 
         """
-        
+
+        # verify the request and get an attribute dictionary
         req_dict = ipp.ops.verify_get_jobs_request(request)
+
+        # lookup printer name
         printer_name = req_dict['printer-uri']
         if printer_name not in self.printers:
@@ -81 +84 @@
                 [request.attribute_groups[0].attributes[2]])
 
-        # Each job will append a new job attribute group.
+        # get the job attributes
         jobs = [job.get_job_attributes(request) for job in \
                 self.printers[printer_name].get_jobs()]
+
+        # build the response
         response = ipp.ops.make_get_jobs_response(jobs, request)
         return response
@@ -143 +148 @@
         """
 
-        # this is just like cups_get_default, except the printer name
-        # is given
+        # verify the request and get the attributes dictionary
         req_dict = ipp.ops.verify_get_printer_attributes_request(request)
+
+        # lookup the printer name
         printer_name = req_dict['printer-uri']
         if printer_name not in self.printers:
@@ -151 +157 @@
                 "Invalid printer uri: %s" % printer_name,
                 [request.attribute_groups[0].attributes[2]])
-        
+
+        # bulid response
         response = ipp.ops.make_get_printer_attributes_response(
             self.printers[printer_name].get_printer_attributes(request), request)
@@ -171 +178 @@
 
     def get_job_attributes(self, request):
+        
+        # verify the request and get the attributes dictionary
         req_dict = ipp.ops.verify_get_jobs_request(request)
+        
+        # lookup the printer name
         printer_name = req_dict['printer-uri']
-        job_id = req_dict['job-id']
-        
         if printer_name not in self.printers:
             raise ipp.errors.Attributes(
                 "Invalid printer uri: %s" % printer_name,
                 [request.attribute_groups[0].attributes[2]])
-        try:
-            job = self.printers[printer_name].get_job(job_id)
+
+        # lookup the job id
+        job_id = req_dict['job-id']
+        try: job = self.printers[printer_name].get_job(job_id)
         except InvalidJobException:
             raise ipp.errors.Attributes(
@@ -186 +197 @@
                 [request.attribute_groups[0].attributes[2]]) # XXX: this is wrong
 
-        # Each job will append a new job attribute group.
         # XXX: we need to honor the things that the request actually asks for
+        # build the response
         response = ipp.ops.make_get_job_attributes_response(
             job.get_job_attributes(request), request)
@@ -215 +226 @@
         """
 
+        # verify the request and get the attributes dictionary
         req_dict = ipp.ops.verify_cups_get_default_request(request)
+        # build the response
         response = ipp.ops.make_get_printer_attributes_response(
             self.printers[self.default].get_printer_attributes(request), request)
@@ -231 +244 @@
         """
 
+        # verify the request and get the attributes dictionary
         req_dict = ipp.ops.verify_cups_get_printers_request(request)
+        # get the printer attributes
         attrs = [self.printers[printer].get_printer_attributes(request) \
                  for printer in self.printers]
+        # build the response
         response = ipp.ops.make_cups_get_printers_response(attrs, request)
         return response
@@ -248 +264 @@
         """
 
+        # verify the request and get the attributes dictionaryu
         req_dict = ipp.ops.verify_cups_get_classes_request(request)
+        # build the response
         response = ipp.ops.make_cups_get_classes_response(request)
         return response