Changeset 5080

Timestamp:

24 Mar 2010, 12:58:37 (15 years ago)

Author:

uli

Message:

Update tests.

File:

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

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

@@ -1 @@
-Accesscodes
-***********
+:mod:`waeup.sirp.accesscodes.accesscodes` -- access codes (aka PINs)
+********************************************************************
 
-:doctest:
+.. module:: waeup.sirp.accesscodes.accesscodes
 
-We can create accesscodes:
+Components that represent access codes and related.
 
-    >>> from waeup.sirp.accesscodes.accesscodes import AccessCode
-    >>> ac = AccessCode(0, 'APP', 12, '0123456789', 12.12)
-    >>> ac.representation
-    'APP-12-0123456789'
+.. :doctest:
 
-We can create batches. Here we create a batch of three entries, with a
-cost of 12.12 per code, the batch prefix 'APP', batch number 12,
-creator ID 'Fred' and some arbitrary creation date:
+Access codes are created as parts of batches. We therefore have to
+create a batch first.
+
+Here we create a batch of three entries, with a cost of ``12.12`` per
+code, the batch prefix ``APP``, batch number ``10``, creator ID
+``Fred`` and some arbitrary creation date:
 
     >>> import datetime
@@ -20 +20 @@
     ...   datetime.datetime(2009, 12, 23), 'Fred', 10, 'APP', 12.12, 3)
 
-The main point about a batch is that it can act as an iterator over
-the generated access codes. The codes are generated on-the-fly when
-iterating over the batch for the first time:
+Now we have three accesscodes stored in the batch:
 
-    >>> ac_codes = [x.representation for x in batch]
-    >>> ac_codes
+    >>> sorted(list(batch.items()))
+    [(u'0', <waeup.sirp...AccessCode object at 0x...), ...]
+
+As we can see, access codes entries can be found in a batch by their
+(stringified) serial number.
+
+Each accesscode has a representation:
+
+    >>> ac = batch['0']
+    >>> ac.representation
+    'APP-10-<10-DIGITS>'
+
+The main point about a batch is that it can act as a dictionary for
+the generated access codes:
+
+    >>> ac_codes = list(batch.values())
+    >>> [x.representation for x in ac_codes]
     ['APP-10-...', 'APP-10-...', 'APP-10-...']
-
-When we ask for the access codes again, we will get equal
-entries. 'Equal' means: we will get same representations, but not
-neccessarily the same objects:
-
-    >>> ac_codes2 = [x.representation for x in batch]
-    >>> ac_codes2 == ac_codes
-    True
-
-    >>> ac_codes[0] == ac_codes2[0]
-    True
-
-    >>> ac_codes[0] is ac_codes2[0]
-    False
 
 `Accesscode` and `AccessCodeBatch` classes implement the respective