Changeset 12869 for main/waeup.kofa/trunk/src/waeup/kofa/utils

Timestamp:

22 Apr 2015, 19:14:14 (10 years ago)

Author:

Henrik Bettermann

Message:

Start documenting batch processors.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/utils/batching.py (modified) (7 diffs)

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

@@ -56 +56 @@
 
     # Internal name...
-    util_name = 'baseprocessor'
+    util_name = ''
 
     # Items for this processor need an interface with zope.schema fields.
@@ -66 +66 @@
 
     # Headers needed to locate items...
-    location_fields = ['code', 'faculty_code']
+    location_fields = []
 
     # A factory with this name must be registered...
-    factory_name = 'waeup.Department'
+    factory_name = ''
 
     @property
@@ -128 +128 @@
     def applyMapping(self, row, mapping):
         """Apply mapping to a row of CSV data.
-
         """
         result = dict()
@@ -284 +283 @@
     def doImport(self, path, headerfields, mode='create', user='Unknown',
                  logger=None, ignore_empty=True):
-        """In contrast to most other methods, ``doImport`` is not supposed to
+        """In contrast to most other methods, `doImport` is not supposed to
         be customized, neither in custom packages nor in derived batch
         processor classes. Therefore, this is the only place where we
@@ -317 +316 @@
            record is stored in the pending data file.
 
-           Now ``doImport`` tries to add the new object with the data 
+           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
+           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
@@ -339 +338 @@
            transitions or states. 
 
-           Finally, ``doImport`` updates the existing object with the data
+           Finally, `doImport` updates the existing object with the data
            from the conversion dictionary.
 
@@ -348 +347 @@
            stored in the pending data file.
 
-           Finally, ``doImport`` removes the existing object.
+           Finally, `doImport` removes the existing object.
 
         """