pax_global_header 0000666 0000000 0000000 00000000064 14520113325 0014506 g ustar 00root root 0000000 0000000 52 comment=c7be48c07fdb316ab2cb6dd1cda4715ef6e9425a
crispy-bootstrap5-2023.10/ 0000775 0000000 0000000 00000000000 14520113325 0015266 5 ustar 00root root 0000000 0000000 crispy-bootstrap5-2023.10/.github/ 0000775 0000000 0000000 00000000000 14520113325 0016626 5 ustar 00root root 0000000 0000000 crispy-bootstrap5-2023.10/.github/workflows/ 0000775 0000000 0000000 00000000000 14520113325 0020663 5 ustar 00root root 0000000 0000000 crispy-bootstrap5-2023.10/.github/workflows/publish.yml 0000664 0000000 0000000 00000003036 14520113325 0023056 0 ustar 00root root 0000000 0000000 name: Publish Python Package
on:
release:
types: [created]
jobs:
tests:
name: Python ${{ matrix.python-version }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version:
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip install --upgrade tox
- name: Run tox targets for ${{ matrix.python-version }}
run: tox run -f py$(echo ${{ matrix.python-version }} | tr -d .)
deploy:
runs-on: ubuntu-latest
needs: [tests]
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.10"
- uses: actions/cache@v2
name: Configure pip caching
with:
path: ~/.cache/pip
key: ${{ runner.os }}-publish-pip-${{ hashFiles('**/setup.py') }}
restore-keys: |
${{ runner.os }}-publish-pip-
- name: Install dependencies
run: |
pip install build twine
- name: Publish
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
run: |
python -m build
twine upload dist/*
crispy-bootstrap5-2023.10/.github/workflows/test.yml 0000664 0000000 0000000 00000002234 14520113325 0022366 0 ustar 00root root 0000000 0000000 name: Test
on:
push:
branches:
- main
pull_request:
jobs:
tests:
name: Python ${{ matrix.python-version }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version:
- "3.8"
- "3.9"
- "3.10"
- "3.11"
- "3.12"
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip install --upgrade tox
- name: Run tox targets for ${{ matrix.python-version }}
run: tox run -f py$(echo ${{ matrix.python-version }} | tr -d .)
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip tox
- name: Run lint
run: tox -e lint
crispy-bootstrap5-2023.10/.gitignore 0000664 0000000 0000000 00000000157 14520113325 0017261 0 ustar 00root root 0000000 0000000 .venv
__pycache__/
*.py[cod]
*$py.class
venv
.eggs
.pytest_cache
*.egg-info
.DS_Store
.vscode
*python-version
crispy-bootstrap5-2023.10/.pre-commit-config.yaml 0000664 0000000 0000000 00000000423 14520113325 0021546 0 ustar 00root root 0000000 0000000 repos:
- repo: https://github.com/psf/black
rev: 23.3.0
hooks:
- id: black
- repo: https://github.com/pycqa/isort
rev: 5.12.0
hooks:
- id: isort
- repo: https://github.com/pycqa/flake8
rev: 6.0.0
hooks:
- id: flake8 crispy-bootstrap5-2023.10/CHANGELOG.md 0000664 0000000 0000000 00000004371 14520113325 0017104 0 ustar 00root root 0000000 0000000 # CHANGELOG FOR CRISPY-BOOTSTRAP5
## 2023.10 (2023-10-2023)
* Added Django 5.0 and 4.2 support
* Added Python 3.11 and 3.12 support
* Dropped Python 3.7 support
* Dropped Django 3.2, 4.0 and 4.1 support
* Switched to CalVer versioning
See [Milestones](https://github.com/django-crispy-forms/crispy-bootstrap5/milestone/8?closed=1) for full change log.
## 0.7 (2022-09-28)
* Added Django 4.1 support
See [Milestones](https://github.com/django-crispy-forms/crispy-bootstrap5/milestones?state=closed) for for change list.
## 0.6 (2021-09-28)
* Added Django 4.0 support
## 0.5 (2021-08-20)
* Added support for [Accordion Flush](https://getbootstrap.com/docs/5.0/components/accordion/#flush) and
[Always Open](https://getbootstrap.com/docs/5.0/components/accordion/#always-open) (#63)
* Added support for grouped inputs (#64)
* Added support for clearable file field (#53)
* Removed various `|safe` filters in templates
See [Milestones](https://github.com/django-crispy-forms/crispy-bootstrap5/milestone/6?closed=1) for full changelog.
## 0.4 (2021-05-27)
* Added support for Bootstrap 5 Floating Labels (#42)
* Dropped support for Django 3.0
* Added support for Django 3.2
See [Milestones](https://github.com/django-crispy-forms/crispy-bootstrap5/milestone/5?closed=1) for full changelog.
## 0.3.1(2021-03-03)
* Fixed classes for `row` layout object (#36)
See [Milestones](https://github.com/django-crispy-forms/crispy-bootstrap5/milestone/4?closed=1) for full changelog.
## 0.3 (2021-02-21)
* Fixed rendering of select widgets (#31)
See [Milestones](https://github.com/django-crispy-forms/crispy-bootstrap5/milestone/3?closed=1) for full changelog.
## 0.2 (2021-01-31)
* Tested for compatibility with Bootstrap5 Beta 1
* Fixed InlineField (#28)
* Implemented new Bootstrap5 accordion (#24)
* Improved tests and fixed rendering of blank attributes (#23)
See [Milestones](https://github.com/django-crispy-forms/crispy-bootstrap5/milestone/2) for full changelog.
## 0.1 (2020-11-19)
* Initial release, compatibility with Bootstrap5 Alpha 3
* Converted templates from Bootstrap 4, and initial set of fixes
* Brought forward Bootstrap 4 test suite and updated for Bootstrap5
See [Milestones](https://github.com/django-crispy-forms/crispy-bootstrap5/milestone/1) for full changelog.
crispy-bootstrap5-2023.10/LICENSE 0000664 0000000 0000000 00000002060 14520113325 0016271 0 ustar 00root root 0000000 0000000 Copyright (c) 2020 David Smith and contributors.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE. crispy-bootstrap5-2023.10/MANIFEST.in 0000664 0000000 0000000 00000000145 14520113325 0017024 0 ustar 00root root 0000000 0000000 include LICENSE
include MANIFEST.in
include README.md
recursive-include crispy_bootstrap5/templates * crispy-bootstrap5-2023.10/README.md 0000664 0000000 0000000 00000003757 14520113325 0016561 0 ustar 00root root 0000000 0000000 # crispy-bootstrap5
[](https://github.com/smithdc1/crispy-bootstrap5/blob/main/LICENSE)
Bootstrap5 template pack for django-crispy-forms
## Installation
Install this plugin using `pip`:
```bash
$ pip install crispy-bootstrap5
```
## Usage
You will need to update your project's settings file to add ``crispy_forms``
and ``crispy_bootstrap5`` to your projects ``INSTALLED_APPS``. Also set
``bootstrap5`` as and allowed template pack and as the default template pack
for your project
```python
INSTALLED_APPS = (
...
"crispy_forms",
"crispy_bootstrap5",
...
)
CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"
CRISPY_TEMPLATE_PACK = "bootstrap5"
```
## What's new?
Bootstrap 5 introduces [floating labels](https://getbootstrap.com/docs/5.0/forms/floating-labels/).
This template pack include a layout object to use this input type
```python
from crispy_bootstrap5.bootstrap5 import FloatingField
# then in your Layout
... Layout(
FloatingField("first_name"),
)
```
Accordions also have new features, such as [Accordion flush](https://getbootstrap.com/docs/5.0/components/accordion/#flush) and [Always open](https://getbootstrap.com/docs/5.0/components/accordion/#always-open).
There is a new layout object to use them
```python
from crispy_bootstrap5.bootstrap5 import BS5Accordion
# then in your Layout
# if not informed, flush and always_open default to False
... Layout(
BS5Accordion(
AccordionGroup("group name", "form_field_1", "form_field_2"),
AccordionGroup("another group name", "form_field"),
flush=True,
always_open=True
)
)
```
## Development
To contribute to this library, first checkout the code. Then create a new virtual environment:
```bash
cd crispy-bootstrap5
python -mvenv venv
source venv/bin/activate
```
Or if you are using `pipenv`:
```bash
pipenv shell
```
Now install the dependencies and tests:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
pytest
```
crispy-bootstrap5-2023.10/crispy_bootstrap5/ 0000775 0000000 0000000 00000000000 14520113325 0020761 5 ustar 00root root 0000000 0000000 crispy-bootstrap5-2023.10/crispy_bootstrap5/__init__.py 0000664 0000000 0000000 00000000030 14520113325 0023063 0 ustar 00root root 0000000 0000000 __version__ = "2023.10"
crispy-bootstrap5-2023.10/crispy_bootstrap5/bootstrap5.py 0000664 0000000 0000000 00000001636 14520113325 0023443 0 ustar 00root root 0000000 0000000 from crispy_forms.bootstrap import Accordion
from crispy_forms.layout import Field
class FloatingField(Field):
template = "bootstrap5/layout/floating_field.html"
class BS5Accordion(Accordion):
"""
Bootstrap5 Accordion menu object. It wraps `AccordionGroup` objects in a
container. It also allows the usage of accordion-flush, introduced in bootstrap5::
BS5Accordion(
AccordionGroup("group name", "form_field_1", "form_field_2"),
AccordionGroup("another group name", "form_field"),
flush=True,
always_open=True
)
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.flush = kwargs.pop("flush", False)
self.always_open = kwargs.pop("always_open", False)
if self.always_open:
for accordion_group in self.fields:
accordion_group.always_open = True
crispy-bootstrap5-2023.10/crispy_bootstrap5/templates/ 0000775 0000000 0000000 00000000000 14520113325 0022757 5 ustar 00root root 0000000 0000000 crispy-bootstrap5-2023.10/crispy_bootstrap5/templates/bootstrap5/ 0000775 0000000 0000000 00000000000 14520113325 0025061 5 ustar 00root root 0000000 0000000 crispy-bootstrap5-2023.10/crispy_bootstrap5/templates/bootstrap5/accordion-group.html 0000664 0000000 0000000 00000001244 14520113325 0031043 0 ustar 00root root 0000000 0000000
{% endif %}
crispy-bootstrap5-2023.10/crispy_bootstrap5/templates/bootstrap5/field.html 0000664 0000000 0000000 00000007626 14520113325 0027045 0 ustar 00root root 0000000 0000000 {% load crispy_forms_field %}
{% if field.is_hidden %}
{{ field }}
{% else %}
{% if field|is_checkbox and tag != "td" %}
{% if label_class %}
{% endif %}
{% endif %}
<{% if tag %}{{ tag }}{% else %}div{% endif %} id="div_{{ field.auto_id }}" class="mb-3{% if field|is_checkbox and form_show_labels %} form-check{% else %}{% if 'form-horizontal' in form_class %} row{% endif %}{% endif %}{% if wrapper_class %} {{ wrapper_class }}{% endif %}{% if field.css_classes %} {{ field.css_classes }}{% endif %}">
{% if field.label and not field|is_checkbox and form_show_labels %}
{# not field|is_radioselect in row below can be removed once Django 3.2 is no longer supported #}
{% endif %}
{% if field|is_checkboxselectmultiple or field|is_radioselect %}
{% include 'bootstrap5/layout/radio_checkbox_select.html' %}
{% endif %}
{% if not field|is_checkboxselectmultiple and not field|is_radioselect %}
{% if field|is_checkbox and form_show_labels %}
{% if field.errors %}
{% crispy_field field 'class' 'form-check-input is-invalid' %}
{% else %}
{% crispy_field field 'class' 'form-check-input' %}
{% endif %}
{% include 'bootstrap5/layout/help_text_and_errors.html' %}
{% else %}
{% if field_class %}
{% endif %}
{% if field|is_file %}
{% include 'bootstrap5/layout/field_file.html' %}
{% elif field|is_select %}
{% if field.errors %}
{% crispy_field field 'class' 'form-select is-invalid' %}
{% else %}
{% crispy_field field 'class' 'form-select' %}
{% endif %}
{% elif field|is_checkbox %}
{% if field.errors %}
{% crispy_field field 'class' 'form-check-input is-invalid' %}
{% else %}
{% crispy_field field 'class' 'form-check-input' %}
{% endif %}
{% elif field.errors %}
{% crispy_field field 'class' 'form-control is-invalid' %}
{% else %}
{% crispy_field field 'class' 'form-control' %}
{% endif %}
{% if not field|is_file %}
{% include 'bootstrap5/layout/help_text_and_errors.html' %}
{% endif %}
{% if field_class %}
{% endif %}
{% endif %}
{% endif %}
{% if field|is_checkbox and tag != "td" %}
{% if label_class %}
{% for group, options, index in field|optgroups %}
{% if group %}{{ group }}{% endif %}
{% for option in options %}
{% if field.errors and forloop.last and not inline_class and forloop.parentloop.last %}
{% include 'bootstrap5/layout/field_errors_block.html' %}
{% endif %}
{% endfor %}
{% endfor %}
{% if field.errors and inline_class %}
{% for error in field.errors %}
Got prefix: {{ prefix }}.
{% include "bootstrap5/whole_uni_form.html" %}
Got suffix: {{ suffix }}.
crispy-bootstrap5-2023.10/tests/test_form_helper.py 0000664 0000000 0000000 00000046705 14520113325 0022357 0 ustar 00root root 0000000 0000000 import re
import pytest
from crispy_forms.bootstrap import (
AppendedText,
FieldWithButtons,
PrependedAppendedText,
PrependedText,
StrictButton,
)
from crispy_forms.helper import FormHelper, FormHelpersException
from crispy_forms.layout import Button, Hidden, Layout, Reset, Submit
from crispy_forms.templatetags.crispy_forms_tags import CrispyFormNode
from crispy_forms.utils import render_crispy_form
from django import forms
from django.forms.models import formset_factory
from django.middleware.csrf import _get_new_csrf_string
from django.template import Context, Template
from django.urls import reverse
from django.utils.translation import gettext_lazy as _
from .forms import SampleForm, SampleForm7, SampleForm8, SampleFormWithMedia
def test_inputs():
form_helper = FormHelper()
form_helper.add_input(Submit("my-submit", "Submit", css_class="button white"))
form_helper.add_input(Reset("my-reset", "Reset"))
form_helper.add_input(Hidden("my-hidden", "Hidden"))
form_helper.add_input(Button("my-button", "Button"))
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form form_helper %}
"""
)
c = Context({"form": SampleForm(), "form_helper": form_helper})
html = template.render(c)
assert "button white" in html
assert 'id="submit-id-my-submit"' in html
assert 'id="reset-id-my-reset"' in html
assert 'name="my-hidden"' in html
assert 'id="button-id-my-button"' in html
assert 'class="btn"' in html
assert "btn btn-primary" in html
assert "btn btn-inverse" in html
assert len(re.findall(r"]+> <", html)) == 9
def test_invalid_form_method():
form_helper = FormHelper()
with pytest.raises(FormHelpersException):
form_helper.form_method = "superPost"
def test_form_with_helper_without_layout(settings):
form_helper = FormHelper()
form_helper.form_id = "this-form-rocks"
form_helper.form_class = "forms-that-rock"
form_helper.form_method = "GET"
form_helper.form_action = "simpleAction"
form_helper.form_error_title = "ERRORS"
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy testForm form_helper %}
"""
)
# now we render it, with errors
form = SampleForm({"password1": "wargame", "password2": "god"})
form.is_valid()
c = Context({"testForm": form, "form_helper": form_helper})
html = template.render(c)
# Lets make sure everything loads right
assert html.count("Passwords dont match" in html
# now lets remove the form tag and render it again. All the True items above
# should now be false because the form tag is removed.
form_helper.form_tag = False
html = template.render(c)
assert "Passwords dont match" in html
assert str(_("This field is required.")) in html
assert "error" in html
# Now we render without errors
form.helper.form_show_errors = False
c = Context({"testForm": form})
html = template.render(c)
# Ensure errors were not rendered
assert "
Passwords dont match
" not in html
assert str(_("This field is required.")) not in html
assert "error" not in html
def test_html5_required():
form = SampleForm()
form.helper = FormHelper()
form.helper.html5_required = True
html = render_crispy_form(form)
# 6 out of 7 fields are required and an extra one for the
# SplitDateTimeWidget makes 7.
assert len(re.findall(r"\brequired\b", html)) == 7
form = SampleForm()
form.helper = FormHelper()
form.helper.html5_required = False
html = render_crispy_form(form)
def test_media_is_included_by_default_with_bootstrap5():
form = SampleFormWithMedia()
form.helper = FormHelper()
form.helper.template_pack = "bootstrap5"
html = render_crispy_form(form)
assert "test.css" in html
assert "test.js" in html
def test_media_removed_when_include_media_is_false_with_bootstrap5():
form = SampleFormWithMedia()
form.helper = FormHelper()
form.helper.template_pack = "bootstrap5"
form.helper.include_media = False
html = render_crispy_form(form)
assert "test.css" not in html
assert "test.js" not in html
def test_attrs():
form = SampleForm()
form.helper = FormHelper()
form.helper.attrs = {"id": "TestIdForm", "autocomplete": "off"}
html = render_crispy_form(form)
assert 'autocomplete="off"' in html
assert 'id="TestIdForm"' in html
def test_template_context():
helper = FormHelper()
helper.attrs = {
"id": "test-form",
"class": "test-forms",
"action": "submit/test/form",
"autocomplete": "off",
}
node = CrispyFormNode("form", "helper")
context = node.get_response_dict(helper, {}, False)
assert context["form_id"] == "test-form"
assert context["form_attrs"]["id"] == "test-form"
assert "test-forms" in context["form_class"]
assert "test-forms" in context["form_attrs"]["class"]
assert context["form_action"] == "submit/test/form"
assert context["form_attrs"]["action"] == "submit/test/form"
assert context["form_attrs"]["autocomplete"] == "off"
def test_template_context_using_form_attrs():
helper = FormHelper()
helper.form_id = "test-form"
helper.form_class = "test-forms"
helper.form_action = "submit/test/form"
node = CrispyFormNode("form", "helper")
context = node.get_response_dict(helper, {}, False)
assert context["form_id"] == "test-form"
assert context["form_attrs"]["id"] == "test-form"
assert "test-forms" in context["form_class"]
assert "test-forms" in context["form_attrs"]["class"]
assert context["form_action"] == "submit/test/form"
assert context["form_attrs"]["action"] == "submit/test/form"
def test_template_helper_access():
helper = FormHelper()
helper.form_id = "test-form"
assert helper["form_id"] == "test-form"
def test_without_helper():
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form %}
"""
)
c = Context({"form": SampleForm()})
html = template.render(c)
# Lets make sure everything loads right
assert "')
assert contains_partial(html, '')
def test_render_required_fields():
test_form = SampleForm()
test_form.helper = FormHelper()
test_form.helper.layout = Layout("email")
test_form.helper.render_required_fields = True
html = render_crispy_form(test_form)
assert html.count("Special custom form" in html
def test_helper_custom_field_template():
form = SampleForm()
form.helper = FormHelper()
form.helper.layout = Layout("password1", "password2")
form.helper.field_template = "custom_field_template.html"
html = render_crispy_form(form)
assert html.count("
Special custom field
") == 2
def test_helper_custom_field_template_no_layout():
form = SampleForm()
form.helper = FormHelper()
form.helper.field_template = "custom_field_template.html"
html = render_crispy_form(form)
for field in form.fields:
assert html.count('id="div_id_%s"' % field) == 1
assert html.count("
')
assert help_position < error_position
# Viceversa
form = SampleForm({"email": "invalidemail"})
form.helper = FormHelper()
form.helper.error_text_inline = True
form.helper.help_text_inline = False
form.helper.layout = Layout("email")
form.is_valid()
html = render_crispy_form(form)
# Check that error goes before help, otherwise CSS won't work
error_position = html.find('')
help_position = html.find('
')
assert error_position < help_position
def test_form_show_labels():
form = SampleForm()
form.helper = FormHelper()
form.helper.layout = Layout(
"password1",
FieldWithButtons("password2", StrictButton("Confirm")),
PrependedText("first_name", "Mr."),
AppendedText("last_name", "@"),
PrependedAppendedText("datetime_field", "on", "secs"),
)
form.helper.form_show_labels = False
html = render_crispy_form(form)
assert html.count("' in html
assert '
' in html
assert html.count("col-lg-8") == 7
# TODO FIX THIS TEST
# assert "offset" not in html
form.helper.label_class = "col-sm-3 col-md-4"
form.helper.field_class = "col-sm-8 col-md-6"
html = render_crispy_form(form)
assert '
' in html
assert '
' in html
assert html.count("col-sm-8") == 7
# TODO FIX THIS TEST
# assert "offset" not in html
def test_label_class_and_field_class_bs5_offset_when_horizontal():
# Test col-XX-YY pattern
form = SampleForm()
form.helper = FormHelper()
form.helper.label_class = "col-lg-2"
form.helper.field_class = "col-lg-8"
form.helper.form_class = "form-horizontal"
html = render_crispy_form(form)
assert '
' in html
assert '
' in html
assert html.count("col-lg-8") == 7
# Test multi col-XX-YY pattern and col-X pattern
form.helper.label_class = "col-sm-3 col-md-4 col-5 col-lg-4"
form.helper.field_class = "col-sm-8 col-md-6 col-7 col-lg-8"
html = render_crispy_form(form)
assert '
' in html
assert (
'
' in html
)
assert html.count("col-sm-8") == 7
assert html.count("col-md-6") == 7
assert html.count("col-7") == 7
assert html.count("col-lg-8") == 7
def test_form_group_with_form_inline_bs5():
form = SampleForm()
form.helper = FormHelper()
html = render_crispy_form(form)
assert '
' in html
# .row class shouldn't be together with .form-group in inline forms
form = SampleForm()
form.helper = FormHelper()
form.helper.form_class = "form-inline"
form.helper.field_template = "bootstrap5/layout/inline_field.html"
html = render_crispy_form(form)
assert '
' not in html
def test_passthrough_context():
"""
Test to ensure that context is passed through implicitly from outside of
the crispy form into the crispy form templates.
"""
form = SampleForm()
form.helper = FormHelper()
form.helper.template = "custom_form_template_with_context.html"
c = {"prefix": "foo", "suffix": "bar"}
html = render_crispy_form(form, helper=form.helper, context=c)
assert "Got prefix: foo" in html
assert "Got suffix: bar" in html
crispy-bootstrap5-2023.10/tests/test_layout.py 0000664 0000000 0000000 00000046125 14520113325 0021366 0 ustar 00root root 0000000 0000000 import django
import pytest
from crispy_forms.bootstrap import (
AppendedText,
Field,
FieldWithButtons,
InlineCheckboxes,
PrependedAppendedText,
PrependedText,
StrictButton,
)
from crispy_forms.helper import FormHelper
from crispy_forms.layout import HTML, Column, Fieldset, Layout, Row
from crispy_forms.utils import render_crispy_form
from django import forms
from django.forms.models import formset_factory, modelformset_factory
from django.middleware.csrf import _get_new_csrf_string
from django.shortcuts import render
from django.template import Context, Template
from django.test import override_settings
from django.urls import reverse
from django.utils.translation import gettext_lazy as _
from .forms import (
CheckboxesSampleForm,
CrispyEmptyChoiceTestModel,
CrispyTestModel,
FileForm,
FileFormRequired,
HelpTextForm,
InputsForm,
LabelForm,
SampleForm,
SampleForm2,
SampleForm3,
SampleForm4,
SampleForm6,
)
from .utils import contains_partial, parse_expected, parse_form
CONVERTERS = {
"textinput": "inputtext textinput textInput",
"fileinput": "fileinput fileUpload",
"passwordinput": "textinput textInput",
}
def test_invalid_unicode_characters(settings):
# Adds a BooleanField that uses non valid unicode characters "ñ"
form_helper = FormHelper()
form_helper.add_layout(Layout("españa"))
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form form_helper %}
"""
)
c = Context({"form": SampleForm(), "form_helper": form_helper})
settings.CRISPY_FAIL_SILENTLY = False
with pytest.raises(Exception):
template.render(c)
def test_unicode_form_field():
class UnicodeForm(forms.Form):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.fields["contraseña"] = forms.CharField()
helper = FormHelper()
helper.layout = Layout("contraseña")
html = render_crispy_form(UnicodeForm())
assert 'id="id_contraseña"' in html
def test_meta_extra_fields_with_missing_fields():
class FormWithMeta(SampleForm):
class Meta:
fields = ("email", "first_name", "last_name")
form = FormWithMeta()
# We remove email field on the go
del form.fields["email"]
form_helper = FormHelper()
form_helper.layout = Layout("first_name")
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form form_helper %}
"""
)
c = Context({"form": form, "form_helper": form_helper})
html = template.render(c)
assert "email" not in html
def test_layout_unresolved_field(settings):
form_helper = FormHelper()
form_helper.add_layout(Layout("typo"))
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form form_helper %}
"""
)
c = Context({"form": SampleForm(), "form_helper": form_helper})
settings.CRISPY_FAIL_SILENTLY = False
with pytest.raises(Exception):
template.render(c)
def test_double_rendered_field(settings):
form_helper = FormHelper()
form_helper.add_layout(Layout("is_company", "is_company"))
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form form_helper %}
"""
)
c = Context({"form": SampleForm(), "form_helper": form_helper})
settings.CRISPY_FAIL_SILENTLY = False
with pytest.raises(Exception):
template.render(c)
def test_context_pollution():
class ExampleForm(forms.Form):
comment = forms.CharField()
form = ExampleForm()
form2 = SampleForm()
template = Template(
"""
{% load crispy_forms_tags %}
{{ form.as_ul }}
{% crispy form2 %}
{{ form.as_ul }}
"""
)
c = Context({"form": form, "form2": form2})
html = template.render(c)
assert html.count('name="comment"') == 2
assert html.count('name="is_company"') == 1
def test_layout_fieldset_row_html_with_unicode_fieldnames():
form_helper = FormHelper()
form_helper.add_layout(
Layout(
Fieldset(
"Company Data",
"is_company",
css_id="fieldset_company_data",
css_class="fieldsets",
title="fieldset_title",
test_fieldset="123",
),
Fieldset(
"User Data",
"email",
Row(
"password1",
"password2",
css_id="row_passwords",
css_class="rows",
),
HTML('test link'),
HTML(
"""
{% if flag %}{{ message }}{% endif %}
"""
),
"first_name",
"last_name",
),
)
)
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form form_helper %}
"""
)
c = Context(
{
"form": SampleForm(),
"form_helper": form_helper,
"flag": True,
"message": "Hello!",
}
)
html = template.render(c)
assert 'id="fieldset_company_data"' in html
assert 'class="fieldsets' in html
assert 'title="fieldset_title"' in html
assert 'test-fieldset="123"' in html
assert 'id="row_passwords"' in html
assert html.count("click me"""),
)
),
)
)
if django.VERSION < (5, 0):
expected = "field_with_buttons_lt50.html"
else:
expected = "field_with_buttons.html"
assert parse_form(form) == parse_expected(expected)
form = SampleForm3({})
form.helper = FormHelper()
form.helper.add_layout(
Layout(
Column(
FieldWithButtons(
"email", StrictButton("Go!", css_class="btn-outline-secondary")
)
),
)
)
if django.VERSION < (5, 0):
expected = "field_with_buttons_failing_lt50.html"
else:
expected = "field_with_buttons_failing.html"
assert parse_form(form) == parse_expected(expected)
@override_settings(CRISPY_CLASS_CONVERTERS=CONVERTERS)
def test_formset_layout():
SampleFormSet = formset_factory(SampleForm, extra=3)
formset = SampleFormSet()
helper = FormHelper()
helper.form_id = "thisFormsetRocks"
helper.form_class = "formsets-that-rock"
helper.form_method = "POST"
helper.form_action = "simpleAction"
helper.layout = Layout(
Fieldset(
"Item {{ forloop.counter }}",
"is_company",
"email",
),
HTML("{% if forloop.first %}Note for first form only{% endif %}"),
Row("password1", "password2"),
Fieldset("", "first_name", "last_name"),
)
html = render_crispy_form(
form=formset, helper=helper, context={"csrf_token": _get_new_csrf_string()}
)
# Check formset fields
assert contains_partial(
html,
'',
)
assert contains_partial(
html,
'',
)
assert contains_partial(
html,
'',
)
assert contains_partial(
html,
'',
)
assert html.count("hidden") == 5
# Check form structure
assert html.count("',
)
assert contains_partial(
html,
'',
)
assert contains_partial(
html,
'',
)
assert html.count('name="form-0-email"') == 1
assert html.count('name="form-1-email"') == 1
assert html.count('name="form-2-email"') == 1
assert html.count('name="form-3-email"') == 0
assert html.count("password") == 0
def test_i18n():
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form form.helper %}
"""
)
form = SampleForm()
form_helper = FormHelper()
form_helper.layout = Layout(
HTML(_("i18n text")),
Fieldset(
_("i18n legend"),
"first_name",
"last_name",
),
)
form.helper = form_helper
html = template.render(Context({"form": form}))
assert html.count("i18n legend") == 1
def test_default_layout():
test_form = SampleForm2()
assert test_form.helper.layout.fields == [
"is_company",
"email",
"password1",
"password2",
"first_name",
"last_name",
"datetime_field",
]
def test_default_layout_two():
test_form = SampleForm3()
assert test_form.helper.layout.fields == ["email"]
def test_modelform_layout_without_meta():
test_form = SampleForm4()
test_form.helper = FormHelper()
test_form.helper.layout = Layout("email")
html = render_crispy_form(test_form)
assert "email" in html
assert "password" not in html
def test_specialspaceless_not_screwing_intended_spaces():
# see issue #250
test_form = SampleForm()
test_form.fields["email"].widget = forms.Textarea()
test_form.helper = FormHelper()
test_form.helper.layout = Layout(
"email", HTML("first spansecond span")
)
html = render_crispy_form(test_form)
assert "first spansecond span" in html
def test_choice_with_none_is_selected():
# see issue #701
model_instance = CrispyEmptyChoiceTestModel()
model_instance.fruit = None
test_form = SampleForm6(instance=model_instance)
html = render_crispy_form(test_form)
assert "checked" in html
def test_keepcontext_context_manager():
# Test case for issue #180
# Apparently it only manifest when using render_to_response this exact way
form = CheckboxesSampleForm()
form.helper = FormHelper()
# We use here InlineCheckboxes as it updates context in an unsafe way
form.helper.layout = Layout(
"checkboxes", InlineCheckboxes("alphacheckboxes"), "numeric_multiple_checkboxes"
)
context = {"form": form}
response = render(
request=None, template_name="crispy_render_template.html", context=context
)
print(response.content)
assert response.content.count(b"form-check-inline") == 3
assert response.content.count(b"form-check-input") > 0
@override_settings(CRISPY_CLASS_CONVERTERS=CONVERTERS)
def test_bootstrap5_form_inline():
form = SampleForm()
form.helper = FormHelper()
form.helper.form_class = "form-inline"
form.helper.field_template = "bootstrap5/layout/inline_field.html"
form.helper.layout = Layout("email", "password1", "last_name")
form.helper.form_class = "row row-cols-lg-auto"
if django.VERSION < (5, 0):
expected = "test_bootstrap5_form_inline_lt50.html"
else:
expected = "test_bootstrap5_form_inline.html"
assert parse_form(form) == parse_expected(expected)
def test_select():
form = InputsForm()
form.helper = FormHelper()
form.helper.layout = Layout("select_input")
assert parse_form(form) == parse_expected("test_select.html")
def test_select_prepended():
form = InputsForm()
form.helper = FormHelper()
form.helper.layout = Layout(
PrependedText("select_input", "bar"),
AppendedText("select_input", "bar"),
PrependedAppendedText("select_input", "£", ".00"),
)
assert parse_form(form) == parse_expected("test_prepended_appended_select.html")
def test_update_attributes_class():
form = SampleForm()
form.helper = FormHelper()
form.helper.layout = Layout("email", Field("password1"), "password2")
form.helper["password1"].update_attributes(css_class="hello")
html = render_crispy_form(form)
assert html.count(' class="hello') == 1
form.helper = FormHelper()
form.helper.layout = Layout(
"email",
Field("password1", css_class="hello"),
"password2",
)
form.helper["password1"].update_attributes(css_class="hello2")
html = render_crispy_form(form)
assert html.count(' class="hello hello2') == 1
def test_file_field():
form = FileForm()
form.helper = FormHelper()
form.helper.layout = Layout("clearable_file")
assert parse_form(form) == parse_expected("test_clearable_file_field.html")
form.helper.layout = Layout("file_field")
assert parse_form(form) == parse_expected("test_file_field.html")
form = FileFormRequired({})
form.helper = FormHelper()
form.helper.layout = Layout("clearable_file")
if django.VERSION < (5, 0):
expected = "test_clearable_file_field_failing_lt50.html"
else:
expected = "test_clearable_file_field_failing.html"
assert parse_form(form) == parse_expected(expected)
form.helper.layout = Layout("file_field")
if django.VERSION < (5, 0):
expected = "test_file_field_failing_lt50.html"
else:
expected = "test_file_field_failing.html"
assert parse_form(form) == parse_expected(expected)
def test_row():
form = SampleForm()
form.helper = FormHelper()
form.helper.layout = Layout(
Row(
Column("first_name"),
Column("last_name"),
)
)
assert parse_form(form) == parse_expected("row.html")
def test_html_label_escape():
form = LabelForm()
form.helper = FormHelper()
form.helper.layout = Layout("text_input")
html = render_crispy_form(form)
assert "<>&" in html
@override_settings(CRISPY_CLASS_CONVERTERS=CONVERTERS)
def test_tabular_formset_layout():
SampleFormSet = formset_factory(SampleForm, extra=3)
formset = SampleFormSet()
formset.helper = FormHelper()
formset.helper.template = "bootstrap5/table_inline_formset.html"
if django.VERSION < (5, 0):
expected = "test_tabular_formset_layout_lt50.html"
else:
expected = "test_tabular_formset_layout.html"
assert parse_form(formset) == parse_expected(expected)
SampleFormSet = formset_factory(SampleForm, extra=3)
data = {
"form-TOTAL_FORMS": "1",
"form-INITIAL_FORMS": "0",
}
formset = SampleFormSet(data)
formset.helper = FormHelper()
formset.helper.template = "bootstrap5/table_inline_formset.html"
if django.VERSION < (5, 0):
expected = "test_tabular_formset_layout_failing_lt50.html"
else:
expected = "test_tabular_formset_layout_failing.html"
assert parse_form(formset) == parse_expected(expected)
def test_flat_attrs_safe():
form = SampleForm()
form.helper = FormHelper()
form.helper.layout = Layout(
Row(
aria_labelledby="test<>%",
)
)
form.helper.form_tag = False
assert parse_form(form) == parse_expected("flat_attrs.html")
def test_help_text_no_escape():
form = HelpTextForm()
form.helper = FormHelper()
form.helper.form_tag = False
if django.VERSION < (5, 0):
expected = "help_text_escape_lt50.html"
else:
expected = "help_text_escape.html"
assert parse_form(form) == parse_expected(expected)
crispy-bootstrap5-2023.10/tests/test_layout_objects.py 0000664 0000000 0000000 00000045474 14520113325 0023105 0 ustar 00root root 0000000 0000000 import random
import django
import pytest
from crispy_forms.bootstrap import (
Accordion,
AccordionGroup,
Alert,
AppendedText,
FieldWithButtons,
InlineCheckboxes,
InlineField,
InlineRadios,
PrependedAppendedText,
PrependedText,
StrictButton,
Tab,
TabHolder,
)
from crispy_forms.helper import FormHelper
from crispy_forms.layout import HTML, Field, Layout, MultiWidgetField
from crispy_forms.utils import render_crispy_form
from django import forms
from django.template import Context, Template
from django.test import override_settings
from django.utils.translation import activate, deactivate
from django.utils.translation import gettext as _
from crispy_bootstrap5.bootstrap5 import BS5Accordion, FloatingField
from .forms import (
CheckboxesSampleForm,
CustomCheckboxSelectMultiple,
CustomRadioSelect,
GroupedChoiceForm,
InputsForm,
SampleForm,
SampleFormCustomWidgets,
)
from .utils import parse_expected, parse_form
CONVERTERS = {
"textinput": "inputtext textinput textInput",
"fileinput": "fileinput fileUpload",
"passwordinput": "textinput textInput",
}
def test_field_with_custom_template():
test_form = SampleForm()
test_form.helper = FormHelper()
test_form.helper.layout = Layout(
Field("email", template="custom_field_template.html")
)
html = render_crispy_form(test_form)
assert "
Special custom field
" in html
def test_multiwidget_field():
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy form %}
"""
)
test_form = SampleForm()
test_form.helper = FormHelper()
test_form.helper.layout = Layout(
MultiWidgetField(
"datetime_field",
attrs=(
{"rel": "test_dateinput"},
{"rel": "test_timeinput", "style": "width: 30px;", "type": "hidden"},
),
)
)
c = Context({"form": test_form})
html = template.render(c)
assert html.count('class="dateinput') == 1
assert html.count('rel="test_dateinput"') == 1
assert html.count('rel="test_timeinput"') == 2
assert html.count('style="width: 30px;"') == 2
assert html.count('type="hidden"') == 2
def test_field_type_hidden():
template = Template(
"""
{% load crispy_forms_tags %}
{% crispy test_form %}
"""
)
test_form = SampleForm()
test_form.helper = FormHelper()
test_form.helper.layout = Layout(
Field("email", type="hidden", data_test=12),
Field("datetime_field"),
)
c = Context({"test_form": test_form})
html = template.render(c)
# Check form parameters
assert html.count('data-test="12"') == 1
assert html.count('name="email"') == 1
assert html.count('class="dateinput') == 1
assert html.count('class="timeinput') == 1
def test_field_wrapper_class(settings):
form = SampleForm()
form.helper = FormHelper()
form.helper.layout = Layout(Field("email", wrapper_class="testing"))
html = render_crispy_form(form)
if settings.CRISPY_TEMPLATE_PACK == "bootstrap":
assert html.count('class="control-group testing"') == 1
elif settings.CRISPY_TEMPLATE_PACK in ("bootstrap3", "bootstrap4"):
assert html.count('class="form-group testing"') == 1
def test_html_with_carriage_returns(settings):
test_form = SampleForm()
test_form.helper = FormHelper()
test_form.helper.layout = Layout(
HTML(
"""
if (a==b){
// some comment
a+1;
foo();
}
"""
)
)
html = render_crispy_form(test_form)
if settings.CRISPY_TEMPLATE_PACK == "uni_form":
assert html.count("\n") == 23
elif settings.CRISPY_TEMPLATE_PACK == "bootstrap":
assert html.count("\n") == 25
else:
assert html.count("\n") == 27
def test_i18n():
activate("es")
form = SampleForm()
form.helper = FormHelper()
form.helper.layout = Layout(HTML(_("Enter a valid value.")))
html = render_crispy_form(form)
assert "Introduzca un valor válido" in html
deactivate()
def test_remove_labels():
form = SampleForm()
# remove boolean field as label is still printed in boostrap
del form.fields["is_company"]
for fields in form:
fields.label = False
html = render_crispy_form(form)
assert "&", "gmail.com", css_class="form-control-lg"
),
AppendedText("password1", "#"),
PrependedText("password2", "$"),
)
if django.VERSION < (5, 0):
expected = "test_prepended_appended_text_lt50.html"
else:
expected = "test_prepended_appended_text.html"
assert parse_form(test_form) == parse_expected(expected)
def test_inline_radios(self):
test_form = CheckboxesSampleForm()
test_form.helper = FormHelper()
test_form.helper.layout = Layout(InlineRadios("inline_radios"))
html = render_crispy_form(test_form)
assert html.count('form-check-inline"') == 2
@override_settings(CRISPY_CLASS_CONVERTERS=CONVERTERS)
def test_accordion_and_accordiongroup(self):
random.seed(0)
form = SampleForm()
form.helper = FormHelper()
form.helper.form_tag = False
form.helper.layout = Layout(
Accordion(
AccordionGroup("one", "first_name"),
AccordionGroup("two", "password1", "password2"),
)
)
assert parse_form(form) == parse_expected("accordion.html")
def test_accordion_active_false_not_rendered(self):
test_form = SampleForm()
test_form.helper = FormHelper()
test_form.helper.layout = Layout(
Accordion(
AccordionGroup("one", "first_name"),
# there is no ``active`` kwarg here.
)
)
# The first time, there should be one of them there.
html = render_crispy_form(test_form)
accordion_class = "collapse show"
assert (
html.count('
everything is fine
test_form = SampleForm()
html = render_crispy_form(test_form)
# second render of form => first tab should be active,
# but not duplicate class
test_form = SampleForm()
html = render_crispy_form(test_form)
assert html.count('class="nav-item active active"') == 0
# render a new form, now with errors
test_form = SampleForm(data={"val1": "foo"})
html = render_crispy_form(test_form)
tab_class = "tab-pane"
# if settings.CRISPY_TEMPLATE_PACK == 'bootstrap4':
# tab_class = 'nav-link'
# else:
# tab_class = 'tab-pane'
# tab 1 should not be active
assert html.count('
Passwords dont match" in html
assert "
" not in html
def test_as_crispy_errors_formset_without_non_form_errors():
template = Template(
"""
{% load crispy_forms_tags %}
{{ formset|as_crispy_errors }}
"""
)
SampleFormset = formset_factory(SampleForm, max_num=1, validate_max=True)
formset = SampleFormset()
formset.is_valid()
c = Context({"formset": formset})
html = template.render(c)
assert not ("errorMsg" in html or "alert" in html)
def test_as_crispy_errors_formset_with_non_form_errors():
template = Template(
"""
{% load crispy_forms_tags %}
{{ formset|as_crispy_errors }}
"""
)
SampleFormset = formset_factory(SampleForm, max_num=1, validate_max=True)
formset = SampleFormset(
{
"form-TOTAL_FORMS": "2",
"form-INITIAL_FORMS": "0",
"form-MAX_NUM_FORMS": "",
"form-0-password1": "god",
"form-0-password2": "wargame",
}
)
formset.is_valid()
c = Context({"formset": formset})
html = template.render(c)
assert "errorMsg" in html or "alert" in html
if django.VERSION < (3, 2):
assert "
Please submit 1 or fewer forms.
" in html
else:
assert "
Please submit at most 1 form.
" in html
assert "
" not in html
def test_as_crispy_field_non_field(settings):
template = Template(
"""
{% load crispy_forms_tags %}
{{ field|as_crispy_field }}
"""
)
c = Context({"field": "notafield"})
# Raises an AttributeError when trying to figure out how to render it
# Not sure if this is expected behavior -- @kavdev
error_class = CrispyError if settings.DEBUG else AttributeError
with pytest.raises(error_class):
template.render(c)
def test_as_crispy_field_bound_field():
template = Template(
"""
{% load crispy_forms_tags %}
{{ field|as_crispy_field }}
"""
)
form = SampleForm({"password1": "god", "password2": "god"})
form.is_valid()
c = Context({"field": form["password1"]})
# Would raise exception if not a field
html = template.render(c)
assert "id_password1" in html
assert "id_password2" not in html
def test_crispy_filter_with_form():
template = Template(
"""
{% load crispy_forms_tags %}
{{ form|crispy }}
"""
)
c = Context({"form": SampleForm()})
html = template.render(c)
assert "
" not in html
assert "id_is_company" in html
assert html.count(" 0 and not ignore_needle_children:
raise NotImplementedError(
"contains_partial does not check needle's children:%s"
% str(needle.children)
)
if needle.name == haystack.name and set(needle.attributes).issubset(
haystack.attributes
):
return True
return any(
contains_partial(child, needle, ignore_needle_children=ignore_needle_children)
for child in haystack.children
if isinstance(child, Element)
)
def parse_expected(expected_file):
test_file = Path(TEST_DIR) / "results" / expected_file
with open(test_file) as f:
return parse_html(f.read())
def parse_form(form):
html = render_crispy_form(form)
return parse_html(html)
crispy-bootstrap5-2023.10/tox.ini 0000664 0000000 0000000 00000001350 14520113325 0016600 0 ustar 00root root 0000000 0000000 [tox]
envlist =
{py38,py39,py310,py311}-django{42}-crispy{2,-latest},
{py310,py311,py312}-django{50,-latest}-crispy{2,-latest},
lint
[testenv]
package = wheel
wheel_build_env = .pkg
deps =
django42: django>=4.2a1,<5.0
django50: django>=5.0a1,<5.1
crispy2: django-crispy-forms>=2.0
crispy-latest: https://github.com/django-crispy-forms/django-crispy-forms/archive/main.tar.gz
extras = test
commands = python -W error::DeprecationWarning -W error::PendingDeprecationWarning -m pytest {posargs}
[testenv:lint]
skip_install = true
commands =
black crispy_bootstrap5 --check
isort crispy_bootstrap5 --check --dif
flake8 crispy_bootstrap5
deps =
black
flake8
isort
[flake8]
max-line-length = 88