Created
May 24, 2012 15:07
-
-
Save haikoschol/2782119 to your computer and use it in GitHub Desktop.
workaround for a regression in Django 1.4 which makes forms with fields of type BooleanField non-picklable
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
""" | |
Copyright (c) Django Software Foundation and individual contributors. | |
All rights reserved. | |
Redistribution and use in source and binary forms, with or without modification, | |
are permitted provided that the following conditions are met: | |
1. Redistributions of source code must retain the above copyright notice, | |
this list of conditions and the following disclaimer. | |
2. Redistributions in binary form must reproduce the above copyright | |
notice, this list of conditions and the following disclaimer in the | |
documentation and/or other materials provided with the distribution. | |
3. Neither the name of Django nor the names of its contributors may be used | |
to endorse or promote products derived from this software without | |
specific prior written permission. | |
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | |
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR | |
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | |
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON | |
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
""" | |
from django.forms.util import flatatt | |
from django.forms.widgets import Widget | |
from django.utils.encoding import force_unicode | |
from django.utils.safestring import mark_safe | |
def boolean_check(v): | |
return not (v is False or v is None or v == '') | |
class PicklableCheckboxInput(Widget): | |
def __init__(self, attrs=None, check_test=None): | |
super(PicklableCheckboxInput, self).__init__(attrs) | |
# check_test is a callable that takes a value and returns True | |
# if the checkbox should be checked for that value. | |
self.check_test = boolean_check if check_test is None else check_test | |
def render(self, name, value, attrs=None): | |
final_attrs = self.build_attrs(attrs, type='checkbox', name=name) | |
try: | |
result = self.check_test(value) | |
except: # Silently catch exceptions | |
result = False | |
if result: | |
final_attrs['checked'] = 'checked' | |
if not (value is True or value is False or value is None or value == ''): | |
# Only add the 'value' attribute if a value is non-empty. | |
final_attrs['value'] = force_unicode(value) | |
return mark_safe(u'<input%s />' % flatatt(final_attrs)) | |
def value_from_datadict(self, data, files, name): | |
if name not in data: | |
# A missing value means False because HTML form submission does not | |
# send results for unselected checkboxes. | |
return False | |
value = data.get(name) | |
# Translate true and false strings to boolean values. | |
values = {'true': True, 'false': False} | |
if isinstance(value, basestring): | |
value = values.get(value.lower(), value) | |
return value | |
def _has_changed(self, initial, data): | |
# Sometimes data or initial could be None or u'' which should be the | |
# same thing as False. | |
return bool(initial) != bool(data) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment