Changeset 9420 for main/waeup.kofa/trunk/src/waeup/kofa/students

Timestamp:

25 Oct 2012, 21:52:10 (12 years ago)

Author:

Henrik Bettermann

Message:

Reorganize ICourseTicket. Add ICourseTicketImport which validates a new field called level_session.

Customize checkConversion of CourseTicketProcessor?:
If level_session is provided in row the importer checks if
the parent studylevel exists and if its level_session
attribute corresponds with the expected value in row. The error message
then tells us why course result import fails.

Location:

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

Files:

• batching.py (modified) (8 diffs)
• browser.py (modified) (4 diffs)
• browser_templates/courseticketmanagepage.pt (deleted)
• browser_templates/courseticketpage.pt (deleted)
• export.py (modified) (1 diff)
• interfaces.py (modified) (7 diffs)
• studylevel.py (modified) (1 diff)
• tests/sample_courseticket_data.csv (modified) (1 diff)
• tests/test_batching.py (modified) (3 diffs)
• tests/test_browser.py (modified) (1 diff)

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

@@ -43 +43 @@
     IStudent, IStudentStudyCourse,
     IStudentUpdateByRegNo, IStudentUpdateByMatricNo,
-    IStudentStudyLevel, ICourseTicket,
+    IStudentStudyLevel, ICourseTicketImport,
     IStudentOnlinePayment, IStudentVerdictUpdate)
 from waeup.kofa.students.workflow import  (
@@ -305 +305 @@
     grok.baseclass()
 
-    # additional available  fields
+    # additional available fields
     # beside 'student_id', 'reg_number' and 'matric_number'
     additional_fields = []
@@ -541 +541 @@
 
     name = u'CourseTicket Processor'
-    iface = ICourseTicket
+    iface = ICourseTicketImport
     factory_name = 'waeup.CourseTicket'
 
@@ -547 +547 @@
     additional_fields = ['level', 'code']
     additional_headers = ['level', 'code']
+
+    @property
+    def available_fields(self):
+        fields = [
+            'student_id','reg_number','matric_number',
+            'mandatory', 'score', 'carry_over', 'automatic',
+            'level_session'
+            ] + self.additional_fields
+        return sorted(fields)
 
     def getParent(self, row, site):
@@ -579 +588 @@
         obj.dcode = entries[0].__parent__.__parent__.code
         obj.title = entries[0].title
-        if getattr(obj, 'credits', None) is None:
-            obj.credits = entries[0].credits
-        if getattr(obj, 'passmark', None) is None:
-            obj.passmark = entries[0].passmark
+        #if getattr(obj, 'credits', None) is None:
+        obj.credits = entries[0].credits
+        #if getattr(obj, 'passmark', None) is None:
+        obj.passmark = entries[0].passmark
         obj.semester = entries[0].semester
         parent[row['code']] = obj
@@ -602 +611 @@
         errs, inv_errs, conv_dict = super(
             CourseTicketProcessor, self).checkConversion(row, mode=mode)
-
-        # We have to check if course really exists.
+        if mode == 'remove':
+            return errs, inv_errs, conv_dict
+        # In update and create mode we have to check if course really exists.
         # This is not done by the converter.
         catalog = getUtility(ICatalog, name='courses_catalog')
@@ -610 +620 @@
             errs.append(('code','non-existent'))
             return errs, inv_errs, conv_dict
+        # If level_session is provided in row we have to check if
+        # the parent studylevel exists and if its level_session
+        # attribute corresponds with the expected value in row.
+        level_session = row.get('level_session', IGNORE_MARKER)
+        if level_session not in (IGNORE_MARKER, ''):
+            site = grok.getSite()
+            studylevel = self.getParent(row, site)
+            if studylevel is not None:
+                if studylevel.level_session != level_session:
+                    errs.append(('level_session','does not match %s'
+                        % studylevel.level_session))
+            else:
+                errs.append(('level','does not exist'))
         return errs, inv_errs, conv_dict
 
@@ -793 +816 @@
         notify(grok.ObjectModifiedEvent(obj.__parent__))
         return
-
-class CourseResultProcessor(CourseTicketProcessor):
-    """A special batch processor for course results objects.
-
-    Import course results, compares session and creates study level.
-    """
-    grok.implements(IBatchProcessor)
-    grok.provides(IBatchProcessor)
-    grok.context(Interface)
-    util_name = 'courseresultprocessor'
-    grok.name(util_name)
-
-    name = u'Course Result Processor (special processor)'
-    iface = ICourseTicket
-    factory_name = 'waeup.CourseTicket'
-
-    location_fields = []
-    additional_fields = ['level', 'code']
-    additional_headers = ['level', 'code']
-
-    def getParent(self, row, site):
-        student = self._getStudent(row, site)
-        if student is None:
-            return None
-        return student['studycourse'].get(row['level'])
-
-    def getEntry(self, row, site):
-        level = self.getParent(row, site)
-        if level is None:
-            return None
-        return level.get(row['code'])
-
-    def updateEntry(self, obj, row, site):
-        """Update obj to the values given in row.
-        """
-        items_changed = super(CourseTicketProcessor, self).updateEntry(
-            obj, row, site)
-        parent = self.getParent(row, site)
-        student = self.getParent(row, site).__parent__.__parent__
-        student.__parent__.logger.info(
-            '%s - Course ticket in %s updated: %s'
-            % (student.student_id,  parent.level, items_changed))
-        return
-
-    def addEntry(self, obj, row, site):
-        parent = self.getParent(row, site)
-        catalog = getUtility(ICatalog, name='courses_catalog')
-        entries = list(catalog.searchResults(code=(row['code'],row['code'])))
-        obj.fcode = entries[0].__parent__.__parent__.__parent__.code
-        obj.dcode = entries[0].__parent__.__parent__.code
-        obj.title = entries[0].title
-        if getattr(obj, 'credits', None) is None:
-            obj.credits = entries[0].credits
-        if getattr(obj, 'passmark', None) is None:
-            obj.passmark = entries[0].passmark
-        obj.semester = entries[0].semester
-        parent[row['code']] = obj
-        return
-
-    def delEntry(self, row, site):
-        raise NotImplementedError('method not implemented')
-
-    def checkConversion(self, row, mode='ignore'):
-        """Validates all values in row.
-        """
-        errs, inv_errs, conv_dict = super(
-            CourseTicketProcessor, self).checkConversion(row, mode=mode)
-
-        # We have to check if course really exists.
-        # This is not done by the converter.
-        catalog = getUtility(ICatalog, name='courses_catalog')
-        entries = catalog.searchResults(code=(row['code'],row['code']))
-        if len(entries) == 0:
-            errs.append(('code','non-existent'))
-            return errs, inv_errs, conv_dict
-        return errs, inv_errs, conv_dict

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

@@ -1184 +1184 @@
     grok.require('waeup.manageStudent')
     label = _('Add course ticket')
-    form_fields = grok.AutoFields(ICourseTicketAdd).omit(
-        'score', 'automatic', 'carry_over', 'credits', 'passmark')
+    form_fields = grok.AutoFields(ICourseTicketAdd)
     pnav = 4
 
@@ -1222 +1221 @@
     grok.require('waeup.viewStudent')
     form_fields = grok.AutoFields(ICourseTicket)
-    grok.template('courseticketpage')
     pnav = 4
 
@@ -1237 +1235 @@
     grok.name('manage')
     grok.require('waeup.manageStudent')
-    form_fields = grok.AutoFields(ICourseTicket).omit('credits', 'passmark')
-    grok.template('courseticketmanagepage')
+    form_fields = grok.AutoFields(ICourseTicket)
+    form_fields['title'].for_display = True
+    form_fields['fcode'].for_display = True
+    form_fields['dcode'].for_display = True
+    form_fields['semester'].for_display = True
+    form_fields['passmark'].for_display = True
+    form_fields['credits'].for_display = True
+    form_fields['mandatory'].for_display = True
+    form_fields['automatic'].for_display = True
     pnav = 4
 
@@ -2181 +2186 @@
     grok.name('ctadd')
     grok.require('waeup.handleStudent')
-    form_fields = grok.AutoFields(ICourseTicketAdd).omit(
-        'score', 'mandatory', 'automatic', 'carry_over', 'credits', 'passmark')
+    form_fields = grok.AutoFields(ICourseTicketAdd)
 
     def update(self):

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

@@ -210 +210 @@
     #: Fieldnames considered by this exporter
     fields = tuple(sorted(iface_names(ICourseTicket) +
-        ['level', 'code', 'title',
-        'semester', 'fcode', 'dcode'])) + ('student_id', 'certcode')
+        ['level', 'code'])) + ('student_id', 'certcode')
 
     #: The title under which this exporter will be displayed

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

@@ -28 +28 @@
 from waeup.kofa.students.vocabularies import (
     StudyLevelSource, contextual_reg_num_source, contextual_mat_num_source,
-    GenderSource, nats_vocab,
+    GenderSource, nats_vocab
     )
 from waeup.kofa.payments.interfaces import (
     IPaymentsContainer, IOnlinePayment)
 from waeup.kofa.university.vocabularies import (
-    CourseSource, StudyModeSource, CertificateSource)
+    CourseSource, StudyModeSource, CertificateSource, SemesterSource)
 
 # VerdictSource can't be placed into the vocabularies module because it
@@ -488 +488 @@
 
 class ICourseTicket(IKofaObject):
-    """A course ticket.
+    """An interface for course tickets.
 
     """
     code = Attribute('code of the original course')
-    title = Attribute('title of the original course')
-    credits = Attribute('credits of the original course')
-    passmark = Attribute('passmark of the original course')
-    semester = Attribute('semester of the original course')
-    fcode = Attribute('faculty code of the original course')
-    dcode = Attribute('department code of the original course')
     certcode = Attribute('certificate code of the study course')
+
+    title = schema.TextLine(
+        title = _(u'Title'),
+        required = False,
+        )
+
+    fcode = schema.TextLine(
+        title = _(u'Faculty Code'),
+        required = False,
+        )
+
+    dcode = schema.TextLine(
+        title = _(u'Department Code'),
+        required = False,
+        )
+
+    semester = schema.Choice(
+        title = _(u'Semester/Term'),
+        source = SemesterSource(),
+        required = False,
+        )
+
+    passmark = schema.Int(
+        title = _(u'Passmark'),
+        required = False,
+        )
+
+    credits = schema.Int(
+        title = _(u'Credits'),
+        required = False,
+        )
 
     mandatory = schema.Bool(
@@ -504 +529 @@
         default = False,
         required = False,
-        readonly = False,
         )
 
@@ -511 +535 @@
         default = 0,
         required = False,
-        readonly = False,
+        )
+
+    carry_over = schema.Bool(
+        title = _(u'Carry-over Course'),
+        default = False,
+        required = False,
         )
 
@@ -518 +547 @@
         default = False,
         required = False,
-        readonly = True,
-        )
-
-    carry_over = schema.Bool(
-        title = _(u'Carry-over Course'),
-        default = False,
-        required = False,
-        readonly = False,
-        )
-
-    credits = schema.Int(
-        title = _(u'Credits'),
-        required = False,
-        )
-
-    passmark = schema.Int(
-        title = _(u'Passmark'),
-        required = False,
-        )
+        )
+
 
     def getLevel():
@@ -546 +558 @@
         """
 
-class ICourseTicketAdd(ICourseTicket):
+class ICourseTicketAdd(IKofaObject):
     """An interface for adding course tickets.
 
@@ -556 +568 @@
         )
 
+class ICourseTicketImport(ICourseTicket):
+    """An interface for importing course results and nothing more.
+
+    """
+    score = schema.Int(
+        title = _(u'Score'),
+        required = False,
+        readonly = False,
+        )
+
+    level_session = schema.Choice(
+        title = _(u'Level Session'),
+        source = academic_sessions_vocab,
+        required = False,
+        readonly = False,
+        )
+
 class IStudentAccommodation(IKofaObject):
     """A container for student accommodation objects.

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

@@ -121 +121 @@
         super(CourseTicket, self).__init__()
         self.code = None
-        self.title = None
-        self.fcode = None
-        self.dcode = None
-        self.semester = None
         return
 

main/waeup.kofa/trunk/src/waeup/kofa/students/tests/sample_courseticket_data.csv

@@ -1 @@
-reg_number,matric_number,level,code,score,mandatory
-1,,100,COURSE1,1,True
-2,,100,COURSE1,2,False
-,100002,100,COURSE1,3,False
-1,,nonsense,COURSE1,5,
-1,,100,NONSENSE,5,
+reg_number,matric_number,level,code,score,mandatory,level_session
+1,,100,COURSE1,1,True,
+2,,100,COURSE1,2,False,
+,100002,100,COURSE1,3,False,
+1,,nonsense,COURSE1,5,,
+1,,100,NONSENSE,5,,
+1,,200,COURSE1,6,,2004
+1,,300,COURSE1,6,,2008
+1,,300,COURSE1,6,,200888

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

@@ -733 +733 @@
 
     def test_import(self):
-
         num, num_warns, fin_file, fail_file = self.processor.doImport(
             self.csv_file, COURSETICKET_HEADER_FIELDS,'create')
-
-        self.assertEqual(num_warns,2)
+        fail_file = open(fail_file).read()
+        self.assertEqual(num_warns,5)
+        self.assertEqual(fail_file,
+            'reg_number,code,mandatory,level,level_session,score,matric_number,--ERRORS--\r\n'
+            '1,COURSE1,,nonsense,,5,,Not all parents do exist yet. Skipping\r\n'
+            '1,NONSENSE,,100,,5,,code: non-existent\r\n'
+            '1,COURSE1,,200,2004,6,,level_session: does not match 2008\r\n'
+            '1,COURSE1,,300,2008,6,,level: does not exist\r\n'
+            '1,COURSE1,,300,200888,6,,level_session: Invalid value; level: does not exist\r\n')
         assert self.processor.entryExists(
             dict(reg_number='1', level='100', code='COURSE1'),
@@ -772 +778 @@
         num, num_warns, fin_file, fail_file = self.processor.doImport(
             self.csv_file, COURSETICKET_HEADER_FIELDS,'update')
-        self.assertEqual(num_warns,2)
+        fail_file = open(fail_file).read()
+        self.assertEqual(num_warns,5)
+        self.assertEqual(fail_file,
+            'reg_number,code,mandatory,level,level_session,score,matric_number,--ERRORS--\r\n'
+            '1,COURSE1,<IGNORE>,nonsense,<IGNORE>,5,<IGNORE>,Cannot update: no such entry\r\n'
+            '1,NONSENSE,<IGNORE>,100,<IGNORE>,5,<IGNORE>,code: non-existent\r\n'
+            '1,COURSE1,<IGNORE>,200,2004,6,<IGNORE>,level_session: does not match 2008\r\n'
+            '1,COURSE1,<IGNORE>,300,2008,6,<IGNORE>,level: does not exist\r\n'
+            '1,COURSE1,<IGNORE>,300,200888,6,<IGNORE>,level_session: Invalid value; level: does not exist\r\n')
         shutil.rmtree(os.path.dirname(fin_file))
 
@@ -786 +800 @@
         num, num_warns, fin_file, fail_file = self.processor.doImport(
             self.csv_file, COURSETICKET_HEADER_FIELDS,'remove')
-        self.assertEqual(num_warns,2)
+        self.assertEqual(num_warns,5)
         assert self.processor.entryExists(
             dict(reg_number='1', level='100', code='COURSE1'), self.app) is False

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

@@ -161 +161 @@
         self.certificate.school_fee_1 = 40000.0
         self.certificate.school_fee_2 = 20000.0
-        self.app['faculties']['fac1'] = Faculty(code='fac1')
-        self.app['faculties']['fac1']['dep1'] = Department(code='dep1')
+        self.app['faculties']['fac1'] = Faculty(code=u'fac1')
+        self.app['faculties']['fac1']['dep1'] = Department(code=u'dep1')
         self.app['faculties']['fac1']['dep1'].certificates.addCertificate(
             self.certificate)