1 | :mod:`waeup.university.certificate` -- Certificates for WAeUP |
---|
2 | ************************************************************* |
---|
3 | |
---|
4 | .. module:: waeup.university.certificate |
---|
5 | |
---|
6 | Components that represent and manage certificates. |
---|
7 | |
---|
8 | :Test-Layer: unit |
---|
9 | |
---|
10 | Because certificates make use of components registered with the Zope |
---|
11 | Component Architecture (ZCA), we first have to grok the `waeup` |
---|
12 | package. This happens automatically in real-world use: |
---|
13 | |
---|
14 | >>> import grok |
---|
15 | >>> grok.testing.grok('waeup') |
---|
16 | |
---|
17 | |
---|
18 | Content Classes (models and containers) |
---|
19 | ======================================= |
---|
20 | |
---|
21 | |
---|
22 | :class:`Certificate` |
---|
23 | -------------------- |
---|
24 | |
---|
25 | .. class:: Certificate([code=u'NA',[ title=u'Unnamed Certificate',[ category=None,[ study_mode=None,[ start_level=None,[ end_level=None,[ application_category=None,[ m_prefix=u'',[ max_pass = u'']]]]]]]]]) |
---|
26 | |
---|
27 | Create a certificate object with the given parameters. |
---|
28 | |
---|
29 | .. attribute:: grok.implements(ICertificate) |
---|
30 | |
---|
31 | All parameters are optional: |
---|
32 | |
---|
33 | >>> from waeup.university.certificate import Certificate |
---|
34 | >>> mycertificate = Certificate() |
---|
35 | |
---|
36 | Certificates have the attributes required by the `ICertificate` interface: |
---|
37 | |
---|
38 | >>> from waeup.interfaces import ICertificate |
---|
39 | >>> ICertificate.providedBy(mycertificate) |
---|
40 | True |
---|
41 | |
---|
42 | >>> from zope.interface.verify import verifyObject |
---|
43 | >>> verifyObject(ICertificate, mycertificate) |
---|
44 | True |
---|
45 | |
---|
46 | Beside the attributes, certificates are containers for |
---|
47 | certificate-courses (see :class:`CertificateCourse`). Each |
---|
48 | certificate course can be accessed by the code of the course it wraps. |
---|
49 | |
---|
50 | .. attribute:: title |
---|
51 | |
---|
52 | Each certificate has a title: |
---|
53 | |
---|
54 | >>> mycertificate.title |
---|
55 | u'Unnamed Certificate' |
---|
56 | |
---|
57 | .. attribute:: code |
---|
58 | |
---|
59 | Each certificate holds a code, which might be a shortcut or |
---|
60 | abbreviation of the real certificate name. By default the code |
---|
61 | is ``NA`` (=not assigned): |
---|
62 | |
---|
63 | >>> mycertificate.code |
---|
64 | u'NA' |
---|
65 | |
---|
66 | .. attribute:: review_state |
---|
67 | |
---|
68 | The review state can have one of the ``checking`` states defined |
---|
69 | in the WAeUP workflow. These are at least the states ``checked`` |
---|
70 | and ``unchecked``. After a certificate is created, the review |
---|
71 | state is ``unchecked``: |
---|
72 | |
---|
73 | >>> mycertificate.review_state |
---|
74 | 'unchecked' |
---|
75 | |
---|
76 | .. seealso:: |
---|
77 | :meth:`Certificate.check` -- mark a certificate as ``checked`` |
---|
78 | |
---|
79 | .. attribute:: category |
---|
80 | |
---|
81 | Each :class:`Certificate` instance has a category: |
---|
82 | |
---|
83 | >>> print mycertificate.category |
---|
84 | None |
---|
85 | |
---|
86 | .. XXX: This is not a proper description |
---|
87 | |
---|
88 | .. attribute:: study_mode |
---|
89 | |
---|
90 | Each :class:`Certificate` instance has a study mode: |
---|
91 | |
---|
92 | >>> print mycertificate.study_mode |
---|
93 | None |
---|
94 | |
---|
95 | .. XXX: This is not a proper description |
---|
96 | |
---|
97 | .. attribute:: start_level |
---|
98 | |
---|
99 | Each :class:`Certificate` instance has a start level: |
---|
100 | |
---|
101 | >>> print mycertificate.start_level |
---|
102 | None |
---|
103 | |
---|
104 | .. XXX: This is not a proper description |
---|
105 | |
---|
106 | .. attribute:: end_level |
---|
107 | |
---|
108 | Each :class:`Certificate` instance has a end level: |
---|
109 | |
---|
110 | >>> print mycertificate.end_level |
---|
111 | None |
---|
112 | |
---|
113 | .. XXX: This is not a proper description |
---|
114 | |
---|
115 | |
---|
116 | .. attribute:: application_category |
---|
117 | |
---|
118 | Each :class:`Certificate` instance has an application category: |
---|
119 | |
---|
120 | >>> print mycertificate.application_category |
---|
121 | None |
---|
122 | |
---|
123 | .. XXX: This is not a proper description |
---|
124 | |
---|
125 | |
---|
126 | .. attribute:: m_prefix |
---|
127 | |
---|
128 | Each :class:`Certificate` instance has an ``m_prefix``: |
---|
129 | |
---|
130 | >>> mycertificate.m_prefix |
---|
131 | u'' |
---|
132 | |
---|
133 | .. XXX: This is not a proper description |
---|
134 | |
---|
135 | |
---|
136 | .. attribute:: max_pass |
---|
137 | |
---|
138 | Each :class:`Certificate` instance has a maximum number of passes: |
---|
139 | |
---|
140 | >>> mycertificate.max_pass |
---|
141 | u'' |
---|
142 | |
---|
143 | .. XXX: This is not a proper description |
---|
144 | |
---|
145 | |
---|
146 | .. method:: check() |
---|
147 | |
---|
148 | Mark a certificate instance's review state as ``checked``: |
---|
149 | |
---|
150 | >>> mycertificate.review_state |
---|
151 | 'unchecked' |
---|
152 | |
---|
153 | >>> mycertificate.check() |
---|
154 | >>> mycertificate.review_state |
---|
155 | 'checked' |
---|
156 | |
---|
157 | We cannot uncheck a certificate: |
---|
158 | |
---|
159 | >>> mycertificate.review_state = 'init' |
---|
160 | Traceback (most recent call last): |
---|
161 | ... |
---|
162 | InvalidTransitionError: Transition 'init' requires 'None' |
---|
163 | as source state (is: 'checked') |
---|
164 | |
---|
165 | .. method:: addCourseRef(course[, level=100,[ core_or_elective=True]]) |
---|
166 | |
---|
167 | Add a reference to a course. A course is an object implementing |
---|
168 | :class:`waeup.interfaces.ICourse`. |
---|
169 | |
---|
170 | Please don't be confused by the term 'reference'. This just |
---|
171 | means an ordinary :class:`waeup.university.course.Course` object |
---|
172 | in almost all cases. As this object will normaly be one stored |
---|
173 | in a department, the course here will simply become a reference |
---|
174 | to the 'real' one in the department container. |
---|
175 | |
---|
176 | .. method:: delCourseRef(code) |
---|
177 | |
---|
178 | Remove a course from a certificate. |
---|
179 | |
---|
180 | The course must be given by its code number. |
---|
181 | |
---|
182 | :class:`CertificateCourse` |
---|
183 | -------------------------- |
---|
184 | |
---|
185 | .. class:: CertificateCourse(course[, level=100[, core_or_elective=True]]) |
---|
186 | |
---|
187 | Create a certificate course. |
---|
188 | |
---|
189 | A certificate-course is a course (:class:`Course`) which is part of |
---|
190 | a certificate. Normally, certificate-courses are held in |
---|
191 | certificates and refer to an existing :class:`Course` instance held |
---|
192 | elsewhere. |
---|
193 | |
---|
194 | A certificate can require several courses and one |
---|
195 | course can be required by several certificates. |
---|
196 | |
---|
197 | .. attribute:: course |
---|
198 | |
---|
199 | An instance of :class:`ICourse`. |
---|
200 | |
---|
201 | .. attribute:: level |
---|
202 | |
---|
203 | An integer telling the level to which this course applies. |
---|
204 | |
---|
205 | .. attribute:: core_or_elective |
---|
206 | |
---|
207 | A bool stating whether this course is required or optional to |
---|
208 | get the certificate. |
---|
209 | |
---|
210 | |
---|
211 | |
---|
212 | Utilities |
---|
213 | ========= |
---|
214 | |
---|
215 | :class:`CertificateFactory` |
---|
216 | --------------------------- |
---|
217 | |
---|
218 | .. class:: CertificateFactory() |
---|
219 | |
---|
220 | .. attribute:: grok.name(u'waeup.Certificate') |
---|
221 | |
---|
222 | .. attribute:: grok.implements(IFactory) |
---|
223 | |
---|
224 | A named utility to deliver new instances of :class:`Certificate` |
---|
225 | without the need to import the implementation before: |
---|
226 | |
---|
227 | >>> from zope.component import createObject |
---|
228 | >>> mycertificate = createObject(u'waeup.Certificate') |
---|
229 | >>> mycertificate |
---|
230 | <waeup.university.certificate.Certificate object at 0x...> |
---|
231 | |
---|
232 | Examples |
---|
233 | ======== |
---|
234 | |
---|
235 | Certificates |
---|
236 | ------------ |
---|
237 | |
---|
238 | We can create certificates: |
---|
239 | |
---|
240 | >>> from waeup.university.certificate import Certificate |
---|
241 | >>> mycertificate = Certificate() |
---|
242 | >>> mycertificate |
---|
243 | <waeup.university.certificate.Certificate object at 0x...> |
---|
244 | |
---|
245 | Another way to create certificates is by asking for a factory called |
---|
246 | ``waeup.Certificate``. This way we can create a factory without |
---|
247 | importing a class: |
---|
248 | |
---|
249 | >>> from zope.component import createObject |
---|
250 | >>> mycertificate = createObject(u'waeup.Certificate') |
---|
251 | >>> mycertificate |
---|
252 | <waeup.university.certificate.Certificate object at 0x...> |
---|
253 | |
---|
254 | CertificateCourses |
---|
255 | ------------------ |
---|
256 | |
---|
257 | :class:`CertificateCourse` instances comply with the |
---|
258 | :class:`ICertificateCourse` interface: |
---|
259 | |
---|
260 | >>> from waeup.interfaces import ICertificateCourse |
---|
261 | >>> from waeup.university.certificate import CertificateCourse |
---|
262 | >>> mycertcourse = CertificateCourse(None, 200, False) |
---|
263 | >>> ICertificateCourse.providedBy(mycertcourse) |
---|
264 | True |
---|
265 | |
---|
266 | >>> from zope.interface.verify import verifyObject |
---|
267 | >>> verifyObject(ICertificateCourse, mycertcourse) |
---|
268 | True |
---|
269 | |
---|