├── CREDITS ├── changes ├── +ELPCCOcId.rm.md ├── +yyjhuRrea.feat.md ├── +WlQxBsgYl.change.md ├── +yDU0etTG2.change.md └── +LwN0ot4ZG.change.md ├── .gitignore ├── tests ├── test_version.py ├── conftest.py ├── __init__.py ├── test_autoattrmeta.py └── test_get_html5_kwargs.py ├── .editorconfig ├── .github └── workflows │ ├── test.yml │ └── coverage.yml ├── Makefile ├── .pre-commit-config.yaml ├── pyproject.toml ├── README.md ├── CHANGELOG.md ├── src └── wtforms_html5 │ └── __init__.py └── LICENSE.txt /CREDITS: -------------------------------------------------------------------------------- 1 | Brutus 2 | Gowee 3 | -------------------------------------------------------------------------------- /changes/+ELPCCOcId.rm.md: -------------------------------------------------------------------------------- 1 | :coffin: Drop support for _end of life_ Python versions (`3.7`, `3.8`). 2 | -------------------------------------------------------------------------------- /changes/+yyjhuRrea.feat.md: -------------------------------------------------------------------------------- 1 | :white_check_mark: add recent Python versions to test matrix (`3.10`, `3.11`, `3.12`, `3.13`). 2 | -------------------------------------------------------------------------------- /changes/+WlQxBsgYl.change.md: -------------------------------------------------------------------------------- 1 | :technologist: Use [Hatch](https://hatch.pypa.io/) for project management, instead of `setup.cfg`. 2 | -------------------------------------------------------------------------------- /changes/+yDU0etTG2.change.md: -------------------------------------------------------------------------------- 1 | :white_check_mark: Use [PyTest](https://docs.pytest.org/) for testing, instead of plain Python unittest. 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | .copier/ 3 | .coverage* 4 | dist/ 5 | *.egg-info/ 6 | *.pyc 7 | .pytest_cache/ 8 | .tox/ 9 | .venv/ 10 | .vscode/ 11 | -------------------------------------------------------------------------------- /changes/+LwN0ot4ZG.change.md: -------------------------------------------------------------------------------- 1 | :rotating_light: Use only [Ruff](https://docs.astral.sh/ruff/) for linting and formatting, drop various Python linters. 2 | -------------------------------------------------------------------------------- /tests/test_version.py: -------------------------------------------------------------------------------- 1 | import importlib.metadata 2 | 3 | 4 | def test_package_version(exp_version): 5 | version = importlib.metadata.version("wtforms-html5") 6 | assert version == str(exp_version) 7 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from packaging.version import Version 3 | 4 | from wtforms_html5 import MINMAX_VALIDATORS 5 | from wtforms_html5 import MINMAXLENGTH_VALIDATORS 6 | 7 | EXP_VERSION = "0.6.1" 8 | 9 | 10 | @pytest.fixture(scope="session") 11 | def exp_version() -> Version: 12 | version = Version(EXP_VERSION) 13 | return version 14 | 15 | 16 | @pytest.fixture(scope="session", params=MINMAX_VALIDATORS) 17 | def minmax_validator(request): 18 | return request.param 19 | 20 | 21 | @pytest.fixture(scope="session", params=MINMAXLENGTH_VALIDATORS) 22 | def minmaxlength_validator(request): 23 | return request.param 24 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # http://editorconfig.org 2 | 3 | root = true 4 | 5 | [*] 6 | charset = utf-8 7 | end_of_line = lf 8 | insert_final_newline = true 9 | trim_trailing_whitespace = true 10 | quote_type = double 11 | max_line_length = 88 12 | indent_style = tab 13 | indent_size = 4 14 | 15 | [*.{rst,md,markdown}] 16 | indent_style = tab 17 | indent_size = 4 18 | 19 | [*.{yaml,yml,json}] 20 | indent_style = space 21 | indent_size = 2 22 | 23 | [*.toml] 24 | indent_style = tab 25 | indent_size = 2 26 | 27 | [*.{html,css,sass,scss}] 28 | indent_style = space 29 | indent_size = 2 30 | 31 | [*.{js,coffee}] 32 | indent_style = space 33 | indent_size = 4 34 | 35 | [*.sh] 36 | indent_style = tab 37 | indent_size = 4 38 | 39 | [Makefile] 40 | indent_style = tab 41 | indent_size = 4 42 | 43 | [*.py] 44 | indent_style = space 45 | indent_size = 4 46 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: 4 | - push 5 | - pull_request 6 | 7 | jobs: 8 | tests: 9 | name: run tests with tox 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | python-version: 14 | - "3.7" 15 | - "3.8" 16 | - "3.9" 17 | - "3.10" 18 | steps: 19 | - name: Checkout Source 20 | uses: actions/checkout@v1 21 | - name: Set up Python ${{ matrix.python-version }} 22 | uses: actions/setup-python@v2 23 | with: 24 | python-version: ${{ matrix.python-version }} 25 | - name: Install dependencies 26 | run: >- 27 | pip install 28 | -c requirements/constraints.txt 29 | -r requirements/ci.in 30 | tox-gh-actions 31 | - name: Run tox 32 | run: tox 33 | -------------------------------------------------------------------------------- /.github/workflows/coverage.yml: -------------------------------------------------------------------------------- 1 | name: coverage 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | coveralls: 10 | name: send coverage report to coveralls.io 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Checkout Source 14 | uses: actions/checkout@v1 15 | - name: Set up Python 16 | uses: actions/setup-python@v2 17 | with: 18 | python-version: "3.10" 19 | - name: Install dependencies 20 | run: >- 21 | pip install 22 | -c requirements/constraints.txt 23 | -r requirements/tests.in 24 | coveralls 25 | . 26 | - name: Get coverage 27 | run: coverage run -m unittest discover 28 | - name: Show report 29 | run: coverage report 30 | - name: send report to coveralls 31 | run: coveralls 32 | env: 33 | GITHUB_TOKEN: ${{ secrets.COVERALLS_GITHUB_TOKEN }} 34 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from wtforms import Form 3 | from wtforms import StringField 4 | 5 | from wtforms_html5 import AutoAttrMeta 6 | 7 | try: 8 | from werkzeug.datastructures import MultiDict 9 | except ImportError: 10 | MultiDict = None 11 | 12 | try: 13 | from bs4 import BeautifulSoup 14 | except ImportError: 15 | BeautifulSoup = None 16 | 17 | 18 | def get_form(form_data=None, flags=None, use_meta=False, **kwargs): 19 | """ 20 | Returns a WTForms :cls:`Form`. 21 | 22 | The form has one :cls:`StringField` named `test_field` and the *kwargs* 23 | are used as arguments for the field instance. If *flags* is set, the given 24 | flags are set for the field too. 25 | 26 | If *form_data* is set, it is cast to a :cls:`Werkzeug.MultiDict` and 27 | used to fill the form using the :meth:`Form.process` method. 28 | 29 | """ 30 | form_data = form_data or {} 31 | flags = flags or [] 32 | meta_class = AutoAttrMeta if use_meta else object 33 | 34 | class TestForm(Form): 35 | class Meta(meta_class): 36 | pass 37 | 38 | test_field = StringField("Testfield", **kwargs) 39 | 40 | # create instance 41 | form = TestForm() 42 | 43 | # flags 44 | for flag in flags: 45 | setattr(form.test_field.flags, flag, True) 46 | 47 | # process data 48 | if form_data: 49 | if MultiDict is None: 50 | pytest.skip("This test requires `MultiDict` from `Werkzeug`.") 51 | form.process(MultiDict(form_data)) 52 | 53 | return form 54 | 55 | 56 | def get_field(form, fieldname="test_field"): 57 | """ 58 | Returns *fieldname* from *form* as an BeautifulSoup object. 59 | 60 | """ 61 | if BeautifulSoup is None: 62 | pytest.skip("This test requires `BeautifulSoup`.") 63 | field = getattr(form, fieldname) 64 | return BeautifulSoup(field(), "html.parser").input 65 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: \ 2 | clean full-clean \ 3 | lint check fmt \ 4 | tests doctests coverage \ 5 | build publish \ 6 | change clog \ 7 | release 8 | 9 | clean: 10 | rm -rf MANIFEST build dist 11 | 12 | full-clean: clean 13 | rm -rf .venv .tox .nox .pytest_cache .mypy_cache .ruff_cache .coverage* 14 | 15 | # LINTING 16 | 17 | lint: 18 | hatch run lint:pc 19 | 20 | check: 21 | hatch run lint:check 22 | 23 | fix: 24 | hatch run lint:fix 25 | hatch run lint:upgrade 26 | 27 | # TESTS 28 | 29 | test: 30 | hatch test 31 | 32 | coverage: 33 | hatch test --cover 34 | 35 | version-test: 36 | hatch test --all --cover 37 | 38 | doctest: 39 | hatch test -- --xdoctest src/ 40 | 41 | # PACKAGING 42 | 43 | build: clean 44 | hatch build --clean --target wheel 45 | 46 | publish: build 47 | hatch publish 48 | 49 | # CHANGELOG 50 | 51 | CHANGE_TYPES := rm fix feat change 52 | 53 | change: issue ?= _$(shell < /dev/urandom tr -dc A-Za-z0-9 | head -c9) 54 | change: change_file := changes/$(issue).$(type).md 55 | change: 56 | ifneq ($(filter $(type),$(CHANGE_TYPES)),) 57 | touch '$(change_file)' 58 | $(EDITOR) '$(change_file)' 59 | else 60 | @echo "Given change type '$(type)' is not a suported value: $(CHANGE_TYPES)" 61 | endif 62 | 63 | clog: 64 | hatch run project:towncrier build --draft --version Unreleased 65 | 66 | 67 | # RELEASE 68 | 69 | RELEASE_LEVELS := patch minor major 70 | 71 | release: 72 | ifneq ($(filter $(part),$(RELEASE_LEVELS)),) 73 | # check git status 74 | @if ! git diff-index --quiet HEAD; then \ 75 | echo "ERROR: git unclean!"; \ 76 | exit 1; \ 77 | fi 78 | # get next version (for changelog) 79 | $(eval new_version := $(shell \ 80 | hatch run project:bumpver update --dry --$(part) 2>&1 \ 81 | | grep 'New Version:' \ 82 | | awk '{print $$NF}' \ 83 | )) 84 | @echo "bump -> '$(new_version)'" 85 | # write changelog 86 | hatch run project:towncrier build --yes --version '$(new_version)' 87 | if ! git diff --staged --exit-code; then \ 88 | git commit -m 'chore: add CHANGELOG for `$(new_version)`' --no-verify; \ 89 | fi 90 | # bump version 91 | hatch run project:bumpver update '--$(part)' 92 | else 93 | @echo "Given part '$(part)' is not a suported value: $(RELEASE_LEVELS)" 94 | endif 95 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | # INSTALL .: `pre-commit install` 3 | # UPDATE ..: `pre-commit autoupdate` 4 | exclude: | 5 | (?x)^( 6 | CHANGELOG\..*| 7 | \.copier-answers\..*| 8 | \.copier/answers\..*| 9 | .*/vendor/.*| 10 | .+\.min\.(css|js)| 11 | .+\.svg 12 | )$ 13 | default_language_version: 14 | python: python3.12 15 | default_install_hook_types: 16 | - commit-msg 17 | - pre-commit 18 | repos: 19 | # General 20 | # https://github.com/pre-commit/pre-commit-hooks 21 | - repo: https://github.com/pre-commit/pre-commit-hooks 22 | rev: v5.0.0 23 | hooks: 24 | # Whitespace 25 | - id: trailing-whitespace 26 | - id: end-of-file-fixer 27 | - id: mixed-line-ending 28 | args: 29 | - "--fix=lf" 30 | # VCS 31 | - id: check-merge-conflict 32 | args: 33 | - "--assume-in-merge" 34 | # Binaries 35 | - id: check-shebang-scripts-are-executable 36 | # Config / Data Files (syntax check only) 37 | - id: check-json 38 | - id: check-yaml 39 | - id: check-toml 40 | - id: check-xml 41 | # Python 42 | - id: debug-statements 43 | # Sensible Data 44 | - id: detect-private-key 45 | # Markdown 46 | # https://github.com/executablebooks/mdformat 47 | - repo: https://github.com/executablebooks/mdformat 48 | rev: 0.7.22 49 | hooks: 50 | - id: mdformat 51 | additional_dependencies: 52 | - mdformat-config 53 | - mdformat-frontmatter 54 | - mdformat-mkdocs 55 | - mdformat-tables 56 | # skip linting Hugo content b/c of this bug: 57 | # https://github.com/executablebooks/mdformat/issues/402 58 | exclude: ^site/content/.* 59 | # Conventional Commits 60 | # https://github.com/compilerla/conventional-pre-commit 61 | - repo: https://github.com/compilerla/conventional-pre-commit 62 | rev: v4.0.0 63 | hooks: 64 | - id: conventional-pre-commit 65 | stages: 66 | - commit-msg 67 | args: 68 | - change 69 | - chore 70 | - feat 71 | - fix 72 | # Python: lint and format code 73 | # https://github.com/astral-sh/ruff-pre-commit 74 | - repo: https://github.com/astral-sh/ruff-pre-commit 75 | rev: v0.9.4 76 | hooks: 77 | - id: ruff 78 | args: 79 | - "--fix" 80 | - "--exit-non-zero-on-fix" 81 | - "--target-version=py312" 82 | # https://docs.astral.sh/ruff/rules/ 83 | - "--select=F,E4,E7,E9,I,UP,B,N" 84 | - "--config" 85 | - "lint.isort.force-single-line=true" 86 | - "--config" 87 | - "format.docstring-code-format=true" 88 | - id: ruff-format 89 | args: 90 | - "--target-version=py312" 91 | # Python: check project (i.e. `pyproject.toml`) 92 | # https://github.com/abravalheri/validate-pyproject 93 | - repo: https://github.com/abravalheri/validate-pyproject 94 | rev: v0.23 95 | hooks: 96 | - id: validate-pyproject 97 | -------------------------------------------------------------------------------- /tests/test_autoattrmeta.py: -------------------------------------------------------------------------------- 1 | # pylama:ignore=C0111 2 | """ 3 | Tests for the :cls:`wtforms_html5.AutoAttrMeta` class. 4 | 5 | """ 6 | 7 | from unittest import TestCase 8 | 9 | from wtforms.validators import InputRequired 10 | from wtforms.validators import Length 11 | from wtforms.validators import NumberRange 12 | 13 | from . import get_field 14 | from . import get_form 15 | 16 | 17 | class TestMeta(TestCase): 18 | def test_standard_field(self): 19 | form1 = get_form() 20 | form2 = get_form(use_meta=True) 21 | self.assertEqual(form1.test_field(), form2.test_field()) 22 | 23 | def test_required(self): 24 | form = get_form( 25 | validators=[ 26 | InputRequired(), 27 | ], 28 | use_meta=True, 29 | ) 30 | field = get_field(form) 31 | self.assertIn("required", field.attrs) 32 | 33 | def test_invalid(self): 34 | form = get_form( 35 | validators=[ 36 | InputRequired(), 37 | ], 38 | use_meta=True, 39 | ) 40 | self.assertFalse(form.validate()) 41 | field = get_field(form) 42 | self.assertIn("invalid", field.attrs["class"]) 43 | 44 | def test_minmax(self): 45 | # min 46 | form = get_form( 47 | validators=[ 48 | NumberRange(min=3), 49 | ], 50 | use_meta=True, 51 | ) 52 | field = get_field(form) 53 | self.assertEqual(field.attrs["min"], "3") 54 | self.assertNotIn("max", field.attrs) 55 | # max 56 | form = get_form( 57 | validators=[ 58 | NumberRange(max=8), 59 | ], 60 | use_meta=True, 61 | ) 62 | field = get_field(form) 63 | self.assertEqual(field.attrs["max"], "8") 64 | self.assertNotIn("min", field.attrs) 65 | # min + max 66 | form = get_form( 67 | validators=[ 68 | NumberRange(min=3, max=8), 69 | ], 70 | use_meta=True, 71 | ) 72 | field = get_field(form) 73 | self.assertEqual(field.attrs["min"], "3") 74 | self.assertEqual(field.attrs["max"], "8") 75 | 76 | def test_minmaxlength(self): 77 | # min 78 | form = get_form( 79 | validators=[ 80 | Length(min=3), 81 | ], 82 | use_meta=True, 83 | ) 84 | field = get_field(form) 85 | self.assertEqual(field.attrs["minlength"], "3") 86 | self.assertNotIn("maxlength", field.attrs) 87 | # max 88 | form = get_form( 89 | validators=[ 90 | Length(max=8), 91 | ], 92 | use_meta=True, 93 | ) 94 | field = get_field(form) 95 | self.assertEqual(field.attrs["maxlength"], "8") 96 | self.assertNotIn("minlength", field.attrs) 97 | # min + max 98 | form = get_form( 99 | validators=[ 100 | Length(min=3, max=8), 101 | ], 102 | use_meta=True, 103 | ) 104 | field = get_field(form) 105 | self.assertEqual(field.attrs["minlength"], "3") 106 | self.assertEqual(field.attrs["maxlength"], "8") 107 | 108 | def test_title(self): 109 | form = get_form(description="Some help text", use_meta=True) 110 | field = get_field(form) 111 | self.assertEqual(field.attrs["title"], "Some help text") 112 | 113 | def test_field_renderkw(self): 114 | render_kw = { 115 | "class": "imspecial too", 116 | } 117 | form = get_form(render_kw=render_kw, use_meta=True) 118 | field = get_field(form) 119 | self.assertIn("imspecial", field.attrs["class"]) 120 | self.assertIn("too", field.attrs["class"]) 121 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["hatchling"] 3 | build-backend = "hatchling.build" 4 | 5 | [tool.hatch.build.targets.wheel] 6 | packages = ["src/wtforms_html5"] 7 | 8 | [project] 9 | name = "wtforms-html5" 10 | description = "Generates render keywords for widgets of WTForms HTML5 fields." 11 | readme = "README.md" 12 | license = "GPL-3.0-or-later" 13 | authors = [ 14 | {name = "Brutus", email = "brutus.dmc@googlemail.com"}, 15 | ] 16 | maintainers = [ 17 | {name = "Brutus", email = "brutus.dmc@googlemail.com"}, 18 | ] 19 | classifiers = [ 20 | "License :: OSI Approved :: GNU General Public License (GPL)", 21 | "Operating System :: OS Independent", 22 | "Programming Language :: Python", 23 | "Development Status :: 4 - Beta", 24 | "Environment :: Web Environment", 25 | "Intended Audience :: Developers", 26 | "Topic :: Internet :: WWW/HTTP", 27 | ] 28 | requires-python = ">=3.9" 29 | version = "0.6.1" 30 | dependencies = [ 31 | "wtforms", 32 | ] 33 | 34 | [project.urls] 35 | Source = "https://github.com/brutus/wtforms-html5" 36 | Documentation = "https://github.com/brutus/wtforms-html5/README.md" 37 | Issues = "https://github.com/brutus/wtforms-html5/issues/" 38 | 39 | # LINTING 40 | 41 | [tool.hatch.envs.lint] 42 | detached = true 43 | dependencies = [ 44 | "pre-commit", 45 | "pyupgrade", 46 | "ruff", 47 | ] 48 | 49 | [tool.hatch.envs.lint.scripts] 50 | pc = "pre-commit run --all-files {args}" 51 | check = [ 52 | "ruff check --no-fix {args:.}", 53 | "ruff check --fix-only --diff {args:.}", 54 | "ruff format --check --diff {args:.}", 55 | ] 56 | fix = [ 57 | "ruff check --fix {args:.}", 58 | "ruff format {args:.}", 59 | ] 60 | upgrade = "git ls-files -- '*.py' | xargs -r pyupgrade --py39-plus" 61 | 62 | [tool.ruff] 63 | src = ['.', 'src', 'tests'] 64 | 65 | [tool.ruff.lint.per-file-ignores] 66 | "tests/**/*" = ["PLR2004", "S101", "TID252"] 67 | 68 | [tool.ruff.lint.isort] 69 | known-first-party = ["wtforms_html5"] 70 | force-single-line = true 71 | 72 | # TESTING 73 | 74 | [[tool.hatch.envs.hatch-test.matrix]] 75 | python = ["3.13", "3.12", "3.11", "3.10", "3.9"] 76 | 77 | [tool.hatch.envs.hatch-test] 78 | extra-dependencies = [ 79 | "beautifulsoup4", 80 | "werkzeug", 81 | "xdoctest[colors]", 82 | ] 83 | 84 | [tool.pytest.ini_options] 85 | addopts = "-ra --strict-markers --import-mode=importlib" 86 | testpaths = [ 87 | "tests", 88 | ] 89 | 90 | [tool.coverage.run] 91 | branch = true 92 | parallel = true 93 | source_pkgs = ["wtforms_html5"] 94 | omit = [ 95 | "src/wtforms_html5/__about__.py", 96 | ] 97 | 98 | [tool.coverage.paths] 99 | wtforms_html5 = ["src/wtforms_html5"] 100 | tests = ["tests", "*/wtforms_html5/tests"] 101 | 102 | [tool.coverage.report] 103 | fail_under = 80 104 | precision = 2 105 | skip_covered = true 106 | skip_empty = true 107 | show_missing = true 108 | exclude_lines = [ 109 | "no cov", 110 | "if __name__ == .__main__.:", 111 | "if TYPE_CHECKING:", 112 | ] 113 | 114 | # PROJECT MANAGEMENT 115 | 116 | [tool.hatch.envs.project] 117 | detached = true 118 | dependencies = [ 119 | "bumpver", 120 | "towncrier", 121 | ] 122 | 123 | [tool.bumpver] 124 | current_version = "0.6.1" 125 | version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]" 126 | commit_message = "chore: bump version `{old_version}` -> `{new_version}`" 127 | tag_message = "v{new_version}" 128 | commit = true 129 | tag = true 130 | push = false 131 | 132 | [tool.bumpver.file_patterns] 133 | "pyproject.toml" = [ 134 | '^version = "{version}"', 135 | '^current_version = "{version}"', 136 | ] 137 | "src/wtforms_html5/__init__.py" = [ 138 | '__version__ = "{version}"', 139 | ] 140 | "tests/conftest.py" = [ 141 | 'EXP_VERSION = "{version}"', 142 | ] 143 | "README.md" = [ 144 | '**VERSION**: `{version}`', 145 | ] 146 | 147 | [tool.towncrier] 148 | directory = "changes" 149 | filename = "CHANGELOG.md" 150 | title_format = "## {version} ({project_date})" 151 | issue_format = "[#{issue}](https://github.com/brutus/wtforms-html5/issues/{issue})" 152 | wrap = true 153 | 154 | [[tool.towncrier.type]] 155 | directory = "rm" 156 | name = "Removals" 157 | showcontent = true 158 | 159 | [[tool.towncrier.type]] 160 | directory = "fix" 161 | name = "Bugfixes" 162 | showcontent = true 163 | 164 | [[tool.towncrier.type]] 165 | directory = "feat" 166 | name = "Features" 167 | showcontent = true 168 | 169 | [[tool.towncrier.type]] 170 | directory = "change" 171 | name = "Changes" 172 | showcontent = true 173 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # WTForms HTML5 2 | 3 | [![PyPI Status](https://img.shields.io/pypi/v/wtforms-html5.svg)](https://pypi.org/project/wtforms-html5/) 4 | [![Coverage Status](https://coveralls.io/repos/github/brutus/wtforms-html5/badge.svg?branch=main)](https://coveralls.io/github/brutus/wtforms-html5?branch=main) 5 | [![pre-commit.ci Status](https://results.pre-commit.ci/badge/github/brutus/wtforms-html5/main.svg)](https://results.pre-commit.ci/latest/github/brutus/wtforms-html5/main) 6 | [![Test Status](https://github.com/brutus/wtforms-html5/actions/workflows/test.yml/badge.svg)](https://github.com/brutus/wtforms-html5/actions/workflows/test.yml) 7 | 8 | **VERSION**: `0.6.1` 9 | 10 | **WTForms HTML5** generates render keywords for HTML5 INPUT widgets used by the 11 | [WTForms] library. 12 | 13 | ## Evolution 14 | 15 | _Original Function_: This module used to add support for the new HTML5 INPUT 16 | elements to [WTForms]. Besides supporting the new INPUT _types_, it also set 17 | some of the new _attributes_ automatically, based on widget type and what kind 18 | of validators where set for the field. 19 | 20 | _Changes_: [WTForms] — beginning around version 1.0.4 — started to implement 21 | some of these features. As of late 2016 the development version — that 22 | should become version 3 — has enough support for them IMO, so that to prevent 23 | the duplication of functionality, **WTForms HTML5** dropped all the fields, 24 | widgets and validators — just use vanilla [WTForms]. 25 | 26 | _Current Function_: starting with `0.2` versions of **WTForms HTML5** merely 27 | contain one function: `get_html5_kwargs` — it adds the automatically generated 28 | keys to the _render keywords_ of a [WTForms] field. A slim subclass of the new 29 | default _Meta_ class for forms is also provided: `AutoAttrMeta`. If you use this 30 | class as your forms _Meta_, you get the automatic attributes for all fields in 31 | your form, just like in the original version of **WTForms HTML5**. 32 | 33 | ## Supported Auto–Attributes 34 | 35 | - **required** 36 | 37 | Is set if the field has the _required_ flag set. This happens i.e. if you use 38 | the _DataRequired_ or _InputRequired_ validator. The `required` attribute is 39 | used by browsers to indicate a required field (and most browsers won't 40 | activate the forms action unless all required fields have content). 41 | 42 | - **invalid** 43 | 44 | If the field got any validation errors, the CSS class _invalid_ is added. The 45 | `invalid` class is also set by browsers, if they detect errors on a field. 46 | The validation errors detected by your code, are then by default styled in 47 | the same way as browser generated errors. 48 | 49 | - **min** / **max** and **minlength** / **maxlength** 50 | 51 | If either _Length_ or _NumberRange_ is used as a validator to set minimal 52 | and / or maximal values, the corresponding INPUT attribute is 53 | set (based on which validator is used). This allows for browser based 54 | validation of the values. 55 | 56 | - **title** 57 | 58 | If no _title_ is provided for a field, the _description_ (if one is set) is 59 | used for the `title` attribute. 60 | 61 | ## Example 62 | 63 | Declare your form just like in vanilla _WTForms_, but include `AutoAttrMeta` 64 | as your meta class: 65 | 66 | ```py 67 | >>> from wtforms import Form, StringField 68 | >>> from wtforms.validators import InputRequired, Length 69 | >>> from wtforms_html5 import AutoAttrMeta 70 | >>> class MyForm(Form): 71 | ... class Meta(AutoAttrMeta): 72 | ... pass 73 | ... test_field = StringField( 74 | ... 'Testfield', 75 | ... validators=[InputRequired(), Length(min=3, max=12)], 76 | ... description='Just a test field.', 77 | ... ) 78 | >>> form = MyForm() 79 | ``` 80 | 81 | **The only difference is, that you include a `Meta` class, that inherits from 82 | `AutoAttrMeta`.** 83 | 84 | This meta class sets the above mentioned attributes automatically for all the 85 | fields of the form: 86 | 87 | ```py 88 | >>> form.test_field() 89 | '' 90 | ``` 91 | 92 | The _minlength_ and _maxlength_ attributes are created because the `Length` 93 | validator was used. And the field is marked _required_ because of the 94 | `InputRequired` validator. The field also gets a _title_ taken from the fields 95 | `description`. 96 | 97 | If you validate the form and any errors pop up, the field also get `invalid` 98 | added to its class: 99 | 100 | ```py 101 | >>> form.validate() 102 | False 103 | >>> form.test_field() 104 | '' 105 | ``` 106 | 107 | ## Install 108 | 109 | You can install **WTForms HTML5** with _pip_ or from _source_. 110 | 111 | [pip] is _"a tool for installing and managing Python packages"_. If you don't 112 | have it installed, see the [pip install instructions]. 113 | 114 | ```shell 115 | pip install --user wtforms-html5 116 | ``` 117 | 118 | ### Install Requirements 119 | 120 | Since **WTForms HTML5** only adds functionality to [WTForms], you need to 121 | have it installed too. But if you use the installation method described 122 | above, it should have been taken care of. 123 | 124 | ## Testing and Contribution 125 | 126 | **WTForms HTML5** is at home at: https://github.com/brutus/wtforms-html5/ 127 | 128 | You can run `make setup` after checkout, to setup a development environment. 129 | 130 | If you find any bugs, issues or anything, please use the [issue tracker]. 131 | 132 | ### Testing 133 | 134 | You can run the provided **doctest** like this: `make doctest`. If you want to 135 | run the **test cases**, run `make test` (or `make coverage`). You can also run 136 | `make tests-versions` to run this for all supported versions (this might take 137 | some time though). 138 | 139 | If something fails, please get in touch. 140 | 141 | [issue tracker]: https://github.com/brutus/wtforms-html5/issues 142 | [pip]: https://pip.pypa.io/ 143 | [pip install instructions]: https://pip.pypa.io/en/stable/installing/ 144 | [wtforms]: https://wtforms.readthedocs.io/ 145 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. The format 4 | is based on [Keep a Changelog][], and this project adheres to 5 | [Semantic Versioning][]. 6 | 7 | You can find the **issue tracker** at: 8 | 9 | 10 | [keep a changelog]: https://keepachangelog.com/ 11 | [semantic versioning]: https://semver.org/ 12 | 13 | 14 | 15 | ## 0.6.1 (2022-01-03) 16 | 17 | ### Bugfixes 18 | 19 | - :hammer: fix tasks and template for CHANGELOG 20 | 21 | 22 | ## v0.6.0 (2022-01-02) 23 | 24 | ### Features 25 | 26 | - :white_check_mark: add support for Python `3.10` 27 | 28 | ### Changes 29 | 30 | - :hammer: use [Towncrier](https://github.com/twisted/towncrier) for CHANGELOG 31 | generation (and switch back to Markdown) 32 | - :rotating_light: use `flake8` instead of `flakehell` as Python linter 33 | - :package: use [pip-tools](https://github.com/jazzband/pip-tools) to generate 34 | a constraints file for requirements 35 | - :sparkles: update Makefile: set `$PATH` for virtual environment, add `audit` 36 | task and update tasks for testing and packaging 37 | 38 | ### Deprecations and Removals 39 | 40 | - :coffin: remove the support for _end of life_ Python versions `2.7` and `3.6` 41 | 42 | 43 | ## v0.5.1 (2021-09-30) 44 | 45 | Add some polish to the CI. 46 | 47 | ### Added Features 48 | 49 | - 📝 added badges for various CI checks and stuff to the README 50 | 51 | ### Changes 52 | 53 | - 👷 switched CI from [Travis](https://travis-ci.org/) to Github actions 54 | - ➕ switched to [xdoctest](https://xdoctest.readthedocs.io/) for _doctest_ 55 | 56 | 57 | ## v0.5.0 (2021-06-02) 58 | 59 | Moved to a `src/` layout. Also differentiate more between dev- and install 60 | dependencies. Local development is done via `Makefile` (and virtual 61 | environment, with package in _edit-able_ mode), CI testing via `tox` (and 62 | generated environments, with distributed package version). 63 | 64 | ### Added Features 65 | 66 | - 🚨 Added _editorconfig_ configuration. 67 | - 🚨 Added _pre-commit_ configuration. 68 | 69 | ### Changes 70 | 71 | - 🏗 Switched to a `src/` layout. Install package editable for dev setup. 72 | - 📦 Switched to a contemporary (declarative) build setup with `setup.cfg` 73 | and `build`. 74 | - 📌 Only development requirements are kept in _requirement files_ (unpinned). 75 | Package dependencies are kept in `setup.cfg` (loosely pinned as needed). 76 | - 🚨 Moved all linting to _pre-commit_ (and _Black_). 77 | 78 | ### Removed 79 | 80 | - 📦 Ditched _Pipfile_ (and related tooling). 81 | 82 | 83 | ## v0.4.0 (2019-05-24) 84 | 85 | All around update. 86 | 87 | ### Added Features 88 | 89 | - ✨ Added support for `maxlenght` and `minlength`. **Thanks** to 90 | [Gowee](https://github.com/Gowee). Closing [Issue 91 | 4](https://github.com/brutus/wtforms-html5/issues/4). 92 | 93 | - ✅ Added tested support for Python `3.6` and `3.7`. 94 | 95 | ### Changes 96 | 97 | - 📦 Added _Pipfile_ for [Pipenv](https://github.com/pypa/pipenv). 98 | 99 | - 🚨 Use [autopep8](https://github.com/hhatto/autopep8) for automatic 100 | formatting. 101 | 102 | - 📝 Use [reno](https://pypi.org/project/reno/) for CHANGELOG generation. 103 | 104 | ### Updates 105 | 106 | - 🏗 Updated `Makefile`. 107 | 108 | - 📝 Updated docs. 109 | 110 | - 👽 New import path for `MultiDict` from 111 | [Werkzeug](https://palletsprojects.com/p/werkzeug/). 112 | 113 | ### Removed 114 | 115 | - 🔥 Removed old `CHANGES.md`. 116 | 117 | ### Misc 118 | 119 | - 👥 Added new contributor: [Gowee](https://github.com/Gowee) - Thanks! 120 | 121 | 122 | ## v0.3.0 (2016-12-16) 123 | 124 | Small code re-factoring. 125 | 126 | ### Changes 127 | 128 | - ♻️ Put each auto–setting in it's own function. 129 | 130 | - 📦 Changed linting tool-set from 131 | [flake8](http://flake8.pycqa.org/en/latest/) and 132 | [pylint](https://www.pylint.org/) to 133 | [pylama](https://github.com/klen/pylama). 134 | 135 | ### Updates 136 | 137 | - 📝 Updated the docs. 138 | 139 | 140 | ## v0.2.4 (2016-11-10) 141 | 142 | ### Updates 143 | 144 | - 📝 Updated the docs. 145 | 146 | 147 | ## v0.2.3 (2016-10-08) 148 | 149 | ### Updates 150 | 151 | - 👷 Added some polish to the `Makefile` and CI. 152 | 153 | - 📝 Improved the docs. 154 | 155 | 156 | ## v0.2.2 (2016-10-07) 157 | 158 | ### Fixes 159 | 160 | - 📝 Added `setup.py` to bumpversion configuration. 161 | 162 | 163 | ## v0.2.1 (2016-10-07) 164 | 165 | Makefile and automation. 166 | 167 | ### Added Features 168 | 169 | - 🏗 Added Makefile. 170 | 171 | - 🚨 Added style check command (PEP–8…). 172 | 173 | - ✅ Test coverage analysis with [Coveralls](https://coveralls.io/). 174 | 175 | - 👷 [Travis CI](https://travis-ci.org/) integration. 176 | 177 | - 👷 [Landscape](https://landscape.io/) integration. 178 | 179 | ### Changes 180 | 181 | - 📝 New `CHANGELOG` format. 182 | 183 | ### Updates 184 | 185 | - 📝 Updated Docs and added badges. 186 | 187 | ### Removed 188 | 189 | - 🔥 Removed `run…` files and replaced them with a `makefile`. 190 | 191 | 192 | ## v0.2.0 (2016-10-06) 193 | 194 | Huge re-factoring. Dropping all fields, widgets and validators and include a new 195 | meta class for forms instead. See [README.md](README.md) for more information. 196 | 197 | ### Added Features 198 | 199 | - ✅ Configured [tox](https://tox.readthedocs.io/) for automated testing. 200 | 201 | - 📦 Added requirement files. 202 | 203 | ### Changes 204 | 205 | - ♻️ Use _meta class_ for forms. 206 | 207 | - ✅ Use plain _unittest_ instead of _nosetest_. 208 | 209 | ### Updates 210 | 211 | - ➕ Added dependencies to `setup.py`. 212 | 213 | ### Removed 214 | 215 | - 🔥 Removed all fields, widgets and validators. 216 | 217 | - 📦 Removed tests from the Python package. 218 | 219 | 220 | ## v0.1.2 (2012-11-12) 221 | 222 | ### Added Features 223 | 224 | - ✅ Added test cases. 225 | 226 | 227 | ## v0.1.1 (2012-11-11) 228 | 229 | ### Fixes 230 | 231 | - 📝 Fixed some spelling errors in the documentation. 232 | 233 | 234 | ## v0.1.0 (2012-11-10) 235 | 236 | 🎉 Initial release. 237 | -------------------------------------------------------------------------------- /tests/test_get_html5_kwargs.py: -------------------------------------------------------------------------------- 1 | # pylama:ignore=C0111 2 | """ 3 | Tests for the :func:`wtforms_html5.get_html5_kwargs` function. 4 | 5 | """ 6 | 7 | import pytest 8 | from wtforms import StringField 9 | from wtforms.validators import DataRequired 10 | from wtforms.validators import InputRequired 11 | from wtforms.validators import Length 12 | 13 | from wtforms_html5 import get_html5_kwargs 14 | 15 | from . import get_form 16 | 17 | # FIELD 18 | 19 | 20 | def test_unbound_field_raises_value_error(): 21 | field = StringField("unbound test field") 22 | with pytest.raises(ValueError, match=r"\bneeds a bound field\b"): 23 | get_html5_kwargs(field) 24 | 25 | 26 | # KWARG HANDLING 27 | 28 | 29 | def test_kwargs_are_copied(): 30 | org_kwargs = {} 31 | form = get_form() 32 | new_kwargs = get_html5_kwargs(form.test_field, org_kwargs) 33 | assert org_kwargs is not new_kwargs 34 | 35 | 36 | def test_kwargs_unchanged_when_no_action(): 37 | form = get_form() 38 | res = get_html5_kwargs( 39 | form.test_field, 40 | { 41 | "foo": 1, 42 | "bar": [2, 3], 43 | "x": "y", 44 | }, 45 | ) 46 | exp = { 47 | "foo": 1, 48 | "bar": [2, 3], 49 | "x": "y", 50 | } 51 | assert res == exp 52 | 53 | 54 | def test_kwargs_empty_return_empty(): 55 | form = get_form() 56 | res = get_html5_kwargs(form.test_field) 57 | exp = {} 58 | assert res == exp 59 | 60 | 61 | # SET TITLE 62 | 63 | 64 | def test_title_from_desription(): 65 | form = get_form(description="Test description.") 66 | res = get_html5_kwargs(form.test_field) 67 | exp = { 68 | "title": "Test description.", 69 | } 70 | assert res == exp 71 | 72 | 73 | def test_title_no_overwrite(): 74 | form = get_form(description="Test description.") 75 | render_kw = {"title": "Test title."} 76 | res = get_html5_kwargs(form.test_field, render_kw) 77 | exp = { 78 | "title": "Test title.", 79 | } 80 | assert res == exp 81 | 82 | 83 | # REQUIRED 84 | 85 | 86 | def test_required_by_flag(): 87 | form = get_form(flags=["required"]) 88 | res = get_html5_kwargs(form.test_field) 89 | exp = { 90 | "required": True, 91 | } 92 | assert res == exp 93 | 94 | 95 | def test_required_by_validator(): 96 | # InputRequired 97 | form = get_form( 98 | validators=[ 99 | InputRequired(), 100 | ] 101 | ) 102 | res = get_html5_kwargs(form.test_field) 103 | exp = { 104 | "required": True, 105 | } 106 | assert res == exp 107 | # DataRequired 108 | form = get_form( 109 | validators=[ 110 | DataRequired(), 111 | ] 112 | ) 113 | res = get_html5_kwargs(form.test_field) 114 | exp = { 115 | "required": True, 116 | } 117 | assert res == exp 118 | # Length 119 | form = get_form( 120 | validators=[ 121 | Length(max=5), 122 | ] 123 | ) 124 | res = get_html5_kwargs(form.test_field) 125 | assert "required" not in res 126 | 127 | 128 | def test_required_no_overwrite(): 129 | form = get_form(flags=["required"]) 130 | render_kw = {"required": False} 131 | res = get_html5_kwargs(form.test_field, render_kw) 132 | exp = { 133 | "required": False, 134 | } 135 | assert res == exp 136 | 137 | 138 | # INVALID 139 | 140 | 141 | def test_invalid(): 142 | # nothing 143 | form = get_form() 144 | assert form.validate() is True 145 | res = get_html5_kwargs(form.test_field) 146 | exp = {} 147 | assert res == exp 148 | # nothing invalid 149 | form_data = {"test_field": "x" * 5} 150 | form = get_form( 151 | form_data=form_data, 152 | validators=[ 153 | Length(min=5), 154 | ], 155 | ) 156 | assert form.validate() is True 157 | res = get_html5_kwargs(form.test_field) 158 | exp = { 159 | "minlength": 5, 160 | } 161 | assert res == exp 162 | # invalid input 163 | form_data = {"test_field": "x" * 2} 164 | form = get_form( 165 | form_data=form_data, 166 | validators=[ 167 | Length(min=5), 168 | ], 169 | ) 170 | assert form.validate() is False 171 | res = get_html5_kwargs(form.test_field) 172 | exp = { 173 | "class": "invalid", 174 | "minlength": 5, 175 | } 176 | assert res == exp 177 | 178 | 179 | def test_invalid_append(): 180 | # add to class 181 | form_data = {"test_field": "x" * 2} 182 | form = get_form( 183 | form_data=form_data, 184 | validators=[ 185 | Length(min=5), 186 | ], 187 | ) 188 | assert form.validate() is False 189 | res = get_html5_kwargs(form.test_field, {"class": "test"}) 190 | exp = { 191 | "class": "invalid test", 192 | "minlength": 5, 193 | } 194 | assert res == exp 195 | # add to class_ 196 | form_data = {"test_field": "x" * 2} 197 | form = get_form( 198 | form_data=form_data, 199 | validators=[ 200 | Length(min=5), 201 | ], 202 | ) 203 | assert form.validate() is False 204 | res = get_html5_kwargs(form.test_field, {"class_": "test zwo"}) 205 | exp = { 206 | "class": "invalid test zwo", 207 | "minlength": 5, 208 | } 209 | assert res == exp 210 | 211 | 212 | # MIN / MAX 213 | 214 | 215 | @pytest.mark.parametrize( 216 | "kwargs,exp", 217 | [ 218 | ({"min": 5}, {"min": 5}), # min only 219 | ({"max": 5}, {"max": 5}), # max only 220 | ({"max": 5, "min": 2}, {"min": 2, "max": 5}), # min and max 221 | ], 222 | ) 223 | def test_minmax_validator(minmax_validator, kwargs, exp): 224 | # no render keywords 225 | form = get_form(validators=[minmax_validator(**kwargs)]) 226 | res = get_html5_kwargs(form.test_field) 227 | assert res == exp 228 | # with render keywords - no overwrite 229 | render_kw = { 230 | "min": 10, 231 | "max": 20, 232 | } 233 | exp_render_kw = render_kw.copy() 234 | form = get_form(validators=[minmax_validator(**kwargs)]) 235 | res = get_html5_kwargs(form.test_field, render_kw) 236 | assert res == exp_render_kw 237 | 238 | 239 | @pytest.mark.parametrize( 240 | "kwargs,exp", 241 | [ 242 | ({"min": 5}, {"minlength": 5}), # min only 243 | ({"max": 5}, {"maxlength": 5}), # max only 244 | ({"max": 5, "min": 2}, {"minlength": 2, "maxlength": 5}), # min and max 245 | ], 246 | ) 247 | def test_minmaxlength_validator(minmaxlength_validator, kwargs, exp): 248 | # no render keywords 249 | form = get_form(validators=[minmaxlength_validator(**kwargs)]) 250 | res = get_html5_kwargs(form.test_field) 251 | assert res == exp 252 | # with render keywords - no overwrite 253 | render_kw = { 254 | "minlength": 10, 255 | "maxlength": 20, 256 | } 257 | exp_render_kw = render_kw.copy() 258 | form = get_form(validators=[minmaxlength_validator(**kwargs)]) 259 | res = get_html5_kwargs(form.test_field, render_kw) 260 | assert res == exp_render_kw 261 | -------------------------------------------------------------------------------- /src/wtforms_html5/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | Generates render keywords for `WTForms`_ HTML5 field's widgets. 3 | 4 | The :func:`get_html5_kwargs` adds the automatically generated keys to the 5 | *render keywords* of a `WTForms`_ field. 6 | 7 | The :cls:`AutoAttrMeta` can be included as a base class for the `Meta` class 8 | in your forms, to handle this automatically for each field of the form. 9 | 10 | 11 | Supported Auto–Attributes 12 | ------------------------- 13 | 14 | - *required* 15 | 16 | Is set if the field has the _required_ flag set. This happens i.e. if you 17 | use the _DataRequired_ or _InputRequired_ validator. The `required` 18 | attribute is used by browsers to indicate a required field (and most 19 | browsers won't activate the forms action unless all required fields have 20 | content). 21 | 22 | - *invalid* 23 | 24 | If the field got any validation errors, the CSS class _invalid_ is added. 25 | The `invalid` class is also set by browsers if they detect errors on a 26 | field. This validation errors detected by your code, are by default styled 27 | in the same way as browser generated errors. 28 | 29 | - *min* / *max* and *minlength* / *maxlength* 30 | 31 | If either _Length_ or _NumberRange_ is used as a validator to set minimal 32 | and / or maximal values, the corresponding INPUT attribute is 33 | set (based on which validator is used). This allows for browser based 34 | validation of the values. 35 | 36 | - *title* 37 | 38 | If no _title_ is provided for a field, the _description_ (if one is set) is 39 | used for the `title` attribute. 40 | 41 | 42 | An Example 43 | ---------- 44 | 45 | Declare your form just like in vanilla *WTForms*, but include `AutoAttrMeta` 46 | as your meta class: 47 | 48 | >>> from wtforms import Form, StringField 49 | >>> from wtforms.validators import InputRequired, Length 50 | >>> from wtforms_html5 import AutoAttrMeta 51 | 52 | >>> class MyForm(Form): 53 | ... class Meta(AutoAttrMeta): 54 | ... pass 55 | ... test_field = StringField( 56 | ... 'Testfield', 57 | ... validators=[InputRequired(), Length(min=3, max=12)], 58 | ... description='Just a test field.', 59 | ... ) 60 | 61 | >>> form = MyForm() 62 | 63 | **The only difference is, that you include a `Meta` class, that inherits from 64 | `AutoAttrMeta`.** 65 | 66 | This meta class sets the above mentioned attributes automatically for all the 67 | fields of the form: 68 | 69 | >>> f = form.test_field() 70 | >>> exp = ( 71 | ... '' 73 | ... ) 74 | >>> assert f == exp 75 | 76 | The _min_ and _max_ attributes are created because the `Length` validator was 77 | used. And the field is marked _required_ because of the `InputRequired` 78 | validator. The field also gets a _title_ taken from the fields `description`. 79 | 80 | If you validate the form and any errors pop up, the field also get `invalid` 81 | added to its class: 82 | 83 | >>> form.validate() 84 | False 85 | >>> exp = ( 86 | ... '' 89 | ... ) 90 | >>> f = form.test_field() 91 | >>> assert f == exp 92 | 93 | 94 | .. _WTForms: https://wtforms.readthedocs.io/ 95 | 96 | """ 97 | 98 | from wtforms.fields.core import UnboundField 99 | from wtforms.meta import DefaultMeta 100 | from wtforms.validators import Length 101 | from wtforms.validators import NumberRange 102 | 103 | __version__ = "0.6.1" 104 | __author__ = "Brutus [DMC] " 105 | __license__ = ( 106 | "GNU General Public License v3 or above - " 107 | "http://www.opensource.org/licenses/gpl-3.0.html" 108 | ) 109 | 110 | 111 | MINMAX_VALIDATORS = (NumberRange,) 112 | 113 | MINMAXLENGTH_VALIDATORS = (Length,) 114 | 115 | 116 | def set_required(field, render_kw=None, force=False): 117 | """ 118 | Returns *render_kw* with *required* set if the field is required. 119 | 120 | Sets the *required* key if the `required` flag is set for the field (this 121 | is mostly the case if it is set by validators). The `required` attribute 122 | is used by browsers to indicate a required field. 123 | 124 | ..note:: 125 | 126 | This won't change keys already present unless *force* is used. 127 | 128 | """ 129 | if render_kw is None: 130 | render_kw = {} 131 | if "required" in render_kw and not force: 132 | return render_kw 133 | if field.flags.required: 134 | render_kw["required"] = True 135 | return render_kw 136 | 137 | 138 | def set_invalid(field, render_kw=None): 139 | """ 140 | Returns *render_kw* with `invalid` added to *class* on validation errors. 141 | 142 | Set (or appends) 'invalid' to the fields CSS class(es), if the *field* got 143 | any errors. 'invalid' is also set by browsers if they detect errors on a 144 | field. 145 | 146 | """ 147 | if render_kw is None: 148 | render_kw = {} 149 | if field.errors: 150 | classes = render_kw.get("class") or render_kw.pop("class_", "") 151 | if classes: 152 | render_kw["class"] = f"invalid {classes}" 153 | else: 154 | render_kw["class"] = "invalid" 155 | return render_kw 156 | 157 | 158 | def set_minmax(field, render_kw=None, force=False): 159 | """ 160 | Returns *render_kw* with *min* and *max* set if validators use them. 161 | 162 | Sets *min* and / or *max* keys if one of the validators from 163 | `MINMAX_VALIDATORS` is using them. 164 | 165 | ..note:: 166 | 167 | This won't change keys already present unless *force* is used. 168 | 169 | """ 170 | if render_kw is None: 171 | render_kw = {} 172 | for validator in field.validators: 173 | if isinstance(validator, MINMAX_VALIDATORS): 174 | if "min" not in render_kw or force: 175 | v_min = getattr(validator, "min", -1) 176 | if v_min not in (-1, None): 177 | render_kw["min"] = v_min 178 | if "max" not in render_kw or force: 179 | v_max = getattr(validator, "max", -1) 180 | if v_max not in (-1, None): 181 | render_kw["max"] = v_max 182 | return render_kw 183 | 184 | 185 | def set_minmaxlength(field, render_kw=None, force=False): 186 | """ 187 | Returns *render_kw* with *minlength* and *maxlength* set if validators use 188 | them. 189 | 190 | Sets *minlength* and / or *maxlength* keys if one of the validators from 191 | `MINMAXLENGTH_VALIDATORS` is present and the corresponding parameters (i.e. 192 | `min` or `max`) are set. 193 | 194 | ..note:: 195 | 196 | This won't change keys already present unless *force* is used. 197 | 198 | """ 199 | if render_kw is None: 200 | render_kw = {} 201 | for validator in field.validators: 202 | if isinstance(validator, MINMAXLENGTH_VALIDATORS): 203 | if "minlength" not in render_kw or force: 204 | v_min = getattr(validator, "min", -1) 205 | if v_min not in (-1, None): 206 | render_kw["minlength"] = v_min 207 | if "maxlength" not in render_kw or force: 208 | v_max = getattr(validator, "max", -1) 209 | if v_max not in (-1, None): 210 | render_kw["maxlength"] = v_max 211 | # Inconsistency: Length validator uses min and max for specifying 212 | # length limits while HTML5 uses minlength and 213 | # maxlength (attributes of input element) for the 214 | # same purpose. 215 | return render_kw 216 | 217 | 218 | def set_title(field, render_kw=None): 219 | """ 220 | Returns *render_kw* with missing *title* set to *description*. 221 | 222 | If the field got a *description* but no *title* key is set, the *title* is 223 | set to *description*. 224 | 225 | """ 226 | if render_kw is None: 227 | render_kw = {} 228 | if "title" not in render_kw and field.description: 229 | render_kw["title"] = f"{field.description}" 230 | return render_kw 231 | 232 | 233 | def get_html5_kwargs(field, render_kw=None, force=False): 234 | """ 235 | Returns a copy of *render_kw* with keys added for a bound *field*. 236 | 237 | If some *render_kw* are given, the new keys are added to a copy of them, 238 | which is then returned. If none are given, a dictionary containing only 239 | the automatically generated keys is returned. 240 | 241 | .. important:: 242 | 243 | This might add new keys but won't changes any values if a key is 244 | already in *render_kw*, unless *force* is used. 245 | 246 | Raises: 247 | 248 | ValueError: if *field* is an :cls:`UnboundField`. 249 | 250 | The following keys are set automatically: 251 | 252 | :required: 253 | Sets the *required* key if the `required` flag is set for the 254 | field (this is mostly the case if it is set by validators). The 255 | `required` attribute is used by browsers to indicate a required field. 256 | 257 | :invalid: 258 | Set (or appends) 'invalid' to the fields CSS class(es), if the *field* 259 | got any errors. 'invalid' is also set by browsers if they detect 260 | errors on a field. 261 | 262 | :min / max and minlength / maxlength: 263 | Sets those keys if a or `NumberRange` or `Length` validator is using 264 | them. 265 | 266 | :title: 267 | If the field got a *description* but no *title* key is set, the 268 | *title* is set to *description*. 269 | 270 | """ 271 | if isinstance(field, UnboundField): 272 | msg = f"This function needs a bound field, not: '{field}'" 273 | raise ValueError(msg) 274 | kwargs = render_kw.copy() if render_kw else {} 275 | kwargs = set_required(field, kwargs, force) 276 | kwargs = set_invalid(field, kwargs) 277 | kwargs = set_minmax(field, kwargs, force) 278 | kwargs = set_minmaxlength(field, kwargs, force) 279 | kwargs = set_title(field, kwargs) 280 | return kwargs 281 | 282 | 283 | class AutoAttrMeta(DefaultMeta): 284 | """ 285 | Meta class for WTForms :cls:`Form` classes. 286 | 287 | It uses :func:`get_html5_kwargs` to automatically add some render 288 | keywords for each field's widget when it gets rendered. 289 | 290 | """ 291 | 292 | def render_field(self, field, render_kw): 293 | """ 294 | Returns the rendered field after adding auto–attributes. 295 | 296 | Calls the field`s widget with the following kwargs: 297 | 298 | 1. the *render_kw* set on the field are used as based 299 | 2. and are updated with the *render_kw* arguments from the render call 300 | 3. this is used as an argument for a call to `get_html5_kwargs` 301 | 4. the return value of the call is used as final *render_kw* 302 | 303 | """ 304 | field_kw = getattr(field, "render_kw", None) 305 | if field_kw is not None: 306 | render_kw = dict(field_kw, **render_kw) 307 | render_kw = get_html5_kwargs(field, render_kw) 308 | return field.widget(field, **render_kw) 309 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | WTForms HTML 5 635 | Copyright (C) 2012 Brutus 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | WTForms HTML 5 Copyright (C) 2012 Brutus 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------