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

Timestamp:

20 Apr 2015, 17:32:55 (10 years ago)

Author:

Henrik Bettermann

Message:

Backup work in progress.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/utils/batching.py (modified) (1 diff)

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

@@ -284 +284 @@
     def doImport(self, path, headerfields, mode='create', user='Unknown',
                  logger=None, ignore_empty=True):
-        """Perform actual import.
+        """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
+        do import data.
+
+        Before this method starts creating or updating persistent data, it
+        prepares two more files in a temporary folder of the filesystem: (1)
+        a file for pending data with file extension ``.pending`` and (2)
+        a file for successfully processed data with file extension
+        ``.finished``. Then the method starts iterating over all rows of
+        the CSV file. Each row is treated as follows:
+
+        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.
+
         """
         time_start = time.time()