Changeset 7099 for main/waeup.sirp/trunk/src

Timestamp:

13 Nov 2011, 06:13:55 (13 years ago)

Author:

uli

Message:

Update doc strings a bit.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/students/student.py (modified) (5 diffs)

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

@@ -54 +54 @@
             self.student_id = u'Z654321'
         self.password = None
-        
         return
 
@@ -145 +144 @@
 
 class StudentFileNameChooser(grok.Adapter):
-    """A file id chooser for :class:`Applicant` objects.
-
-    `context` is an :class:`Applicant` instance.
-
-    The :class:`ApplicantImageNameChooser` can build/check file ids
-    for :class:`Applicant` objects suitable for use with
+    """A file id chooser for :class:`Student` objects.
+
+    `context` is an :class:`Student` instance.
+
+    The :class:`StudentImageNameChooser` can build/check file ids for
+    :class:`Student` objects suitable for use with
     :class:`ExtFileStore` instances. The delivered file_id contains
-    the file id marker for :class:`Applicant` object and the
-    registration number or access code of the context applicant. Also
-    the name of the connected applicant container will be part of the
-    generated file id.
+    the file id marker for :class:`Student` object and the student id
+    of the context student.
 
     This chooser is registered as an adapter providing
@@ -161 +158 @@
 
     File store name choosers like this one are only convenience
-    components to ease the task of creating file ids for applicant
+    components to ease the task of creating file ids for student
     objects. You are nevertheless encouraged to use them instead of
-    manually setting up filenames for applicants.
+    manually setting up filenames for students.
 
     .. seealso:: :mod:`waeup.sirp.imagestorage`
@@ -197 +194 @@
 
         """
-        first_character = self.context.student_id[0]
+        stud_id = self.context.student_id
         marked_filename = '__%s__%s/%s/%s_%s.jpg' % (
-            STUDENT_FILE_STORE_NAME, first_character,
-            self.context.student_id, attr, self.context.student_id)
+            STUDENT_FILE_STORE_NAME, stud_id[0], stud_id, attr, stud_id)
         return marked_filename
 
@@ -223 +219 @@
 
     def pathFromFileID(self, store, root, file_id):
-        """All applicants images are filed in directory ``applicants``.
+        """All student files are put in directory ``students``.
         """
         marker, filename, basename, ext = store.extractMarker(file_id)