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

Timestamp:

31 Mar 2010, 11:04:27 (15 years ago)

Author:

uli

Message:

Update tests. Coverage of catalog.py now 100%.

File:

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

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

@@ -75 +75 @@
   similar when an access code gets invalidated.
 
+Tools
+=====
+
+:func:`search_invalidated`
+--------------------------
+
+.. function:: search_invalidated(batch_prefix, batch_num)
+
+  Get set of accesscode catalog entries, where the accesscode was
+  already invalidated and that belong to the batch given by the
+  arguments.
+
+  Note, that the set returned for efficiency reasons returns a set of
+  catalog entries (int id mappings) and not the access-code objects
+  themselves.
+
+:func:`invalidated_num`
+-----------------------
+
+.. function:: invalidated_num(batch_prefix, batch_num)
+
+  Get number of accesscodes found by `search_invalidated` for the
+  batch specified by arguments.
+
 Examples
 ========
@@ -105 +129 @@
      <...AccessCode object at 0x...>,
      <...AccessCode object at 0x...]
+
+We can lookup catalog entries refering to invalidated accesscodes:
+
+    >>> from waeup.sirp.accesscodes.catalog import search_invalidated
+    >>> r2 = search_invalidated(batch.prefix, batch.num)
+    >>> list(r2)
+    []
+
+And also lookup the number of entries:
+
+    >>> from waeup.sirp.accesscodes.catalog import invalidated_num
+    >>> invalidated_num(batch.prefix, batch.num)
+    0
+
+When we invalidate an accesscode, we will get different results:
+
+    >>> import grok
+    >>> ac0 = list(r1)[0]
+    >>> ac0.invalidation_date = datetime.now()
+
+We have to fire an ObjectModifiedEvent in order to inform the
+component architechture about the changed status of the object:
+
+    >>> grok.notify(grok.ObjectModifiedEvent(ac0))
+
+    >>> invalidated_num(batch.prefix, batch.num)
+    1