Changeset 7145

Timestamp:

19 Nov 2011, 17:56:03 (13 years ago)

Author:

Henrik Bettermann

Message:

Change some function names according to the style guide:

Function names should be lowercase, with words separated by underscores as necessary to improve readability.

Location:

main

Files:

• waeup.custom/trunk/src/waeup/custom/interfaces.py (modified) (1 diff)
• waeup.custom/trunk/src/waeup/custom/students/browser.py (modified) (2 diffs)
• waeup.custom/trunk/src/waeup/custom/students/utils.py (modified) (1 diff)
• waeup.sirp/trunk/src/waeup/sirp/applicants/browser.py (modified) (2 diffs)
• waeup.sirp/trunk/src/waeup/sirp/students/browser.py (modified) (15 diffs)
• waeup.sirp/trunk/src/waeup/sirp/students/utils.py (modified) (7 diffs)

main/waeup.custom/trunk/src/waeup/custom/interfaces.py

@@ -11 +11 @@
 
     school_fee_base = schema.Int(
-        title = u'School Fee',
+        title = u'School Fee (ignored)',
         default = 0,
         )

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

@@ -3 +3 @@
 from zope.component import createObject
 from waeup.sirp.students.browser import OnlinePaymentAddFormPage
-from waeup.custom.students.utils import getPaymentDetails
+from waeup.custom.students.utils import get_payment_details
 
 class OnlinePaymentAddFormPage(OnlinePaymentAddFormPage):
@@ -9 +9 @@
     """
 
-    def getPaymentDetails(self, category, student):
-        return getPaymentDetails(category, student)
+    def get_payment_details(self, category, student):
+        return get_payment_details(category, student)

main/waeup.custom/trunk/src/waeup/custom/students/utils.py

@@ -3 +3 @@
 from waeup.sirp.students.workflow import CLEARED, RETURNING
 
-def getPaymentDetails(category, student):
+def get_payment_details(category, student):
     d = {}
     d['surcharge_1'] = d['surcharge_2'] = d['surcharge_3'] = 0

main/waeup.sirp/trunk/src/waeup/sirp/applicants/browser.py

@@ -797 +797 @@
     title = u'Your Application Form'
 
-    def emitLockMessage(self):
+    def emit_lock_message(self):
         self.flash('The requested form is locked (read-only).')
         self.redirect(self.url(self.context))
@@ -804 +804 @@
     def update(self):
         if self.context.locked:
-            self.emitLockMessage()
+            self.emit_lock_message()
             return
         datepicker.need() # Enable jQuery datepicker in date fields.

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

@@ -52 +52 @@
 from waeup.sirp.students.vocabularies import StudyLevelSource
 from waeup.sirp.students.utils import (
-    getPaymentDetails, getAccommodationDetails, selectBed,
-    renderPDF, validatePassword)
+    get_payment_details, get_accommodation_details, select_bed,
+    render_pdf, validatePassword)
 from waeup.sirp.browser.resources import toggleall
 from waeup.sirp.authentication import get_principal_role_manager
@@ -77 +77 @@
     return
 
-def emitLockMessage(view):
+def emit_lock_message(view):
     view.flash('The requested form is locked (read-only).')
     view.redirect(view.url(view.context))
@@ -678 +678 @@
         studentview = StudentBaseDisplayFormPage(self.context.getStudent(),
             self.request)
-        return renderPDF(self,'Course Registration', 'course_registration.pdf',
+        return render_pdf(self,'Course Registration', 'course_registration.pdf',
             self.context.getStudent, studentview)
 
@@ -951 +951 @@
     
     # To be sepezified in customization packages
-    def getPaymentDetails(self, category, student):
-        return getPaymentDetails(category, student)
+    def get_payment_details(self, category, student):
+        return get_payment_details(category, student)
 
     @grok.action('Create ticket')
@@ -965 +965 @@
                 self.redirect(self.url(self.context))
                 return
-        pay_details  = self.getPaymentDetails(
+        pay_details  = self.get_payment_details(
             p_category,student)
         if pay_details['error']:
@@ -1119 +1119 @@
         studentview = StudentBaseDisplayFormPage(self.context.getStudent(),
             self.request)
-        return renderPDF(self,'Payment', 'payment_receipt.pdf',
+        return render_pdf(self,'Payment', 'payment_receipt.pdf',
             self.context.getStudent, studentview)
 
@@ -1229 +1229 @@
 
     # To be sepezified in customization packages
-    def getAccommodationDetails(self, student):
-        return getAccommodationDetails(student)
+    def get_accommodation_details(self, student):
+        return get_accommodation_details(student)
 
     # To be sepezified in customization packages
-    def selectBed(self, available_beds):
-        return selectBed(available_beds)
+    def select_bed(self, available_beds):
+        return select_bed(available_beds)
 
     def update(self, SUBMIT=None):
         student = self.context.getStudent()
-        acc_details  = self.getAccommodationDetails(student)
+        acc_details  = self.get_accommodation_details(student)
         if not student.state in acc_details['allowed_states']:
             self.flash("You are in the wrong registration state.")
@@ -1275 +1275 @@
                 entry for entry in entries if entry.owner == NOT_OCCUPIED]
             if available_beds:
-                bed = self.selectBed(available_beds)
+                bed = self.select_bed(available_beds)
                 bed.bookBed(student.student_id)
             else:
@@ -1356 +1356 @@
         studentview = StudentBaseDisplayFormPage(self.context.getStudent(),
             self.request)
-        return renderPDF(self,'Bed Allocation', 'bed_allocation.pdf',
+        return render_pdf(self,'Bed Allocation', 'bed_allocation.pdf',
             self.context.getStudent, studentview)
 
@@ -1376 +1376 @@
 
     # To be sepezified in customization packages
-    def getAccommodationDetails(self, student):
-        return getAccommodationDetails(student)
+    def get_accommodation_details(self, student):
+        return get_accommodation_details(student)
 
     # To be sepezified in customization packages
-    def selectBed(self, available_beds):
-        return selectBed(available_beds)
+    def select_bed(self, available_beds):
+        return select_bed(available_beds)
 
     # Relocate student if student parameters have changed or the bed_type
@@ -1387 +1387 @@
     def update(self):
         student = self.context.getStudent()
-        acc_details  = self.getAccommodationDetails(student)
+        acc_details  = self.get_accommodation_details(student)
         if self.context.bed != None and \
               'reserved' in self.context.bed.bed_type:
@@ -1414 +1414 @@
                 entry for entry in entries if entry.owner == NOT_OCCUPIED]
             if available_beds:
-                new_bed = self.selectBed(available_beds)
+                new_bed = self.select_bed(available_beds)
                 new_bed.bookBed(student.student_id)
             else:
@@ -1548 +1548 @@
     def update(self):
         if self.context.getStudent().state != 'admitted':
-            emitLockMessage(self)
+            emit_lock_message(self)
             return
         super(StudentFilesUploadPage, self).update()
@@ -1662 +1662 @@
     def update(self):
         if self.context.clearance_locked:
-            emitLockMessage(self)
+            emit_lock_message(self)
             return
         return super(StudentClearanceEditFormPage, self).update()
@@ -1819 +1819 @@
     def update(self):
         if self.context.getStudent().state != 'school fee paid':
-            emitLockMessage(self)
+            emit_lock_message(self)
             return
         super(AddStudyLevelFormPage, self).update()

main/waeup.sirp/trunk/src/waeup/sirp/students/utils.py

@@ -41 +41 @@
 # To be specified in customization packages, see also the view which
 # calls the function.
-def getPaymentDetails(category, student):
+def get_payment_details(category, student):
     d = {}
     d['p_item'] = u''
@@ -63 +63 @@
         d['amount'] = academic_session.clearance_fee
     elif category == 'bed_allocation':
-        d['p_item'] = getAccommodationDetails(student)['bt']
+        d['p_item'] = get_accommodation_details(student)['bt']
         d['amount'] = academic_session.booking_fee
     return d
@@ -69 +69 @@
 # To be specified in customization packages, see also the view which
 # calls the function.
-def getAccommodationDetails(student):
+def get_accommodation_details(student):
     d = {}
     d['error'] = u''
@@ -99 +99 @@
 # I the standard configuration we select the first bed found,
 # but can also randomize the selection if we like.
-def selectBed(available_beds):
+def select_bed(available_beds):
     return available_beds[0]
 
@@ -110 +110 @@
         )
 
-def renderStudentData(student, studentview):
+def render_student_data(student, studentview):
     setUpWidgets(studentview, ignore_request=True)
     data = []
@@ -127 +127 @@
 # To be specified in customization packages, see also view which
 # calls the function.
-def renderPDF(view, subject='', filename='slip.pdf', student=None, studentview=None):
+def render_pdf(view, subject='', filename='slip.pdf', student=None, studentview=None):
     # (0,0),(-1,-1) = whole table
     # (0,0),(0,-1) = first column
@@ -156 +156 @@
     if student:
         story.append(Spacer(1, 18))
-        studenttable = renderStudentData(student, studentview)
+        studenttable = render_student_data(student, studentview)
         story.append(studenttable)
     story.append(Spacer(1, 18))