Changeset 12281 for main/waeup.ikoba/trunk/src/waeup/ikoba/customers/batching.py

Timestamp:

21 Dec 2014, 10:35:54 (10 years ago)

Author:

Henrik Bettermann

Message:

Reorganize batch processor classes to ease customization.

File:

• main/waeup.ikoba/trunk/src/waeup/ikoba/customers/batching.py (modified) (10 diffs)

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/batching.py

@@ -43 +43 @@
 from waeup.ikoba.customers.interfaces import (
     ICustomer, ICustomerUpdateByRegNo,
-    ICustomerDocument, IContract, ISampleContract)
+    ICustomerSampleDocument, ISampleContract)
 from waeup.ikoba.customers.workflow import  (
     IMPORTABLE_REGISTRATION_STATES, IMPORTABLE_REGISTRATION_TRANSITIONS)
@@ -366 +366 @@
         return result
 
-class CustomerDocumentProcessor(CustomerProcessorBase):
-    """A batch processor for ICustomerDocument objects.
+class CustomerDocumentProcessorBase(CustomerProcessorBase):
+    """A batch processor for customer documents.
+
+    This is a baseclass.
     """
     grok.implements(IBatchProcessor)
     grok.provides(IBatchProcessor)
     grok.context(Interface)
-    util_name = 'customerdocumentprocessor'
-    grok.name(util_name)
-
-    name = _('CustomerDocument Processor')
-    iface = ICustomerDocument
-    factory_name = 'waeup.CustomerSampleDocument'
+
+    grok.baseclass()
+
+    util_name = None
+    name = None
+    iface = None
+    factory_name = None
 
     location_fields = []
@@ -384 +387 @@
 
     def checkHeaders(self, headerfields, mode='ignore'):
-        super(CustomerDocumentProcessor, self).checkHeaders(headerfields)
+        super(CustomerDocumentProcessorBase, self).checkHeaders(headerfields)
         if mode in ('update', 'remove') and not 'document_id' in headerfields:
             raise FatalCSVError(
@@ -412 +415 @@
         if 'document_id' in row and row['document_id'] in (None, IGNORE_MARKER):
             row.pop('document_id')
-        items_changed = super(CustomerDocumentProcessor, self).updateEntry(
+        items_changed = super(CustomerDocumentProcessorBase, self).updateEntry(
             obj, row, site, filename)
         customer = self.getParent(row, site).__parent__
@@ -440 +443 @@
         """
         errs, inv_errs, conv_dict = super(
-            CustomerDocumentProcessor, self).checkConversion(row, mode=mode)
+            CustomerDocumentProcessorBase, self).checkConversion(row, mode=mode)
         # We need to check if the class_name corresponds with the
         # processor chosen. This is to avoid accidentally wrong imports.
@@ -450 +453 @@
 
 
-class ContractProcessor(CustomerProcessorBase):
-    """A batch processor for IContract objects.
+class CustomerSampleDocumentProcessor(CustomerDocumentProcessorBase):
+    """A batch processor for ICustomerSampleDocument objects.
+    """
+    util_name = 'customersampledocumentprocessor'
+    grok.name(util_name)
+
+    name = _('Customer Sample Document Processor')
+    iface = ICustomerSampleDocument
+    factory_name = 'waeup.CustomerSampleDocument'
+
+
+class ContractProcessorBase(CustomerProcessorBase):
+    """A batch processor for contracts.
+
+    This is a baseclass.
     """
     grok.implements(IBatchProcessor)
     grok.provides(IBatchProcessor)
     grok.context(Interface)
-    util_name = 'contractprocessor'
-    grok.name(util_name)
-
-    name = _('Contract Processor')
-    iface = ISampleContract
-    factory_name = 'waeup.SampleContract'
+
+    grok.baseclass()
+
+    util_name = None
+    name = None
+    iface = None
+    factory_name = None
 
     location_fields = []
@@ -468 +485 @@
 
     def checkHeaders(self, headerfields, mode='ignore'):
-        super(ContractProcessor, self).checkHeaders(headerfields)
+        super(ContractProcessorBase, self).checkHeaders(headerfields)
         if mode in ('update', 'remove') and not 'contract_id' in headerfields:
             raise FatalCSVError(
@@ -499 +516 @@
         if 'contract_id' in row and row['contract_id'] in (None, IGNORE_MARKER):
             row.pop('contract_id')
-        items_changed = super(ContractProcessor, self).updateEntry(
+        items_changed = super(ContractProcessorBase, self).updateEntry(
             obj, row, site, filename)
         customer = self.getParent(row, site).__parent__
@@ -527 +544 @@
         """
         errs, inv_errs, conv_dict = super(
-            ContractProcessor, self).checkConversion(row, mode=mode)
+            ContractProcessorBase, self).checkConversion(row, mode=mode)
         # We need to check if the class_name corresponds with the
         # processor chosen. This is to avoid accidentally wrong imports.
@@ -535 +552 @@
                 errs.append(('class_name','wrong processor'))
         return errs, inv_errs, conv_dict
+
+
+class SampleContractProcessor(ContractProcessorBase):
+    """A batch processor for ISampleContract objects.
+    """
+    util_name = 'samplecontractprocessor'
+    grok.name(util_name)
+
+    name = _('Sample Contract Processor')
+    iface = ISampleContract
+    factory_name = 'waeup.SampleContract'