Changeset 32880

Timestamp:

Dec 7, 2011, 11:07:47 AM (15 years ago)

Author:

Serge CHASTEL

Message:

Documentation + constants

Location:

trunk/ippdor/src/ipp

Files:

• CamManager.py (modified) (2 diffs)
• constants/Camera.py (modified) (3 diffs)
• constants/Chip.py (modified) (1 diff)

trunk/ippdor/src/ipp/CamManager.py

@@ -95 +95 @@
             (exp_tag, cam_id, camera, state, workdir, reduction, dvodb) = camera
             if len(cameras) > 1:
-                body = CameraConstants.email_body_multiple_cam_entries % (self.label, 
+                body = CameraConstants.EMAIL_BODY_MULTIPLE_CAM_ENTRIES % (self.label, 
                                                                           self.exposure_name, 
                                                                           cam_id)
@@ -165 +165 @@
             # Send e-mail to recipient
             print 'Default for exposure [%s] at cam level' % (self.exposure_name)
-            body = CameraConstants.email_body_revert_failure % (self.exposure_name,
+            body = CameraConstants.EMAIL_BODY_REVERT_FAILURE % (self.exposure_name,
                                                                 self.label, 
                                                                 self.exposure_name)

trunk/ippdor/src/ipp/constants/Camera.py

@@ -3 +3 @@
 framework are defined for the Camera stage. 
 
-It defines the following data members:
-TODO: list defined constants
+It defines the following constants:
+- REQUIREMENTS: The Condor requirements to run Cam jobs
+- EMAIL_BODY_MULTIPLE_CAM_ENTRIES: The e-mail body when there is more
+  than one cam entry for one chip (Note: it seems it was useful when
+  chiptool has a bug but it seems to be fixed now (see svn log for
+  revision 32520))
+- EMAIL_BODY_REVERT_FAILURE: The e-mail body which is sent when revert
+  has failed
 """
 from ipp.exceptions.UninstantiableIppException import UninstantiableIppException
@@ -19 +25 @@
     REQUIREMENTS = GlobalConstants.REQUIREMENTS
 
-    email_body_multiple_cam_entries = """Hi,
+    # Body of the e-mail which is sent when there is more than one cam
+    # entry for one chip (Note: it seems it was useful when chiptool
+    # has a bug but it seems to be fixed now (see svn log for revision
+    # 32520)).
+    # It is expected to valuate this expression with 3 parameters:
+    # - #1: label (str)
+    # - #2: exposure name (str)
+    # - #3: cam_id (int)
+    EMAIL_BODY_MULTIPLE_CAM_ENTRIES = """Hi,
 
 this is an e-mail generated by the ippdor subsystem.
@@ -31 +45 @@
 Thanks,
 """
-    email_body_revert_failure = """Hi,
+    # Body of the e-mail which is sent when revert has failed. It is
+    # expected to valuate this expression with 3 parameters:
+    # - #1: exposure name (str)
+    # - #2: label (str)
+    # - #3: exposure name (str)
+    EMAIL_BODY_REVERT_FAILURE = """Hi,
 
 this is an e-mail generated by the ippdor subsystem.

trunk/ippdor/src/ipp/constants/Chip.py

@@ -9 +9 @@
 - EMAIL_BODY_FAILED_REVERT: The e-mail body which is sent when revert
   has failed
-- 
+ 
 """
 from ipp.exceptions.UninstantiableIppException import UninstantiableIppException