Changeset 13144 for main/waeup.kofa/trunk/src

Timestamp:

7 Jul 2015, 05:21:14 (9 years ago)

Author:

Henrik Bettermann

Message:

More docs and adjustments in Python code.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• documents/batching.py (modified) (1 diff)
• documents/browser.py (modified) (3 diffs)
• documents/browser_templates/htmldocumentpage.pt (modified) (1 diff)
• documents/export.py (modified) (2 diffs)
• documents/interfaces.py (modified) (1 diff)
• students/export.py (modified) (1 diff)
• university/export.py (modified) (1 diff)

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

@@ -43 +43 @@
 
 class DocumentProcessorBase(BatchProcessor):
-    """A base for batch processors for IDocument objects.
+    """This is the base class for all kinds of document processors.
+    The `checkConversion` method checks whether `class_name` in a row
+    corresponds with the processor chosen. This is to avoid accidentally
+    wrong imports.
     """
     grok.implements(IBatchProcessor)

main/waeup.kofa/trunk/src/waeup/kofa/documents/browser.py

@@ -36 +36 @@
 from waeup.kofa.interfaces import MessageFactory as _
 from waeup.kofa.interfaces import (
-    IContactForm, IKofaObject, IKofaUtils)
+    IContactForm, IKofaObject, IKofaUtils, DOCLINK)
 from waeup.kofa.browser.layout import (
     KofaPage, KofaEditFormPage, KofaAddFormPage, KofaDisplayFormPage,
@@ -82 +82 @@
     pnav = 2
     label = _('Documents')
+    doclink = DOCLINK + '/documents.html'
 
 
@@ -164 +165 @@
     grok.template('documentpage')
     pnav = 2
+    doclink = DOCLINK + '/documents.html'
 
     @property

main/waeup.kofa/trunk/src/waeup/kofa/documents/browser_templates/htmldocumentpage.pt

@@ -35 +35 @@
       </td>
       <td>
-        &lt;a href=&quot;
-        <span tal:replace="python: view.url(context, 'display')"></span>
-        &quot;&gt;<span tal:replace="context/title">FILENAME</span>&lt;/a&gt;
+        &lt;a href=&quot;<span tal:replace="python: view.url(context, 'display')"></span>&quot;&gt;<span tal:replace="context/title">
+        FILENAME
+        </span>&lt;/a&gt;
       </td>
     </tr>

main/waeup.kofa/trunk/src/waeup/kofa/documents/export.py

@@ -29 +29 @@
 
 class DocumentExporterBase(grok.GlobalUtility, ExporterBase):
-    """Exporter for documents.
+    """This is the exporter base class for all kinds of document exporters.
+    Derived classes export all documents of type `class_name` inside the
+    documents container.
+
+    All schema fields and the property attributes
+    `history`, `state`, `class_name` and `users_with_local_roles`
+    are being exported.
     """
     grok.implements(ICSVExporter)
@@ -51 +57 @@
 
     def mangle_value(self, value, name, context=None):
-        """Hook for mangling values in derived classes
+        """The mangler prepares the history messages and computes the
+        `users_with_local_roles` value which is a Python expression like:
+
+        ``[{'user_name': u'bob', 'local_role': u'bobsrole'},
+        {'user_name': u'anna', 'local_role': u'annasrole'}]``
         """
         if name == 'users_with_local_roles':

main/waeup.kofa/trunk/src/waeup/kofa/documents/interfaces.py

@@ -38 +38 @@
     history = Attribute('Object history, a list of messages')
     state = Attribute('Workflow state of a document')
+    class_name = Attribute('Name of the document class')
+
+    local_roles = Attribute('List of local role names')
+    translated_class_name = Attribute('Translatable class name of a document')
     translated_state = Attribute('Translatable workflow state of a document')
-    class_name = Attribute('Name of the document class')
-    translated_class_name = Attribute('Translatable class name of a document')
     formatted_transition_date = Attribute(
         'Last transition formatted date string')
     form_fields_interface = Attribute(
         'Interface which is used in forms for grok.AutoFields')
-    local_roles = Attribute('List of local role names')
 
     document_id = schema.TextLine(

main/waeup.kofa/trunk/src/waeup/kofa/students/export.py

@@ -315 +315 @@
 
 class CourseTicketExporter(grok.GlobalUtility, StudentExporterBase):
-    """The Course Ticket  Exporter exports course tickets. Usually,
+    """The Course Ticket Exporter exports course tickets. Usually,
     the exporter first filters the set of students by searching the
     students catalog. Then it collects and iterates over all ``studylevel``

main/waeup.kofa/trunk/src/waeup/kofa/university/export.py

@@ -37 +37 @@
 
     def mangle_value(self, value, name, context=None):
-        """The mangler computes the users_with_local_roles value which
+        """The mangler computes the `users_with_local_roles` value which
         is a Python expression like: