/usr/share/pyshared/sprox/formbase.py is in python-sprox 0.6.4-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 | """
formbase Module
Classes to create form widgets.
Copyright (c) 2008 Christopher Perkins
Original Version by Christopher Perkins 2008
Released under MIT license.
"""
import inspect
from tw.api import Widget
from tw.forms import HiddenField, TableForm
from viewbase import ViewBase, ViewBaseError
from formencode import Schema, All
from formencode import Validator
from sprox.validators import UniqueValue
from formencode.validators import UnicodeString, String
from widgetselector import SAWidgetSelector
from sprox.metadata import FieldsMetadata
from validatorselector import SAValidatorSelector
from sprox.widgets.widgets import SproxMethodPutHiddenField
class FilteringSchema(Schema):
"""This makes formencode work for most forms, because some wsgi apps append extra values to the parameter list."""
filter_extra_fields = True
allow_extra_fields = True
class Field(object):
"""Used to handle the case where you want to override both a validator and a widget for a given field"""
def __init__(self, widget=None, validator=None):
self.widget = widget
self.validator = validator
class FormBase(ViewBase):
"""
:Modifiers:
Modifiers defined in this class
+-----------------------------------+--------------------------------------------+------------------------------+
| Name | Description | Default |
+===================================+============================================+==============================+
| __base_widget_type__ | What widget to use for the form. | TableForm |
+-----------------------------------+--------------------------------------------+------------------------------+
| __widget_selector_type__ | What class to use for widget selection. | SAWidgetSelector |
+-----------------------------------+--------------------------------------------+------------------------------+
| __validator_selector_type__ | What class to use for validator selection. | SAValidatorSelector |
+-----------------------------------+--------------------------------------------+------------------------------+
| __require_fields__ | Specifies which fields are required. | [] |
+-----------------------------------+--------------------------------------------+------------------------------+
| __check_if_unique__ | Set this to True for "new" forms. This | False |
| | causes Sprox to check if there is an | |
| | existing record in the database which | |
| | matches the field data. | |
+-----------------------------------+--------------------------------------------+------------------------------+
| __field_validators__ | A dictionary of validators indexed by | {} |
| | fieldname. | |
+-----------------------------------+--------------------------------------------+------------------------------+
| __field_validator_types__ | Types of validators to use for each field | {} |
| | (allow sprox to set the attribute of the | |
| | validators). | |
+-----------------------------------+--------------------------------------------+------------------------------+
| __base_validator__ | A validator to attch to the form. | None |
+-----------------------------------+--------------------------------------------+------------------------------+
| __validator_selector__ | What object to use to select field | None |
| | validators. | |
+-----------------------------------+--------------------------------------------+------------------------------+
| __metadata_type__ | What metadata type to use to get schema | FieldsMetadata |
| | info on this object | |
+-----------------------------------+--------------------------------------------+------------------------------+
| __dropdown_field_names__ | list or dict of names to use for discovery | None |
| | of field names for dropdowns (None uses | |
| | sprox default names.) | |
| | a dict provides field-level granularity | |
+-----------------------------------+--------------------------------------------+------------------------------+
Modifiers inherited from :class:`sprox.viewbase.ViewBase`
+-----------------------------------+--------------------------------------------+------------------------------+
| Name | Description | Default |
+===================================+============================================+==============================+
| __field_widgets__ | A dictionary of widgets to replace the | {} |
| | ones that would be chosen by the selector | |
+-----------------------------------+--------------------------------------------+------------------------------+
| __field_widget_types__ | A dictionary of types of widgets, allowing | {} |
| | sprox to determine the widget args | |
+-----------------------------------+--------------------------------------------+------------------------------+
| __widget_selector__ | an instantiated object to use for widget | None |
| | selection. | |
+-----------------------------------+--------------------------------------------+------------------------------+
Modifiers inherited from :class:`sprox.configbase.ConfigBase`
:Example Usage:
One of the more useful things sprox does for you is to fill in the arguments to a drop down automatically.
Here is the userform, limited to just the town field, which gets populated with the towns.
>>> from sprox.formbase import FormBase
>>> class UserOnlyTownForm(FormBase):
... __model__ = User
... __limit_fields__ = ['town']
>>>
>>> town_form = UserOnlyTownForm(session)
>>>
>>> print town_form() # doctest: +XML
<form action="" method="post" class="required tableform">
<div>
<input type="hidden" id="sprox_id" class="hiddenfield" name="sprox_id" value="" />
</div>
<table border="0" cellspacing="0" cellpadding="2" >
<tr class="even" id="town.container" title="" >
<td class="labelcol">
<label id="town.label" for="town" class="fieldlabel">Town</label>
</td>
<td class="fieldcol" >
<select name="town" class="propertysingleselectfield" id="town">
<option value="1">Arvada</option>
<option value="2">Denver</option>
<option value="3">Golden</option>
<option value="4">Boulder</option>
<option value="" selected="selected">-----------</option>
</select>
</td>
</tr>
<tr class="odd" id="submit.container" title="" >
<td class="labelcol">
<label id="submit.label" for="submit" class="fieldlabel"></label>
</td>
<td class="fieldcol" >
<input type="submit" class="submitbutton" value="Submit" />
</td>
</tr>
</table>
</form>
Forms created with sprox can be validated as you would any other widget.
>>> class UserOnlyTownForm(FormBase):
... __model__ = User
... __limit_fields__ = ['town']
... __required_fields__ = ['town']
>>> town_form = UserOnlyTownForm(session)
>>> town_form.validate(params={'sprox_id':1})
Traceback (most recent call last):
...
Invalid: town: Missing value
"""
__require_fields__ = None
__check_if_unique__ = False
#object overrides
__base_widget_type__ = TableForm
__widget_selector_type__ = SAWidgetSelector
__validator_selector__ = None
__validator_selector_type__ = SAValidatorSelector
__field_validators__ = None
__field_validator_types__ = None
__base_validator__ = FilteringSchema
__metadata_type__ = FieldsMetadata
__dropdown_field_names__ = None
def _do_init_attrs(self):
super(FormBase, self)._do_init_attrs()
if self.__require_fields__ is None:
self.__require_fields__ = []
if self.__field_validators__ is None:
self.__field_validators__ = {}
if self.__validator_selector__ is None:
self.__validator_selector__ = self.__validator_selector_type__(self.__provider__)
if self.__field_validator_types__ is None:
self.__field_validator_types__ = {}
if self.__dropdown_field_names__ is None:
self.__dropdown_field_names__ = ['name', '_name', 'description', '_description']
#bring in custom declared validators
for attr in dir(self):
if not attr.startswith('__'):
value = getattr(self, attr)
if isinstance(value, Field):
widget = value.widget
if isinstance(widget, Widget):
if not getattr(widget, 'id', None):
raise ViewBaseError('Widgets must provide an id argument for use as a field within a ViewBase')
self.__add_fields__[attr] = widget
try:
if issubclass(widget, Widget):
self.__field_widget_types__[attr] = widget
except TypeError:
pass
validator = value.validator
if isinstance(validator, Validator):
self.__field_validators__[attr] = validator
try:
if issubclass(validator, Validator):
self.__field_validator_types__[attr] = validator
except TypeError:
pass
if isinstance(value, Validator):
self.__field_validators__[attr] = value
continue
try:
if issubclass(value, Validator):
self.__field_validator_types__[attr] = value
except TypeError:
pass
def validate(self, params, state=None):
"""A pass-thru to the widget's validate function."""
return self.__widget__.validate(params, state)
def _do_get_widget_args(self):
"""Override this method to define how the class get's the
arguments for the main widget
"""
d = super(FormBase, self)._do_get_widget_args()
if self.__base_validator__ is not None:
d['validator'] = self.__base_validator__
return d
def _do_get_field_widget_args(self, field_name, field):
"""Override this method do define how this class gets the field
widget arguemnts
"""
args = super(FormBase, self)._do_get_field_widget_args( field_name, field)
v = self.__field_validators__.get(field_name, self._do_get_field_validator(field_name, field))
if self.__provider__.is_relation(self.__entity__, field_name):
args['entity'] = self.__entity__
args['field_name'] = field_name
if isinstance(self.__dropdown_field_names__, dict) and field_name in self.__dropdown_field_names__:
view_names = self.__dropdown_field_names__[field_name]
if not isinstance(view_names, list):
view_names = [view_names]
args['dropdown_field_names'] = view_names
elif isinstance(self.__dropdown_field_names__, list):
args['dropdown_field_names'] = self.__dropdown_field_names__
if v:
args['validator'] = v
return args
def _do_get_fields(self):
"""Override this function to define how
"""
fields = super(FormBase, self)._do_get_fields()
if 'sprox_id' not in fields:
fields.append('sprox_id')
return fields
def _do_get_field_widgets(self, fields):
widgets = super(FormBase, self)._do_get_field_widgets(fields)
widgets['sprox_id'] = HiddenField('sprox_id')
return widgets
def _do_get_field_validator(self, field_name, field):
"""Override thius function to define how a field validator is chosen for a given field.
"""
v_type = self.__field_validator_types__.get(field_name, self.__validator_selector__[field])
if field_name in self.__require_fields__ and v_type is None:
v_type = String
if v_type is None:
return
args = self._do_get_validator_args(field_name, field, v_type)
v = v_type(**args)
if hasattr(field, 'unique') and field.unique and self.__check_if_unique__:
v = All(UniqueValue(self.__provider__, self.__entity__, field_name), v)
return v
def _do_get_validator_args(self, field_name, field, validator_type):
"""Override this function to define how to get the validator arguments for the field's validator.
"""
args = {}
args['not_empty'] = (not self.__provider__.is_nullable(self.__entity__, field_name)) or \
field_name in self.__require_fields__
if hasattr(field, 'type') and hasattr(field.type, 'length') and\
issubclass(validator_type, String):
args['max'] = field.type.length
return args
class EditableForm(FormBase):
"""A form for editing a record.
:Modifiers:
see :class:`sprox.formbase.FormBase`
"""
def _do_get_disabled_fields(self):
fields = self.__disable_fields__[:]
fields.append(self.__provider__.get_primary_field(self.__entity__))
return fields
def _do_get_fields(self):
"""Override this function to define how
"""
fields = super(EditableForm, self)._do_get_fields()
if '_method' not in fields:
fields.append('_method')
return fields
def _do_get_field_widgets(self, fields):
widgets = super(EditableForm, self)._do_get_field_widgets(fields)
widgets['_method'] = SproxMethodPutHiddenField(id='_method', validator=String(if_missing=None))
return widgets
__check_if_unique__ = False
class AddRecordForm(FormBase):
"""An editable form who's purpose is record addition.
:Modifiers:
see :class:`sprox.formbase.FormBase`
+-----------------------------------+--------------------------------------------+------------------------------+
| Name | Description | Default |
+===================================+============================================+==============================+
| __check_if_unique__ | Set this to True for "new" forms. This | True |
| | causes Sprox to check if there is an | |
| | existing record in the database which | |
| | matches the field data. | |
+-----------------------------------+--------------------------------------------+------------------------------+
Here is an example registration form, as generated from the vase User model.
>>> from sprox.formbase import AddRecordForm
>>> from formencode import Schema
>>> from formencode.validators import FieldsMatch
>>> from tw.forms import PasswordField, TextField
>>> form_validator = Schema(chained_validators=(FieldsMatch('password',
... 'verify_password',
... messages={'invalidNoMatch':
... 'Passwords do not match'}),))
>>> class RegistrationForm(AddRecordForm):
... __model__ = User
... __require_fields__ = ['password', 'user_name', 'email_address']
... __omit_fields__ = ['_password', 'groups', 'created', 'user_id', 'town']
... __field_order__ = ['user_name', 'email_address', 'display_name', 'password', 'verify_password']
... __base_validator__ = form_validator
... email_address = TextField
... display_name = TextField
... verify_password = PasswordField('verify_password')
>>> registration_form = RegistrationForm()
>>> print registration_form() # doctest: +XML
<form action="" method="post" class="required tableform">
<div>
<input type="hidden" id="sprox_id" class="hiddenfield" name="sprox_id" value="" />
</div>
<table border="0" cellspacing="0" cellpadding="2" >
<tr class="even" id="user_name.container" title="" >
<td class="labelcol">
<label id="user_name.label" for="user_name" class="fieldlabel required">User Name</label>
</td>
<td class="fieldcol" >
<input type="text" id="user_name" class="textfield required" name="user_name" value="" />
</td>
</tr>
<tr class="odd" id="email_address.container" title="" >
<td class="labelcol">
<label id="email_address.label" for="email_address" class="fieldlabel required">Email Address</label>
</td>
<td class="fieldcol" >
<input type="text" id="email_address" class="textfield required" name="email_address" value="" />
</td>
</tr>
<tr class="even" id="display_name.container" title="" >
<td class="labelcol">
<label id="display_name.label" for="display_name" class="fieldlabel">Display Name</label>
</td>
<td class="fieldcol" >
<input type="text" id="display_name" class="textfield" name="display_name" value="" />
</td>
</tr>
<tr class="odd" id="password.container" title="" >
<td class="labelcol">
<label id="password.label" for="password" class="fieldlabel required">Password</label>
</td>
<td class="fieldcol" >
<input type="password" id="password" class="required passwordfield" name="password" value="" />
</td>
</tr>
<tr class="even" id="verify_password.container" title="" >
<td class="labelcol">
<label id="verify_password.label" for="verify_password" class="fieldlabel">Verify Password</label>
</td>
<td class="fieldcol" >
<input type="password" id="verify_password" class="passwordfield" name="verify_password" value="" />
</td>
</tr>
<tr class="odd" id="town_id.container" title="" >
<td class="labelcol">
<label id="town_id.label" for="town_id" class="fieldlabel">Town Id</label>
</td>
<td class="fieldcol" >
<input type="text" id="town_id" class="textfield" name="town_id" value="" />
</td>
</tr>
<tr class="even" id="submit.container" title="" >
<td class="labelcol">
<label id="submit.label" for="submit" class="fieldlabel"></label>
</td>
<td class="fieldcol" >
<input type="submit" class="submitbutton" value="Submit" />
</td>
</tr>
</table>
</form>
What is unique about the AddRecord form, is that if the fields in the database are labeled unique, it will
automatically vaidate against uniqueness for that field. Here is a simple user form definition, where the
user_name in the model is unique:
>>> class AddUserForm(AddRecordForm):
... __entity__ = User
... __limit_fields__ = ['user_name']
>>> user_form = AddUserForm(session)
>>> user_form.validate(params={'sprox_id':'asdf', 'user_name':u'asdf'}) # doctest: +SKIP
Traceback (most recent call last):
...
Invalid: user_name: That value already exists
The validation fails because there is already a user with the user_name 'asdf' in the database
"""
__check_if_unique__ = True
def _do_get_disabled_fields(self):
fields = self.__disable_fields__[:]
fields.append(self.__provider__.get_primary_field(self.__entity__))
return fields
class DisabledForm(FormBase):
"""A form who's set of fields is disabled.
:Modifiers:
see :class:`sprox.formbase.FormBase`
Here is an example disabled form with only the user_name and email fields.
>>> from sprox.test.model import User
>>> from sprox.formbase import DisabledForm
>>> class DisabledUserForm(DisabledForm):
... __model__ = User
... __limit_fields__ = ['user_name', 'email_address']
>>> disabled_user_form = DisabledUserForm()
>>> print disabled_user_form(values=dict(user_name='percious', email='chris@percious.com')) # doctest: +XML
<form action="" method="post" class="required tableform">
<div>
<input type="hidden" id="user_name" class="hiddenfield" name="user_name" value="" />
<input type="hidden" id="email_address" class="hiddenfield" name="email_address" value="" />
<input type="hidden" id="sprox_id" class="hiddenfield" name="sprox_id" value="" />
</div>
<table border="0" cellspacing="0" cellpadding="2" >
<tr class="even" id="user_name.container" title="" >
<td class="labelcol">
<label id="user_name.label" for="user_name" class="fieldlabel">User Name</label>
</td>
<td class="fieldcol" >
<input type="text" id="user_name" class="textfield" name="user_name" value="" disabled="disabled" />
</td>
</tr>
<tr class="odd" id="email_address.container" title="" >
<td class="labelcol">
<label id="email_address.label" for="email_address" class="fieldlabel">Email Address</label>
</td>
<td class="fieldcol" >
<textarea id="email_address" name="email_address" class="textarea" disabled="disabled" rows="7" cols="50"></textarea>
</td>
</tr>
<tr class="even" id="submit.container" title="" >
<td class="labelcol">
<label id="submit.label" for="submit" class="fieldlabel"></label>
</td>
<td class="fieldcol" >
<input type="submit" class="submitbutton" value="Submit" />
</td>
</tr>
</table>
</form>
You may notice in the above example that disabled fields pass in a hidden value for each disabled field.
"""
def _do_get_disabled_fields(self):
return self.__fields__
|