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

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/applicants/batching.py (modified) (5 diffs)

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

@@ -35 +35 @@
 
 class ApplicantsContainerProcessor(BatchProcessor):
-    """A processor for applicants containers.
+    """The Applicants Container Processor imports containers for applicants.
+    It does not import their content. There is nothing special about this
+    processor.
     """
     grok.implements(IBatchProcessor)
@@ -76 +78 @@
 
 class ApplicantProcessor(BatchProcessor):
-    """A batch processor for IApplicant objects.
-
-    In create mode container_code is required. If application_number is given
-    an applicant with this number is created in the designated container.
-    If application_number is not given a random application_number is assigned.
-    applicant_id is being determined by the system and can't be imported.
-
-    In update or remove mode container_code and application_number columns
-    must not exist. The applicant object is solely searched by its applicant_id
-    or reg_number.
+    """The Applicant Processor imports application records (applicants).
+
+    In create mode `container_code` is required. If `application_number` is
+    given, an applicant with this number is created in the designated container.
+    If `application_number` is not given, a random `application_number` is
+    assigned. `applicant_id` is being determined by the system and can't be
+    imported.
+
+    In update or remove mode `container_code` and `application_number` columns
+    must not exist. The applicant object is solely localized by
+    `applicant_id` or `reg_number`.
     """
     grok.implements(IBatchProcessor)
@@ -95 +98 @@
     iface = IApplicant
     iface_byregnumber = IApplicantUpdateByRegNo
-    location_fields = ['']
     factory_name = 'waeup.Applicant'
 
@@ -303 +305 @@
         if cert is not None and (mode in ('create', 'update')):
             # course1 application category must match container's.
-            parent = self.getParent(row, self.site)
+            site = grok.getSite()
+            parent = self.getParent(row, site)
             if parent is None:
                 errs.append(('container', 'not found'))
@@ -332 +335 @@
             return 'Applicant is blocked.'
         return None
-
-    def doImport(self, *args, **kw):
-        # XXX: Not thread-safe.  Parallel applicant imports into
-        # different sites could mean a mess.  Luckily this is not a
-        # typical use-case. On the other hand it spares thousands of
-        # site lookups during large imports.
-        # XXX: Maybe this should go into Importer base.
-        self.site = grok.getSite() # needed by checkConversion()
-        return super(ApplicantProcessor, self).doImport(*args, **kw)