Changeset 7299 for main/waeup.sirp/trunk/src/waeup/sirp/browser/captcha.py

Timestamp:

7 Dec 2011, 06:01:35 (13 years ago)

Author:

uli

Message:

Be more verbose.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/browser/captcha.py (modified) (3 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/browser/captcha.py

@@ -189 +189 @@
 ##
 class IdCaptcha(object):
+    """The IdCaptcha allows all solutions that equal a challenge.
+
+    The challenge is a permutation of 'abcdefg'.
+
+    It is of no use for real world but for tests. In tests we cannot
+    easily solve really strong captchas. But we can use a captcha that
+    works like a real one but is easy to solve even for machines.
+
+    It is called IdCaptcha because solutions and challenges for this
+    captcha type are mapped by identitiy function.
+    """
     grok.implements(ICaptcha)
 
@@ -197 +208 @@
 
     def verify(self, request):
+        """Verify that a solution sent equals the challenge.
+        """
         form = getattr(request, 'form', {})
         solution=form.get(self.sol_field, None)
@@ -205 +218 @@
 
     def display(self, error_code=None):
+        """Display challenge and input field for solution as HTML.
+        """
         challenge = list('abcdef')
         random().shuffle(challenge)