Changeset 5122

Timestamp:

5 Apr 2010, 11:55:28 (15 years ago)

Author:

uli

Message:

Update tests:

• Check costs

• Tell about AccessCodeBatchContainer?.

• Add docs for addAccessCode()

File:

• main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/accesscodes.txt (modified) (2 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/accesscodes.txt

@@ -181 +181 @@
       When a code cannot be found :exc:`KeyError` is raised.
 
+   .. method:: addAccessCode(serial_num, random_num)
+
+      Add an access code to the batch.
+
+      ``serial_num`` denotes the serial number of the new access-code
+      inside the batch. ``random_num`` is a string of 10 digits unique
+      in this batch.
+
    .. method:: invalidate(ac_id[, student_id=None])
 
@@ -273 +281 @@
     >>> ac.student_id
     'some_user_id'
+
+Access codes get their ``cost`` from the batch they belong to. Note,
+that it is advisable to print costs always using a format, as Python
+floats are often represented by irritating values:
+
+    >>> ac.cost
+    12.119999999999999
+
+    >>> print "%0.2f" % ac.cost
+    12.12
+
+
+AccessCodeBatchContainer
+========================
+
+.. class:: AccessCodeBatchContainer()
+
+   A container for access code batches.
+
+   .. method:: addBatch(batch)
+
+      Add a batch in this container.
+
+   .. method:: getNum(prefix)
+
+      Get next unused num for a new batch and a given prefix.
+
+      Batches for a given prefix are numerated. Whenever a new batch
+      is created and other batches inside the container already have
+      the same prefix, the new one will get the lowest unused number.