Changeset 5447

Timestamp:

16 Aug 2010, 12:32:26 (14 years ago)

Author:

uli

Message:

Move 'get_access_code' to the accesscodes subpackage.

Location:

main/waeup.sirp/trunk/src/waeup/sirp

Files:

• accesscodes/__init__.py (modified) (1 diff)
• accesscodes/accesscodes.py (modified) (1 diff)
• jambtables/authentication.py (modified) (1 diff)
• jambtables/util.py (modified) (1 diff)

main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/__init__.py

@@ -1 +1 @@
 # Make this a package.
+from waeup.sirp.accesscodes.accesscodes import get_access_code
+
+# Public API of this submodule
+__all__ = [
+    get_access_code
+    ]
+

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

@@ -409 +409 @@
                     site, ))
         return
+
+def get_access_code(access_code):
+    """Get an access code instance.
+
+    An access code here is a string like ``PUDE-1-1234567890``.
+    
+    Returns ``None`` if the given code cannot be found.
+
+    This is a convenicence function that is faster than looking up a
+    batch container for the approriate access code.
+    """
+    site = grok.getSite()
+    if not isinstance(access_code, basestring):
+        return None
+    try:
+        batch_id, ac_id = access_code.rsplit('-', 1)
+    except:
+        return None
+    if batch_id not in site['accesscodes'].keys():
+        return None
+    batch = site['accesscodes'][batch_id]
+    try:
+        code = batch.getAccessCode(access_code)
+    except KeyError:
+        return None
+    return code

main/waeup.sirp/trunk/src/waeup/sirp/jambtables/authentication.py

@@ -38 +38 @@
     IApplicantPrincipalInfo, IApplicantPrincipal, IApplicantSessionCredentials,
     IJAMBApplicantSessionCredentials)
-from waeup.sirp.jambtables.util import get_applicant_data, get_access_code
+from waeup.sirp.jambtables.util import get_applicant_data
+from waeup.sirp.accesscodes import get_access_code
 
 class PortalUser(grok.Role):

main/waeup.sirp/trunk/src/waeup/sirp/jambtables/util.py

@@ -45 +45 @@
     # XXX: Maybe we have to mark reg_no as used here?
     return (applicant_data, entries[0])
-
-def get_access_code(access_code):
-    """Get an access code instance.
-
-    Returns ``None`` if the given code cannot be found.
-
-    XXX: This should be moved to `accesscodes` as public API part.
-    """
-    site = grok.getSite()
-    if not isinstance(access_code, basestring):
-        return None
-    try:
-        batch_id, ac_id = access_code.rsplit('-', 1)
-    except:
-        return None
-    if batch_id not in site['accesscodes'].keys():
-        return None
-    batch = site['accesscodes'][batch_id]
-    return batch.getAccessCode(access_code)