Changeset 12857 for main/waeup.kofa/trunk/src/waeup/kofa/university

Timestamp:

15 Apr 2015, 14:28:46 (9 years ago)

Author:

Henrik Bettermann

Message:

Documentation work in progress.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/university/export.py (modified) (6 diffs)

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

@@ -25 +25 @@
 
 class FacultyExporter(grok.GlobalUtility, ExporterBase):
-    """Exporter for faculties.
+    """The FacultyExporter exports all faculties in the 'faculties'
+    container. This is the only place where faculties are stored.
     """
     grok.implements(ICSVExporter)
     grok.name('faculties')
 
-    #: Fieldnames considered by this exporter
     fields = ('code', 'title', 'title_prefix', 'users_with_local_roles')
 
-    #: The title under which this exporter will be displayed
     title = _(u'Faculties')
 
     def mangle_value(self, value, name, context=None):
-        """Hook for mangling values in derived classes
+        """The users_with_local_roles column contains 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':
             value = []
             role_map = IPrincipalRoleMap(context)
-            for local_role, user_name, setting in role_map.getPrincipalsAndRoles():
+            for local_role, user_name, setting in \
+                role_map.getPrincipalsAndRoles():
                 value.append({'user_name':user_name,'local_role':local_role})
         return super(FacultyExporter, self).mangle_value(
@@ -49 +52 @@
     def export(self, faculties, filepath=None):
         """Export `faculties`, an iterable, as CSV file.
-
         If `filepath` is ``None``, a raw string with CSV data is returned.
         """
@@ -59 +61 @@
     def export_all(self, site, filepath=None):
         """Export faculties in facultycontainer into filepath as CSV data.
-
         If `filepath` is ``None``, a raw string with CSV data is returned.
         """
@@ -75 +76 @@
         'users_with_local_roles')
 
-    #: The title under which this exporter will be displayed
     title = _(u'Departments')
 
@@ -90 +90 @@
     def export_all(self, site, filepath=None):
         """Export departments in faculty into filepath as CSV data.
-
         If `filepath` is ``None``, a raw string with CSV data is returned.
         """
@@ -115 +114 @@
 
     def mangle_value(self, value, name, context=None):
-        """Hook for mangling values in derived classes
+        """
         """
         if name == 'users_with_local_roles':
             value = []
             role_map = IPrincipalRoleMap(context)
-            for local_role, user_name, setting in role_map.getPrincipalsAndRoles():
+            for local_role, user_name, setting in \
+                role_map.getPrincipalsAndRoles():
                 value.append({'user_name':user_name,'local_role':local_role})
         elif name == 'faculty_code':