Changeset 12164 for main/waeup.ikoba/trunk

Timestamp:

7 Dec 2014, 19:48:03 (10 years ago)

Author:

Henrik Bettermann

Message:

Add some comments to emphasize that we usually attach only one file to each document.

File:

• main/waeup.ikoba/trunk/src/waeup/ikoba/customers/documents.py (modified) (5 diffs)

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

@@ -67 +67 @@
     grok.baseclass()
 
+    # Ikoba can store any number of files per Document object.
+    # However, we highly recommend to associate and store
+    # only one file per Document object. Thus the following 
+    # tuple should contain only a single filename string.
     filenames = ()
 
@@ -113 +117 @@
         files = []
         try:
+            # Usually there is only a single element in self.filenames.
             for filename in self.filenames:
                 attrname = filename.replace('.','_')
@@ -124 +129 @@
 
     def setMD5(self):
-        """Set md5 checksum attribute for all files connected to this document.
+        """Set md5 checksum attribute for files connected to this document.
         """
         connected_files = self.connected_files
@@ -139 +144 @@
     """
 
+    # Ikoba can store any number of files per Document object.
+    # However, we highly recommend to associate and store
+    # only one file per Document object. Thus the following
+    # tuple should contain only a single filename string.
     filenames = ('sample',)
 
@@ -150 +159 @@
     grok.provides(ICustomerPDFDocument)
 
+    # Ikoba can store any number of files per Document object.
+    # However, we highly recommend to associate and store
+    # only one file per Document object. Thus the following
+    # tuple should contain only a single filename string.
+    filenames = ('sample.pdf',)
+
 CustomerPDFDocument = attrs_to_fields(CustomerPDFDocument)
 
 
-# Customer documents must be importable. So we might need a factory.
+# Customer documents must be importable. So we need a factory.
 class CustomerDocumentFactory(grok.GlobalUtility):
     """A factory for customer documents.