Changeset 9734

Timestamp:

28 Nov 2012, 01:14:33 (12 years ago)

Author:

uli

Message:

Try to make clearer where we head to regarding filtered exports.

Location:

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

Files:

• students/export.py (modified) (3 diffs)
• students/interfaces.py (modified) (1 diff)
• students/tests/test_export.py (modified) (4 diffs)
• university/department.py (modified) (4 diffs)
• utils/batching.py (modified) (1 diff)

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

@@ -34 +34 @@
                   'coursetickets', 'studentpayments')
 
-def get_students(site):
+class StudentsExportFilter(object):
+    """A filter to find students that match certain criteria.
+
+    The filter is meant as a component to aggregate search parameters
+    for students. This way we can tell some exporter to use 'this
+    filter' instead of passing in all (probably different) parameters.
+
+    Just an idea right now. There might be better ways.
+    """
+
+    def __init__(self, session=None, level=None,
+                 faculty_code=None, department_code=None):
+        self.session = session
+        self.level = level
+        self.faculty_code = faculty_code
+        self.department_code = department_code
+        return
+
+    def get_students(self, catalog):
+        students = catalog.searchResults(
+            student_id=(None, None),
+            current_session=(self.session, self.session),
+            #level=(self.level, self.level), # would be nice
+            faccode=(self.faculty_code, self.faculty_code),
+            depcode=(self.department_code, self.department_code)
+            )
+        # filter out by level
+        if self.level is not None:
+            return [x for x in students
+                    if x['studycourse'].current_level == self.level]
+        return students
+
+def get_students(site, stud_filter=None):
     """Get all students registered in catalog in `site`.
     """
@@ -41 +73 @@
     if catalog is None:
         return []
-    students = catalog.searchResults(student_id=(None, None))
+    if stud_filter is None:
+        students = catalog.searchResults(student_id=(None, None))
+    else:
+        students = stud_filter.get_students(catalog)
     return students
 
@@ -104 +139 @@
             self.write_item(value, writer)
         return self.close_outfile(filepath, outfile)
+
+    def export_filtered(self, site, session, level, faculty_code=None,
+                        department_code=None, filepath=None):
+        pass
 
 

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

@@ -751 +751 @@
         """Export data for a given student.
         """
+
+    def export_filtered(site, session, level, faculty_code=None,
+                        department_code=None, filepath=None):
+        """Export filtered set of students.
+        """

main/waeup.kofa/trunk/src/waeup/kofa/students/tests/test_export.py

@@ +1 @@
+import grok
 import datetime
 from zope.component import queryUtility
+from zope.event import notify
 from zope.interface.verify import verifyObject, verifyClass
 from waeup.kofa.interfaces import ICSVExporter
@@ -6 +8 @@
     StudentsExporter, StudentStudyCourseExporter, StudentStudyLevelExporter,
     CourseTicketExporter, PaymentsExporter, BedTicketsExporter,
-    StudentPaymentsOverviewExporter)
+    StudentPaymentsOverviewExporter, get_students, StudentsExportFilter)
+from waeup.kofa.students.accommodation import BedTicket
+from waeup.kofa.students.interfaces import ICSVStudentExporter
 from waeup.kofa.students.payments import StudentOnlinePayment
-from waeup.kofa.students.accommodation import BedTicket
+from waeup.kofa.students.student import Student
 from waeup.kofa.students.studycourse import StudentStudyCourse
 from waeup.kofa.students.studylevel import StudentStudyLevel, CourseTicket
@@ -18 +22 @@
 year_range_str = ','.join([str(i) for i in year_range])
 
+class ExportHelperTests(StudentImportExportSetup):
+    layer = FunctionalLayer
+    def setUp(self):
+        super(ExportHelperTests, self).setUp()
+        student = Student()
+        self.app['students'].addStudent(student)
+        student = self.setup_student(student)
+        notify(grok.ObjectModifiedEvent(student))
+        self.student = self.app['students'][student.student_id]
+        return
+
+    def test_get_students_plain(self):
+        # without a filter we get all students
+        result = get_students(self.app)
+        self.assertEqual(len(list(result)), 1)
+        return
+
+    def test_get_students_by_session(self):
+        # we can filter out students of a certain session
+        my_filter1 = StudentsExportFilter(session=2012)
+        result = get_students(self.app, stud_filter=my_filter1)
+        self.assertEqual(len(list(result)), 1)
+
+        my_filter2 = StudentsExportFilter(session=1964)
+        result = get_students(self.app, stud_filter=my_filter2)
+        self.assertEqual(len(list(result)), 0)
+        return
+
+    def test_get_students_by_level(self):
+        # we can filter out students of a certain level
+        my_filter1 = StudentsExportFilter(level=200)
+        result = get_students(self.app, stud_filter=my_filter1)
+        self.assertEqual(len(list(result)), 1)
+
+        my_filter2 = StudentsExportFilter(level=300)
+        result = get_students(self.app, stud_filter=my_filter2)
+        self.assertEqual(len(list(result)), 0)
+        return
 
 class StudentsExporterTest(StudentImportExportSetup):
@@ -31 +73 @@
         # make sure we fullfill interface contracts
         obj = StudentsExporter()
-        verifyObject(ICSVExporter, obj)
-        verifyClass(ICSVExporter, StudentsExporter)
+        verifyObject(ICSVStudentExporter, obj)
+        verifyClass(ICSVStudentExporter, StudentsExporter)
         return
 

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

@@ -19 +19 @@
 """
 import grok
+import zope.location.location
 from zope.component.interfaces import IFactory
 from zope.interface import implementedBy
@@ -24 +25 @@
 from waeup.kofa.university.coursescontainer import CoursesContainer
 from waeup.kofa.university.certificatescontainer import CertificatesContainer
+from waeup.kofa.utils.batching import VirtualExportJobContainer
 from waeup.kofa.interfaces import IKofaUtils
 from waeup.kofa.university.interfaces import IDepartment, IDepartmentAdd
@@ -68 +70 @@
         elif name == 'certificates':
             return self.certificates
+        elif name == 'exports':
+            # create a virtual exports container and return it
+            container = VirtualExportJobContainer()
+            zope.location.location.located(container, self, 'exports')
+            return container
         return None
 
@@ -75 +82 @@
             insttypes_dict[self.title_prefix],
             self.title, self.code)
-
 
 class DepartmentFactory(grok.GlobalUtility):

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

@@ -410 +410 @@
         outfile = StringIO()
         writer = csv.DictWriter(outfile, self.available_fields)
-        writer.writerow(dict(zip(self.available_fields, self.available_fields))) # header
+        writer.writerow(
+            dict(zip(self.available_fields, self.available_fields))) # header
         outfile.seek(0)
         return outfile.read()