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
|
"""
Useful form fields for use with the Peewee ORM.
(cribbed from wtforms.ext.django.fields)
"""
import datetime
import operator
import warnings
try:
from markupsafe import Markup
except ImportError:
try:
from wtforms.widgets import HTMLString as Markup
except ImportError:
raise ImportError('Could not import markupsafe.Markup. Please install '
'markupsafe.')
from wtforms import __version__ as wtforms_version
from wtforms import fields, form, widgets
from wtforms.fields import FormField, _unset_value
from wtforms.validators import ValidationError
from wtfpeewee._compat import text_type, string_types
__all__ = (
'ModelSelectField', 'ModelSelectMultipleField', 'ModelHiddenField',
'SelectQueryField', 'SelectMultipleQueryField', 'HiddenQueryField',
'SelectChoicesField', 'BooleanSelectField', 'WPTimeField', 'WPDateField',
'WPDateTimeField',
)
class StaticAttributesMixin(object):
attributes = {}
def __call__(self, **kwargs):
for key, value in self.attributes.items():
if key in kwargs:
curr = kwargs[key]
kwargs[key] = '%s %s' % (value, curr)
return super(StaticAttributesMixin, self).__call__(**kwargs)
if wtforms_version < '3.1.0':
def wtf_choice(*args):
return args
else:
def wtf_choice(*args):
return args + ({},)
class BooleanSelectField(fields.SelectFieldBase):
widget = widgets.Select()
def iter_choices(self):
yield wtf_choice('1', 'True', self.data)
yield wtf_choice('', 'False', not self.data)
def process_data(self, value):
try:
self.data = bool(value)
except (ValueError, TypeError):
self.data = None
def process_formdata(self, valuelist):
if valuelist:
try:
self.data = bool(valuelist[0])
except ValueError:
raise ValueError(self.gettext(u'Invalid Choice: could not coerce'))
class WPTimeField(StaticAttributesMixin, fields.StringField):
attributes = {'class': 'time-widget'}
formats = ['%H:%M:%S', '%H:%M']
def _value(self):
if self.raw_data:
return u' '.join(self.raw_data)
else:
return self.data and self.data.strftime(self.formats[0]) or u''
def convert(self, time_str):
for format in self.formats:
try:
return datetime.datetime.strptime(time_str, format).time()
except ValueError:
pass
def process_formdata(self, valuelist):
if valuelist:
self.data = self.convert(' '.join(valuelist))
if self.data is None:
raise ValueError(self.gettext(u'Not a valid time value'))
class WPDateField(StaticAttributesMixin, fields.DateField):
attributes = {'class': 'date-widget'}
def datetime_widget(field, **kwargs):
kwargs.setdefault('id', field.id)
kwargs.setdefault('class', '')
kwargs['class'] += ' datetime-widget'
html = []
for subfield in field:
html.append(subfield(**kwargs))
return Markup(u''.join(html))
def generate_datetime_form(validators=None):
class _DateTimeForm(form.Form):
date = WPDateField(validators=validators)
time = WPTimeField(validators=validators)
return _DateTimeForm
class WPDateTimeField(FormField):
widget = staticmethod(datetime_widget)
def __init__(self, label='', validators=None, **kwargs):
DynamicForm = generate_datetime_form(validators)
super(WPDateTimeField, self).__init__(
DynamicForm, label, validators=None, **kwargs)
def process(self, formdata, data=_unset_value, **_):
prefix = self.name + self.separator
kwargs = {}
if data is _unset_value:
try:
data = self.default()
except TypeError:
data = self.default
if data and data is not _unset_value:
kwargs['date'] = data.date()
kwargs['time'] = data.time()
self.form = self.form_class(formdata, prefix=prefix, **kwargs)
def populate_obj(self, obj, name):
setattr(obj, name, self.data)
@property
def data(self):
date_data = self.date.data
time_data = self.time.data or datetime.time(0, 0)
if date_data:
return datetime.datetime.combine(date_data, time_data)
class ChosenSelectWidget(widgets.Select):
"""
`Chosen <http://harvesthq.github.com/chosen/>`_ styled select widget.
You must include chosen.js for styling to work.
"""
def __call__(self, field, **kwargs):
if field.allow_blank and not self.multiple:
kwargs['data-role'] = u'chosenblank'
else:
kwargs['data-role'] = u'chosen'
return super(ChosenSelectWidget, self).__call__(field, **kwargs)
class SelectChoicesField(fields.SelectField):
widget = ChosenSelectWidget()
# all of this exists so i can get proper handling of None
def __init__(self, label=None, validators=None, coerce=text_type, choices=None, allow_blank=False, blank_text=u'', **kwargs):
super(SelectChoicesField, self).__init__(label, validators, coerce, choices, **kwargs)
self.allow_blank = allow_blank
self.blank_text = blank_text or '----------------'
def iter_choices(self):
if self.allow_blank:
yield wtf_choice(u'__None', self.blank_text, self.data is None)
for value, label in self.choices:
yield wtf_choice(value, label, self.coerce(value) == self.data)
def process_data(self, value):
if value is None:
self.data = None
else:
try:
self.data = self.coerce(value)
except (ValueError, TypeError):
self.data = None
def process_formdata(self, valuelist):
if valuelist:
if valuelist[0] == '__None':
self.data = None
else:
try:
self.data = self.coerce(valuelist[0])
except ValueError:
raise ValueError(self.gettext(u'Invalid Choice: could not coerce'))
def pre_validate(self, form):
if self.allow_blank and self.data is None:
return
super(SelectChoicesField, self).pre_validate(form)
class SelectQueryField(fields.SelectFieldBase):
"""
Given a SelectQuery either at initialization or inside a view, will display a
select drop-down field of choices. The `data` property actually will
store/keep an ORM model instance, not the ID. Submitting a choice which is
not in the queryset will result in a validation error.
Specify `get_label` to customize the label associated with each option. If
a string, this is the name of an attribute on the model object to use as
the label text. If a one-argument callable, this callable will be passed
model instance and expected to return the label text. Otherwise, the model
object's `__unicode__` will be used.
If `allow_blank` is set to `True`, then a blank choice will be added to the
top of the list. Selecting this choice will result in the `data` property
being `None`. The label for the blank choice can be set by specifying the
`blank_text` parameter.
"""
widget = ChosenSelectWidget()
def __init__(self, label=None, validators=None, query=None, get_label=None, allow_blank=False, blank_text=u'', **kwargs):
super(SelectQueryField, self).__init__(label, validators, **kwargs)
self.allow_blank = allow_blank
self.blank_text = blank_text or '----------------'
self.query = query
self.model = query.model
self._set_data(None)
if get_label is None:
self.get_label = lambda o: text_type(o)
elif isinstance(get_label, string_types):
self.get_label = operator.attrgetter(get_label)
else:
self.get_label = get_label
def get_model(self, pk):
try:
return self.query.where(self.model._meta.primary_key==pk).get()
except self.model.DoesNotExist:
pass
def _get_data(self):
if self._formdata is not None:
self._set_data(self.get_model(self._formdata))
return self._data
def _set_data(self, data):
self._data = data
self._formdata = None
data = property(_get_data, _set_data)
def __call__(self, **kwargs):
if 'value' in kwargs:
self._set_data(self.get_model(kwargs['value']))
return self.widget(self, **kwargs)
def iter_choices(self):
if self.allow_blank:
yield wtf_choice(u'__None', self.blank_text, self.data is None)
for obj in self.query.clone():
yield wtf_choice(obj._pk, self.get_label(obj), obj == self.data)
def process_formdata(self, valuelist):
if valuelist:
if valuelist[0] == '__None':
self.data = None
else:
self._data = None
self._formdata = valuelist[0]
def pre_validate(self, form):
if self.data is not None:
if not self.query.where(self.model._meta.primary_key==self.data._pk).exists():
raise ValidationError(self.gettext('Not a valid choice'))
elif not self.allow_blank:
raise ValidationError(self.gettext('Selection cannot be blank'))
class SelectMultipleQueryField(SelectQueryField):
widget = ChosenSelectWidget(multiple=True)
def __init__(self, *args, **kwargs):
kwargs.pop('allow_blank', None)
super(SelectMultipleQueryField, self).__init__(*args, **kwargs)
def get_model_list(self, pk_list):
if pk_list:
return list(self.query.where(self.model._meta.primary_key << pk_list))
return []
def _get_data(self):
if self._formdata is not None:
self._set_data(self.get_model_list(self._formdata))
return self._data or []
def _set_data(self, data):
self._data = data
self._formdata = None
data = property(_get_data, _set_data)
def __call__(self, **kwargs):
if 'value' in kwargs:
self._set_data(self.get_model_list(kwargs['value']))
return self.widget(self, **kwargs)
def iter_choices(self):
for obj in self.query.clone():
yield wtf_choice(obj._pk, self.get_label(obj), obj in self.data)
def process_formdata(self, valuelist):
if valuelist:
self._data = []
self._formdata = list(map(int, valuelist))
def pre_validate(self, form):
if self.data:
id_list = [m._pk for m in self.data]
if id_list and not self.query.where(self.model._meta.primary_key << id_list).count() == len(id_list):
raise ValidationError(self.gettext('Not a valid choice'))
class HiddenQueryField(fields.HiddenField):
def __init__(self, label=None, validators=None, query=None, get_label=None, **kwargs):
self.allow_blank = kwargs.pop('allow_blank', False)
super(fields.HiddenField, self).__init__(label, validators, **kwargs)
self.query = query
self.model = query.model
self._set_data(None)
if get_label is None:
self.get_label = lambda o: text_type(o)
elif isinstance(get_label, basestring):
self.get_label = operator.attrgetter(get_label)
else:
self.get_label = get_label
def get_model(self, pk):
try:
return self.query.where(self.model._meta.primary_key==pk).get()
except self.model.DoesNotExist:
pass
def _get_data(self):
if self._formdata is not None:
if self.allow_blank and self._formdata == '__None':
self._set_data(None)
else:
self._set_data(self.get_model(self._formdata))
return self._data
def _set_data(self, data):
self._data = data
self._formdata = None
data = property(_get_data, _set_data)
def __call__(self, **kwargs):
if 'value' in kwargs:
self._set_data(self.get_model(kwargs['value']))
return self.widget(self, **kwargs)
def _value(self):
return self.data and self.data._pk or ''
def process_formdata(self, valuelist):
if valuelist:
model_id = valuelist[0]
self._data = None
self._formdata = model_id or None
class ModelSelectField(SelectQueryField):
"""
Like a SelectQueryField, except takes a model class instead of a
queryset and lists everything in it.
"""
def __init__(self, label=None, validators=None, model=None, **kwargs):
super(ModelSelectField, self).__init__(label, validators, query=model.select(), **kwargs)
class ModelSelectMultipleField(SelectMultipleQueryField):
"""
Like a SelectMultipleQueryField, except takes a model class instead of a
queryset and lists everything in it.
"""
def __init__(self, label=None, validators=None, model=None, **kwargs):
super(ModelSelectMultipleField, self).__init__(label, validators, query=model.select(), **kwargs)
class ModelHiddenField(HiddenQueryField):
"""
Like a HiddenQueryField, except takes a model class instead of a
queryset and lists everything in it.
"""
def __init__(self, label=None, validators=None, model=None, **kwargs):
super(ModelHiddenField, self).__init__(label, validators, query=model.select(), **kwargs)
|