/usr/lib/python2.7/dist-packages/crispy_forms/utils.py is in python-django-crispy-forms 1.7.0-1.
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 | from __future__ import unicode_literals
import logging
import sys
from django.conf import settings
from django.forms.utils import flatatt as _flatatt
from django.template import Context
from django.template.loader import get_template
from django.utils.functional import SimpleLazyObject
from django.utils.lru_cache import lru_cache
from .base import KeepContext
from .compatibility import PY2, text_type
def get_template_pack():
return getattr(settings, 'CRISPY_TEMPLATE_PACK', 'bootstrap')
TEMPLATE_PACK = SimpleLazyObject(get_template_pack)
# By caching we avoid loading the template every time render_field
# is called without a template
@lru_cache()
def default_field_template(template_pack=TEMPLATE_PACK):
return get_template("%s/field.html" % template_pack)
def render_field(
field, form, form_style, context, template=None, labelclass=None,
layout_object=None, attrs=None, template_pack=TEMPLATE_PACK,
extra_context=None, **kwargs
):
"""
Renders a django-crispy-forms field
:param field: Can be a string or a Layout object like `Row`. If it's a layout
object, we call its render method, otherwise we instantiate a BoundField
and render it using default template 'CRISPY_TEMPLATE_PACK/field.html'
The field is added to a list that the form holds called `rendered_fields`
to avoid double rendering fields.
:param form: The form/formset to which that field belongs to.
:param form_style: A way to pass style name to the CSS framework used.
:template: Template used for rendering the field.
:layout_object: If passed, it points to the Layout object that is being rendered.
We use it to store its bound fields in a list called `layout_object.bound_fields`
:attrs: Attributes for the field's widget
:template_pack: Name of the template pack to be used for rendering `field`
:extra_context: Dictionary to be added to context, added variables by the layout object
"""
added_keys = [] if extra_context is None else extra_context.keys()
with KeepContext(context, added_keys):
if field is None:
return ''
FAIL_SILENTLY = getattr(settings, 'CRISPY_FAIL_SILENTLY', True)
if hasattr(field, 'render'):
return field.render(
form, form_style, context, template_pack=template_pack,
)
else:
# In Python 2 form field names cannot contain unicode characters without ASCII mapping
if PY2:
# This allows fields to be unicode strings, always they don't use non ASCII
try:
if isinstance(field, text_type):
field = field.encode('ascii').decode()
# If `field` is not unicode then we turn it into a unicode string, otherwise doing
# str(field) would give no error and the field would not be resolved, causing confusion
else:
field = text_type(field)
except (UnicodeEncodeError, UnicodeDecodeError):
raise Exception("Field '%s' is using forbidden unicode characters" % field)
try:
# Injecting HTML attributes into field's widget, Django handles rendering these
bound_field = form[field]
field_instance = bound_field.field
if attrs is not None:
widgets = getattr(field_instance.widget, 'widgets', [field_instance.widget])
# We use attrs as a dictionary later, so here we make a copy
list_attrs = attrs
if isinstance(attrs, dict):
list_attrs = [attrs] * len(widgets)
for index, (widget, attr) in enumerate(zip(widgets, list_attrs)):
if hasattr(field_instance.widget, 'widgets'):
if 'type' in attr and attr['type'] == "hidden":
field_instance.widget.widgets[index] = field_instance.hidden_widget(attr)
else:
field_instance.widget.widgets[index].attrs.update(attr)
else:
if 'type' in attr and attr['type'] == "hidden":
field_instance.widget = field_instance.hidden_widget(attr)
else:
field_instance.widget.attrs.update(attr)
except KeyError:
if not FAIL_SILENTLY:
raise Exception("Could not resolve form field '%s'." % field)
else:
field_instance = None
logging.warning("Could not resolve form field '%s'." % field, exc_info=sys.exc_info())
if hasattr(form, 'rendered_fields'):
if not field in form.rendered_fields:
form.rendered_fields.add(field)
else:
if not FAIL_SILENTLY:
raise Exception("A field should only be rendered once: %s" % field)
else:
logging.warning("A field should only be rendered once: %s" % field, exc_info=sys.exc_info())
if field_instance is None:
html = ''
else:
if template is None:
if form.crispy_field_template is None:
template = default_field_template(template_pack)
else: # FormHelper.field_template set
template = get_template(form.crispy_field_template)
else:
template = get_template(template)
# We save the Layout object's bound fields in the layout object's `bound_fields` list
if layout_object is not None:
if hasattr(layout_object, 'bound_fields') and isinstance(layout_object.bound_fields, list):
layout_object.bound_fields.append(bound_field)
else:
layout_object.bound_fields = [bound_field]
context.update({
'field': bound_field,
'labelclass': labelclass,
'flat_attrs': flatatt(attrs if isinstance(attrs, dict) else {}),
})
if extra_context is not None:
context.update(extra_context)
context = context.flatten()
html = template.render(context)
return html
def flatatt(attrs):
"""
Convert a dictionary of attributes to a single string.
Passed attributes are redirected to `django.forms.utils.flatatt()`
with replaced "_" (underscores) by "-" (dashes) in their names.
"""
return _flatatt({k.replace('_', '-'): v for k, v in attrs.items()})
def render_crispy_form(form, helper=None, context=None):
"""
Renders a form and returns its HTML output.
This function wraps the template logic in a function easy to use in a Django view.
"""
from crispy_forms.templatetags.crispy_forms_tags import CrispyFormNode
if helper is not None:
node = CrispyFormNode('form', 'helper')
else:
node = CrispyFormNode('form', None)
node_context = Context(context)
node_context.update({
'form': form,
'helper': helper
})
return node.render(node_context)
def list_intersection(list1, list2):
"""
Take the not-in-place intersection of two lists, similar to sets but preserving order.
Does not check unicity of list1.
"""
return [item for item in list1 if item in list2]
def list_difference(left, right):
"""
Take the not-in-place difference of two lists (left - right), similar to sets but preserving order.
"""
blocked = set(right)
difference = []
for item in left:
if item not in blocked:
blocked.add(item)
difference.append(item)
return difference
|