Changeset 12515 for main/waeup.kofa/trunk/src/waeup/kofa/students/reports

Timestamp:

24 Jan 2015, 18:30:11 (10 years ago)

Author:

Henrik Bettermann

Message:

Student statistic can now be broken down by faculties or by departments.

Location:

main/waeup.kofa/trunk/src/waeup/kofa/students/reports

Files:

• browser_templates/studentstatisticsreportgeneratorpage.pt (modified) (1 diff)
• student_statistics.py (modified) (10 diffs)
• tests/test_student_statistics.py (modified) (6 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/students/reports/browser_templates/studentstatisticsreportgeneratorpage.pt

@@ -6 +6 @@
     to view/download.
   </p>
+  <br />
+  <label for="breakdown" i18n:translate="">Breakdown</label>
+    <select name="breakdown" class="form-control half">
+      <span tal:repeat="items view/breakdowns" tal:omit-tag="">
+        <option
+            tal:define="name python: items[1]; title python: items[0]"
+            tal:attributes="value name">
+          <span tal:replace="title">TITLE</span>
+        </option>
+      </span>
+    </select>
   <br />
   <label for="session" i18n:translate="">Study Modes Group</label>

main/waeup.kofa/trunk/src/waeup/kofa/students/reports/student_statistics.py

@@ -32 +32 @@
     creation_dt_string = Attribute('Human readable report creation datetime')
 
-def get_student_stats(session, mode):
+def get_student_stats(session, mode, breakdown):
     """Get students in a certain session and study mode.
 
-    Returns a table ordered by faculty code (one per row) and
+    Returns a table ordered by code (faculty or department, one per row) and
     registration state (cols). The result is a 3-tuple representing
-    ((<FACULTY_CODES>), (<STATES>), (<NUM_OF_STUDENTS>)). The
+    ((<CODES>), (<STATES>), (<NUM_OF_STUDENTS>)). The
     (<NUM_OF_STUDENTS>) is an n-tuple with each entry containing the
-    number of students found in that faculty and with the respective
+    number of students found in that faculty/department and with the respective
     state.
 
@@ -54 +54 @@
     states = tuple([x.value for x in registration_states_vocab])
     states = states + (u'Total',)
-    fac_codes = tuple(sorted([x for x in site['faculties'].keys()],
-                             key=lambda x: x.lower()))
-    fac_codes = fac_codes + (u'Total',)
+    if breakdown == 'faccode':
+        codes = tuple(sorted([x for x in site['faculties'].keys()],
+                                 key=lambda x: x.lower()))
+    elif breakdown == 'depcode':
+        faculties = site['faculties']
+        depcodes = []
+        for fac in faculties.values():
+            for dep in fac.values():
+                depcodes.append(dep.code)
+        codes = tuple(sorted([x for x in depcodes],
+                                 key=lambda x: x.lower()))
+    codes = codes + (u'Total',)
     # XXX: Here we do _one_ query and then examine the single
     #   students. One could also do multiple queries and just look for
@@ -63 +72 @@
     cat = queryUtility(ICatalog, name="students_catalog")
     result = cat.searchResults(current_session=(session, session))
-    table = [[0 for x in xrange(len(states))] for y in xrange(len(fac_codes))]
+    table = [[0 for x in xrange(len(states))] for y in xrange(len(codes))]
     mode_groups = getUtility(IKofaUtils).MODE_GROUPS
     for stud in result:
         if mode != 'All' and stud.current_mode not in mode_groups[mode]:
             continue
-        if stud.faccode not in fac_codes:
+        if getattr(stud, breakdown) not in codes:
             # studs can have a faccode ``None``
             continue
-        row = fac_codes.index(stud.faccode)
+        row = codes.index(getattr(stud, breakdown))
         col = states.index(stud.state)
         table[row][col] += 1
@@ -79 +88 @@
     # turn lists into tuples
     table = tuple([tuple(row) for row in table])
-    return (fac_codes, states, table)
+    return (codes, states, table)
 
 from reportlab.lib import colors
@@ -124 +133 @@
     mode = None
 
-    def __init__(self, session, mode, author='System'):
+    def __init__(self, session, mode, breakdown, author='System'):
         super(StudentStatisticsReport, self).__init__(
-            args=[session, mode], kwargs={'author':author})
+            args=[session, mode, breakdown], kwargs={'author':author})
         self.session = academic_sessions_vocab.getTerm(session).title
         self.mode = mode
+        self.breakdown = breakdown
         self.author = author
         self.creation_dt_string = self.creation_dt.astimezone(
             getUtility(IKofaUtils).tzinfo).strftime("%Y-%m-%d %H:%M:%S %Z")
-        self.data = get_student_stats(session, mode)
+        self.data = get_student_stats(session, mode, breakdown)
 
     def create_pdf(self):
@@ -156 +166 @@
     grok.name('student_stats')
 
-    def generate(self, site, session=None, mode=None, author=None):
-        result = StudentStatisticsReport(session=session, mode=mode, author=author)
+    def generate(self, site, session=None, mode=None, breakdown=None, author=None):
+        result = StudentStatisticsReport(
+            session=session, mode=mode, breakdown=breakdown, author=author)
         return result
 
@@ -185 +196 @@
         return None
 
-    def update(self, CREATE=None, session=None, mode=None):
+    def update(self, CREATE=None, session=None, mode=None, breakdown=None):
         self.parent_url = self.url(self.context.__parent__)
         self._set_session_values()
         self._set_mode_values()
+        self._set_breakdown_values()
         if CREATE and session:
             # create a new report job for students by session
@@ -195 +207 @@
             kw = dict(
                 session=int(session),
-                mode=mode)
+                mode=mode,
+                breakdown=breakdown)
             self.flash(_('New report is being created in background'))
             job_id = container.start_report_job(
@@ -201 +214 @@
             ob_class = self.__implemented__.__name__.replace('waeup.kofa.','')
             grok.getSite().logger.info(
-                '%s - report %s created: %s (session=%s, mode=%s)' % (
-                ob_class, job_id, self.context.title, session, mode))
+                '%s - report %s created: %s (session=%s, mode=%s, breakdown=%s)' % (
+                ob_class, job_id, self.context.title, session, mode, breakdown))
             self.redirect(self.parent_url)
             return
@@ -215 +228 @@
         mode_groups = getUtility(IKofaUtils).MODE_GROUPS
         self.modes = sorted([(key, key) for key in mode_groups.keys()])
+        return
+
+    def _set_breakdown_values(self):
+        self.breakdowns = [('Faculties', 'faccode'), ('Departments', 'depcode')]
         return
 

main/waeup.kofa/trunk/src/waeup/kofa/students/reports/tests/test_student_statistics.py

@@ -24 +24 @@
     def test_iface(self):
         # ensure we fullfill interface contracts
-        obj = StudentStatisticsReport(2010, 'Undergraduate Full-Time')
+        obj = StudentStatisticsReport(
+            2010, 'Undergraduate Full-Time', 'faccode')
         verifyClass(IStudentStatisticsReport, StudentStatisticsReport)
         verifyObject(IStudentStatisticsReport, obj)
@@ -31 +32 @@
     def test_get_student_stats_session_simple(self):
         # we can get a table with one student
-        result1 = get_student_stats(2010, 'Undergraduate Full-Time')
-        result2 = get_student_stats(2009, 'Undergraduate Full-Time')
+        result1 = get_student_stats(2010, 'Undergraduate Full-Time', 'faccode')
+        result2 = get_student_stats(2009, 'Undergraduate Full-Time', 'faccode')
         self.assertEqual(
             result1,
@@ -49 +50 @@
     def test_get_student_stats_session_multiple(self):
         # we can get a table with several students
-        self.create_cert(u'fac2', u'dept2', u'CERT2')
-        result1 = get_student_stats(2010, 'Undergraduate Full-Time')
-        result2 = get_student_stats(2009, 'Undergraduate Full-Time')
+        self.create_cert(u'fac2', u'dep2', u'CERT2')
+        result1 = get_student_stats(2010, 'Undergraduate Full-Time', 'faccode')
+        result2 = get_student_stats(2009, 'Undergraduate Full-Time', 'faccode')
         self.assertEqual(
             result1,
@@ -68 +69 @@
         return
 
+    def test_get_student_stats_session_multiple_dep_breakdown(self):
+        # we can get a table with several students
+        self.create_cert(u'fac2', u'dep2', u'CERT2')
+        result1 = get_student_stats(2010, 'Undergraduate Full-Time', 'depcode')
+        result2 = get_student_stats(2009, 'Undergraduate Full-Time', 'depcode')
+        self.assertEqual(
+            result1,
+            ((u'dep1', u'dep2', u'Total'),
+             self.states,
+             ((1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1),
+              (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
+              (1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1),)))
+        self.assertEqual(
+            result2,
+            ((u'dep1', u'dep2', u'Total'),
+             self.states,
+             ((0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
+              (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
+              (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0),)))
+        return
+
     def test_create_pdf(self):
         self.create_cert(u'FAC2', u'dept2', u'CERT2')
-        report = StudentStatisticsReport(2010, 'Undergraduate Full-Time')
+        report = StudentStatisticsReport(
+            2010, 'Undergraduate Full-Time', 'faccode')
         result = report.create_pdf()
         self.assertTrue(result.startswith('%PDF-'))
@@ -104 +127 @@
         self.browser.getControl(name="generator").value = ['student_stats']
         self.browser.getControl("Configure").click()
+        self.browser.getControl(name="breakdown").value = ['depcode']
         self.browser.getControl(name="mode").value = ['All']
         self.browser.getControl(name="session").value = ['2004']
@@ -134 +158 @@
         self.assertTrue(
             'INFO - zope.mgr - students.reports.student_statistics.StudentStatisticsReportGeneratorPage - '
-            'report %s created: Student Statistics (session=2004, mode=All)'
+            'report %s created: Student Statistics (session=2004, mode=All, breakdown=depcode)'
             % job_id in logcontent
             )