annotate pylons_app/model/forms.py @ 13:b6b3533ad63c

Changed the managing script
author Marcin Kuzminski
date Sat, 20 Feb 2010 17:55:59 +0100
parents 564e40829f80
children a886f5eba757
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
1 """ this is forms validation classes
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
2 http://formencode.org/module-formencode.validators.html
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
3 for list off all availible validators
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
4
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
5 we can create our own validators
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
6
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
7 The table below outlines the options which can be used in a schema in addition to the validators themselves
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
8 pre_validators [] These validators will be applied before the schema
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
9 chained_validators [] These validators will be applied after the schema
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
10 allow_extra_fields False If True, then it is not an error when keys that aren't associated with a validator are present
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
11 filter_extra_fields False If True, then keys that aren't associated with a validator are removed
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
12 if_key_missing NoDefault If this is given, then any keys that aren't available but are expected will be replaced with this value (and then validated). This does not override a present .if_missing attribute on validators. NoDefault is a special FormEncode class to mean that no default values has been specified and therefore missing keys shouldn't take a default value.
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
13 ignore_key_missing False If True, then missing keys will be missing in the result, if the validator doesn't have .if_missing on it already
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
14
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
15
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
16 <name> = formencode.validators.<name of validator>
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
17 <name> must equal form name
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
18 list=[1,2,3,4,5]
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
19 for select use formencode.All(OneOf(list), Int())
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
20
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
21 """
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
22
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
23 import formencode
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
24 from formencode.validators import UnicodeString, OneOf, Int, Number, Regex
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
25 from pylons.i18n.translation import _
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
26 from webhelpers.pylonslib.secure_form import authentication_token
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
27
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
28 class ValidAuthToken(formencode.validators.FancyValidator):
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
29 messages = {'invalid_token':_('Token mismatch')}
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
30
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
31 def validate_python(self, value, state):
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
32
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
33 if value != authentication_token():
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
34 raise formencode.Invalid(self.message('invalid_token', state, search_number = value), value, state)
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
35
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
36
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
37 class WireTransferForm(object):
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
38 '''
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
39 A factory wrapper class. It might return the instance of class for a validation, but also it can
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
40 return the list for select fields values.
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
41 @param ret_type: type to return defaut: 'class'
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
42 '''
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
43 #class attributes here
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
44 #it might be fetched from db,from models and so on
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
45 recipients_list = [
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
46 (1, 'a'),
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
47 (2, 'b')
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
48 ]
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
49
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
50 def _form(self):
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
51 class _WireTransferForm(formencode.Schema):
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
52 allow_extra_fields = True
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
53 _authentication_token = ValidAuthToken()
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
54 account_number = Regex(r'[0-9]{26}', not_empty = True, messages = {
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
55 'invalid': _("Account number is invalid, it must be 26 digits")})
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
56 title = UnicodeString(not_empty = True, min = 3, strip = True)
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
57 recipient = formencode.All(OneOf([i[0] for i in WireTransferForm.recipients_list],
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
58 testValueList = True, hideList = True), Int())
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
59 recipient_address = UnicodeString(not_empty = True, strip = True)
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
60 amount = Number(not_empty = True, min = 1)
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
61
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
62 return _WireTransferForm()
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
63