Changeset 12868 for main/waeup.kofa/trunk/src/waeup/kofa

Timestamp:

21 Apr 2015, 20:56:58 (10 years ago)

Author:

Henrik Bettermann

Message:

More docs.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• browser/batchprocessing.txt (modified) (1 diff)
• students/tests/test_batching.py (modified) (3 diffs)
• university/tests/test_batching.py (modified) (4 diffs)
• utils/batching.py (modified) (4 diffs)
• utils/batching.txt (modified) (2 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/browser/batchprocessing.txt

@@ -574 +574 @@
     >>> print open(pending_file).read()
     title_prefix,code,title,--ERRORS--
-    faculty,FAC1,Faculty 1,This object already exists. Skipping.
+    faculty,FAC1,Faculty 1,This object already exists.
     faculty,FAC 5,Faculty 5,code: Invalid input
 

main/waeup.kofa/trunk/src/waeup/kofa/students/tests/test_batching.py

@@ -548 +548 @@
             '2,Aaren,C123456,m,aa@aa.ng,1234,admitted,1990-01-04,Berson,mypw1,100000,matric_number: Invalid input\r\n'
             '1,Frank,F123456,m,aa@aa.ng,1234,,1990-01-06,Meyer,,100000,reg_number: Invalid input; matric_number: Invalid input\r\n'
-            '3,Uli,A123456,m,aa@aa.ng,1234,,1990-01-07,Schulz,,100002,This object already exists. Skipping.\r\n'
+            '3,Uli,A123456,m,aa@aa.ng,1234,,1990-01-07,Schulz,,100002,This object already exists.\r\n'
             )
         shutil.rmtree(os.path.dirname(fin_file))
@@ -891 +891 @@
         self.assertEqual(fail_file,
             'reg_number,code,mandatory,level,level_session,score,matric_number,--ERRORS--\r\n'
-            '1,COURSE1,,nonsense,,5,,Not all parents do exist yet. Skipping\r\n'
+            '1,COURSE1,,nonsense,,5,,Not all parents do exist yet.\r\n'
             '1,NONSENSE,,100,,5,,code: non-existent\r\n'
             '1,COURSE1,,200,2004,6,,level_session: does not match 2008\r\n'
@@ -1176 +1176 @@
             '1,942,online,BTECHBDT,2010/11/26 19:59:33.744 GMT+1,0,'
             '19500,schoolfee,19500,2015,paid,'
-            'Same payment has already been made. Skipping.'
+            'Same payment has already been made.'
             in content)
         shutil.rmtree(os.path.dirname(fin_file))

main/waeup.kofa/trunk/src/waeup/kofa/university/tests/test_batching.py

@@ -448 +448 @@
             'local_roles: user_name or local_role missing\r\n'
             'FAC11,DEP2,"[{\'user_name\':\'anne\',\'local_role\':\'waeup.local.DepartmentManager\'}]",'
-            'Not all parents do exist yet. Skipping\r\n'
+            'Not all parents do exist yet.\r\n'
             )
         # Anne got a local role in department DEP2.
@@ -537 +537 @@
             'local_roles: user_name or local_role missing\r\n'
             'FAC11,DEP2,CRS2,"[{\'user_name\':\'anne\',\'local_role\':\'waeup.local.Lecturer\'}]",'
-            'Not all parents do exist yet. Skipping\r\n'
+            'Not all parents do exist yet.\r\n'
             )
         # Anne got a local role in course CRS2.
@@ -636 +636 @@
             'local_roles: user_name or local_role missing\r\n'
             'FAC11,DEP2,CRT2,"[{\'user_name\':\'anne\',\'local_role\':\'waeup.local.CourseAdviser100\'}]",'
-            'Not all parents do exist yet. Skipping\r\n'
+            'Not all parents do exist yet.\r\n'
             )
         # Anne got a local role in certificate CRT2.
@@ -726 +726 @@
             'faculty_code,course,level,department_code,certificate_code,'
             '--ERRORS--\r\nFAC1,CRS1,100,DEP1,CRT1,'
-            'This object already exists. Skipping.\r\nFAC1,CRS1,100,DEP1,CRT2,'
-            'Not all parents do exist yet. Skipping\r\n'
+            'This object already exists.\r\nFAC1,CRS1,100,DEP1,CRT2,'
+            'Not all parents do exist yet.\r\n'
 
             )

main/waeup.kofa/trunk/src/waeup/kofa/utils/batching.py

@@ -298 +298 @@
         1. An empty row is skipped.
 
-        2. Empty strings are replaced by ignore-markers.
-
-        3. The `BatchProcessor.checkConversion` method validates all 
-           values in the row. If the validation fails
-
-        4.
-
-        5.
-
-        6.
+        2. Empty strings in the row are replaced by ignore-markers.
+
+        3. The `BatchProcessor.checkConversion` method validates and converts 
+           all values in the row. Conversion means the transformation of strings
+           into Python objects. For instance, number expressions have to be
+           transformed into integers, dates into datetime objects, phone number
+           expressions into phone number objects, etc. The converter returns a
+           dictionary with converted values or, if the validation of one of the
+           elements fails, an appropriate warning message. If the conversion
+           fails a pending record is created and stored in the pending data file
+           together with a warning message the converter has raised.
+
+        4. In **create mode** only:
+
+           The parent object must be found and a child
+           object with same object id must not exist. Otherwise the row
+           is skipped, a corresponding warning message is raised and a
+           record is stored in the pending data file.
+
+           Now ``doImport`` tries to add the new object with the data 
+           from the conversion dictionary. In some cases this
+           may fail and a DuplicationError is raised. For example, a new
+           payment ticket is created but the same payment for same session
+           has already been made. In this case the object id is unique, no
+           other object with same id exists, but making the 'same' payment
+           twice does not make sense. The import is skipped and a
+           record is stored in the pending data file.
+
+        5. In **update mode** only:
+
+           If the object can't be found, the row is skipped,
+           a ``no such entry`` warning message is raised and a record is
+           stored in the pending data file.
+
+           The `BatchProcessor.checkUpdateRequirements` method checks additional
+           requirements the object must fulfill before being updated. These
+           requirements are not imposed by the data type but the context
+           of the object. For example, post-graduate students have a different
+           registration workflow. With this method we do forbid certain workflow
+           transitions or states. 
+
+           Finally, ``doImport`` updates the existing object with the data
+           from the conversion dictionary.
+
+        6. In **remove mode** only:
+
+           If the object can't be found, the row is skipped,
+           a ``no such entry`` warning message is raised and a record is
+           stored in the pending data file.
+
+           Finally, ``doImport`` removes the existing object.
 
         """
@@ -364 +405 @@
                     self.writeFailedRow(
                         failed_writer, string_row,
-                        "Not all parents do exist yet. Skipping")
+                        "Not all parents do exist yet.")
                     continue
                 if self.entryExists(row, site):
@@ -370 +411 @@
                     self.writeFailedRow(
                         failed_writer, string_row,
-                        "This object already exists. Skipping.")
+                        "This object already exists.")
                     continue
                 obj = self.callFactory()
@@ -382 +423 @@
                     num_warns += 1
                     self.writeFailedRow(
-                        failed_writer, string_row,
-                        "%s Skipping." % error.message)
+                        failed_writer, string_row, error.message)
                     continue
                 except DuplicationError, error:
                     num_warns += 1
                     self.writeFailedRow(
-                        failed_writer, string_row,
-                        "%s Skipping." % error.msg)
+                        failed_writer, string_row, error.msg)
                     continue
             elif mode == 'remove':

main/waeup.kofa/trunk/src/waeup/kofa/utils/batching.txt

@@ -309 +309 @@
     >>> print open(result[3]).read()
     owner,name,taxpayer,dinoports,--ERRORS--
-    Barney,Barneys Home,1,2,This object already exists. Skipping.
-    Wilma,Wilmas Asylum,1,1,This object already exists. Skipping.
-    Fred,Freds Dinoburgers,0,10,This object already exists. Skipping.
-    Joey,Joeys Drive-in,0,110,This object already exists. Skipping.
+    Barney,Barneys Home,1,2,This object already exists.
+    Wilma,Wilmas Asylum,1,1,This object already exists.
+    Fred,Freds Dinoburgers,0,10,This object already exists.
+    Joey,Joeys Drive-in,0,110,This object already exists.
 
 This way we can correct the faulty entries and afterwards retry without
@@ -350 +350 @@
     >>> print open(result[3], 'rb').read()
     name,dinoports,--ERRORS--
-    Barneys Home,2,This object already exists. Skipping.
-    Wilmas Asylum,1,This object already exists. Skipping.
-    Freds Dinoburgers,10,This object already exists. Skipping.
-    Joeys Drive-in,110,This object already exists. Skipping.
+    Barneys Home,2,This object already exists.
+    Wilmas Asylum,1,This object already exists.
+    Freds Dinoburgers,10,This object already exists.
+    Joeys Drive-in,110,This object already exists.