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
| {% macro form_errors(form, hiddens=True) %} {%- if form.errors %} {%- for fieldname, errors in form.errors.items() %} {%- if is_hidden_wtf_field(form[fieldname]) and hiddens or not is_hidden_wtf_field(form[fieldname]) and hiddens != 'only' %} {%- for error in errors %} <div class="invalid-feedback">{{ error }}</div> {%- endfor %} {%- endif %} {%- endfor %} {%- endif %} {%- endmacro %}
{% macro _hz_form_wrap(horizontal_columns, form_type, add_group=False, required=False) %} {% if form_type == "horizontal" %} {% if add_group %} <div class="form-group row{% if required %} required{% endif %}">{% endif %} <div class="offset-{{ horizontal_columns[0] }}-{{ horizontal_columns[1] }} col-{{ horizontal_columns[0] }}-{{ horizontal_columns[2] }} "> {% endif %} {{ caller() }}
{% if form_type == "horizontal" %} {% if add_group %}</div>{% endif %} </div> {% endif %} {% endmacro %}
{% macro form_field(field, form_type="basic", horizontal_columns=('lg', 2, 10), button_map={}) %}
{# this is a workaround hack for the more straightforward-code of just passing required=required parameter. older versions of wtforms do not have the necessary fix for required=False attributes, but will also not set the required flag in the first place. we skirt the issue using the code below #} {% if field.flags.required and not required in kwargs %} {% set kwargs = dict(required=True, **kwargs) %} {% endif %}
{% if field.widget.input_type == 'checkbox' %} {% call _hz_form_wrap(horizontal_columns, form_type, True, required=required) %} <div class="form-check{% if form_type == "inline" %} form-check-inline{% endif %}"> <label class="form-check-label"> {{ field(class_="form-check-input")|safe }} {{ field.label.text|safe }} </label> </div> {% endcall %} {%- elif field.type == 'RadioField' -%} {# note: A cleaner solution would be rendering depending on the widget, this is just a hack for now, until I can think of something better #} {% call _hz_form_wrap(horizontal_columns, form_type, True, required=required) %} {% for item in field -%} <div class="form-check{% if form_type == "inline" %} form-check-inline{% endif %}"> <label class="form-check-label"> {{ item(class_="form-check-input")|safe }} {{ item.label.text|safe }} </label> </div> {% endfor %} {% endcall %} {%- elif field.type == 'SubmitField' -%} {# deal with jinja scoping issues? #} {% set field_kwargs = kwargs %}
{# note: same issue as above - should check widget, not field type #} {% call _hz_form_wrap(horizontal_columns, form_type, True, required=required) %} {{ field(class='btn btn-%s' % button_map.get(field.name, 'primary'), **field_kwargs) }} {% endcall %} {%- elif field.type == 'FormField' -%} {# note: FormFields are tricky to get right and complex setups requiring these are probably beyond the scope of what this macro tries to do. the code below ensures that things don't break horribly if we run into one, but does not try too hard to get things pretty. #} <fieldset> <legend>{{ field.label }}</legend> {%- for subfield in field %} {% if not is_hidden_wtf_field(subfield) -%} {{ form_field(subfield, form_type=form_type, horizontal_columns=horizontal_columns, button_map=button_map) }} {%- endif %} {%- endfor %} </fieldset> {% else -%} {# Note: Bootstrap 4 no longer supports has-danger. Flask-Bootstrap4 has an issue. #} <div class="form-group {%- if form_type == "horizontal" %} row{% endif -%} {%- if field.flags.required %} required{% endif -%} "> {%- if form_type == "inline" %} {{ field.label(class="sr-only")|safe }} {% if field.type == 'FileField' %} {{ field(class="form-control-file", **kwargs)|safe }} {% else %} {{ field(class="form-control mb-2 mr-sm-2 mb-sm-0" + (" is-invalid" if field.errors else ""), **kwargs)|safe }} {% endif %} {% elif form_type == "horizontal" %} {{ field.label(class="form-control-label " + ( " col-%s-%s" % horizontal_columns[0:2] ))|safe }} <div class=" col-{{ horizontal_columns[0] }}-{{ horizontal_columns[2] }}"> {% if field.type == 'FileField' %} {{ field(class="form-control-file", **kwargs)|safe }} {% else %} {{ field(class="form-control" + (" is-invalid" if field.errors else ""), **kwargs)|safe }} {% endif %} </div> {%- if field.errors %} {%- for error in field.errors %} {% call _hz_form_wrap(horizontal_columns, form_type, required=required) %} <div class="invalid-feedback">{{ error }}</div> {% endcall %} {%- endfor %} {%- elif field.description -%} {% call _hz_form_wrap(horizontal_columns, form_type, required=required) %} <small class="form-text text-muted">{{ field.description|safe }}</small> {% endcall %} {%- endif %} {%- else -%} {{ field.label(class="form-control-label")|safe }} {% if field.type == 'FileField' %} {{ field(class="form-control-file", **kwargs)|safe }} {% else %} {{ field(class="form-control" + (" is-invalid" if field.errors else ""), **kwargs)|safe }} {% endif %}
{%- if field.errors %} {%- for error in field.errors %} <div class="invalid-feedback">{{ error }}</div> {%- endfor %} {%- elif field.description -%} <small class="form-text text-muted">{{ field.description|safe }}</small> {%- endif %} {%- endif %} </div> {% endif %} {% endmacro %}
{# valid form types are "basic", "inline" and "horizontal" #} {% macro quick_form(form, action="", method="post", extra_classes=None, role="form", form_type="basic", horizontal_columns=('lg', 2, 10), enctype=None, button_map={}, id="", novalidate=False, render_kw={}) %} {#- action="" is what we want, from http://www.ietf.org/rfc/rfc2396.txt:
4.2. Same-document References
A URI reference that does not contain a URI is a reference to the current document. In other words, an empty URI reference within a document is interpreted as a reference to the start of that document, and a reference containing only a fragment identifier is a reference to the identified fragment of that document. Traversal of such a reference should not result in an additional retrieval action. However, if the URI reference occurs in a context that is always intended to result in a new request, as in the case of HTML's FORM element, then an empty URI reference represents the base URI of the current document and should be replaced by that URI when transformed into a request.
-#} {#- if any file fields are inside the form and enctype is automatic, adjust if file fields are found. could really use the equalto test of jinja2 here, but latter is not available until 2.8
warning: the code below is guaranteed to make you cry =( #} {%- set _enctype = [] %} {%- if enctype is none -%} {%- for field in form %} {%- if field.type == 'FileField' %} {#- for loops come with a fairly watertight scope, so this list-hack is used to be able to set values outside of it #} {%- set _ = _enctype.append('multipart/form-data') -%} {%- endif %} {%- endfor %} {%- else %} {% set _ = _enctype.append(enctype) %} {%- endif %} <form {%- if action != None %} action="{{ action }}"{% endif -%} {%- if id %} id="{{ id }}"{% endif -%} {%- if method %} method="{{ method }}"{% endif %} class="form {%- if extra_classes %} {{ extra_classes }}{% endif -%} {%- if form_type == "inline" %} form-inline{% endif -%} " {%- if _enctype[0] %} enctype="{{ _enctype[0] }}"{% endif -%} {%- if role %} role="{{ role }}"{% endif -%} {%- if novalidate %} novalidate{% endif -%} {%- if render_kw %} {{ render_kw|xmlattr }}{% endif -%} > {{ form.hidden_tag() }} {{ form_errors(form, hiddens='only') }}
{%- for field in form %} {% if not is_hidden_wtf_field(field) -%} {{ form_field(field, form_type=form_type, horizontal_columns=horizontal_columns, button_map=button_map) }} {%- endif %} {%- endfor %}
</form> {%- endmacro %}
|