Changeset 32879 for trunk

Timestamp:

Dec 7, 2011, 11:00:18 AM (15 years ago)

Author:

Serge CHASTEL

Message:

Documentation + constants

Location:

trunk/ippdor/src/ipp

Files:

• ChipManager.py (modified) (2 diffs)
• constants/Chip.py (modified) (3 diffs)

trunk/ippdor/src/ipp/ChipManager.py

@@ -203 +203 @@
         if len(chips) != 0:
             # Send e-mail to recipient
-            body = ChipConstants.email_body_failed_revert.replace('@COUNT_FAILED_CHIPS@',
+            body = ChipConstants.EMAIL_BODY_FAILED_REVERT.replace('@COUNT_FAILED_CHIPS@',
                                                                   len(chips))
             body = body.replace('@LABEL@', self.label)
@@ -224 +224 @@
                                                                            class_id)
             body = body.replace('@CHIPTOOL_UPDATEPROCESSEDIMFILE@', updateprocessedimfile)
-            self.send_email('Chip stage failed for label %s / exposure %s)' % (self.label, 
-                                                                               self.exposure_name), 
+            self.send_email(ChipConstants.EMAIL_SUBJECT_FAILED_REVERT % (self.label, 
+                                                                         self.exposure_name), 
                             body % (GlobalConstants.LOCAL_TMP_DIR))
             print 'EMail sent to [%s]' % self.recipient

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

@@ -3 +3 @@
 framework are defined for the chip stage.
 
-It defines the following data members:
-TODO: list defined constants
+It defines the following constants:
+- REQUIREMENTS: The Condor requirements to run Chip jobs
+- EMAIL_SUBJECT_FAILED_REVERT: The e-mail subject which is sent when
+  revert has failed
+- EMAIL_BODY_FAILED_REVERT: The e-mail body which is sent when revert
+  has failed
+- 
 """
 from ipp.exceptions.UninstantiableIppException import UninstantiableIppException
@@ -17 +22 @@
 
     REQUIREMENTS = 'LoadAvg < 0.3'
-    email_subject = ''
 
-    # This is the e-mail body which is sent when revert as
+    # This is the e-mail body which is sent when revert has failed. It
+    # is expected to valuate this expression with two parameters:
+    # - #1: The label (string)
+    # - #2: The exposure name (string)
+    EMAIL_SUBJECT_FAILED_REVERT = 'Chip stage failed for label %s / exposure %s)'
+
+    # This is the e-mail body which is sent when revert has
     # failed. Some values need to be replaced, namely:
     # - @COUNT_FAILED_CHIPS@: the number of chips which have failed;
@@ -32 +42 @@
     # It is also expected to valuate this expression with one argument:
     # - #1: The path to Globals.LOCAL_TMP_DIR
-    email_body_failed_revert = """Hi,
+    EMAIL_BODY_FAILED_REVERT = """Hi,
 
 this is an e-mail generated by the ippdor subsystem.