wtforms

What's Changed

• Add links to MDN in the documentation by @azmeuk in #893
• chore: Remove obsolete python-dateutil dependency by @mgorny in #899
• ListField use Meta.bind_field instead of the default bind method. by @azmeuk in #891
• Add test_environment support for the Email validator by @azmeuk in #894
• Reset FieldList index state when calling process by @azmeuk in #895
• Implement RangeInput min and max parameters by @azmeuk in #898
• Do not render 'for' in radio by @azmeuk in #900
• Deprecate DateTimeField by @azmeuk in #897
• FloatField use NumberInput by default by @Demetriex in #679
• Accept uuid.UUID objects in UUID validator by @TurnrDev in #769
• Escape double quotes in HTML attribute values by @azmeuk in #906
• html_params returns Markup by @azmeuk in #907
• Fix False value with Select by @azmeuk in #908
• Clarify how Select choice is processed in the documentation by @azmeuk in #909
• Fix filters documentation by @azmeuk in #896
• Render-time checked kwargs take precedence over field.checked by @azmeuk in #910
• Add a tz parameter to DateTimeLocalField by @azmeuk in #905
• FieldList improvement to handle entries with indices by @azmeuk in #901
• Use consecutive ids in FieldList when using insert and remove by @azmeuk in #912
• Implement ButtonField by @azmeuk in #892
• Re-introduce Choice and SelectChoice dataclasses by @azmeuk in #889
• Improve custom widgets documentation by @azmeuk in #913
• Add a fieldlist of formfield example in the documentation by @azmeuk in #914
• Enum support for SelectField by @azmeuk in #916
• Respect email_validator default values by @azmeuk in #917
• Error messages customization by @azmeuk in #902
• Customize regexp validator match method by @azmeuk in #918
• for Regexp validator set html input tag 'pattern' attribute by @lefty01 in #759
• implement DateRange validator similar to NumberRange by @jkittner in #787
• URL validator: accept user/password, use urllib.urlparse by @ianw in #847
• Restore sorted(set()) instead of list(dict.fromkeys()) to sort keys in FieldList by @azmeuk in #920
• Datalist implementation by @azmeuk in #921

New Contributors

• @mgorny made their first contribution in #899
• @Demetriex made their first contribution in #679
• @TurnrDev made their first contribution in #769
• @lefty01 made their first contribution in #759
• @jkittner made their first contribution in #787
• @ianw made their first contribution in #847

Full Changelog: 3.2.2...3.3.0b1

What's Changed

• remove slsa provenance by @davidism in #879
• fix(validators): Disabled validation with provided formdata by @subnix in #880
• Support Python versions from 3.10 to 3.14 by @azmeuk in #883
• Update FAQ to reflect 3.10+ support by @kurtmckee in #884
• GHA improvements by @azmeuk in #888

New Contributors

• @subnix made their first contribution in #880
• @kurtmckee made their first contribution in #884

Full Changelog: 3.2.1...3.2.2

Released 2024-10-21

• Fix SelectMultipleBase import. #861 #862

Released 2024-10-20

• Translations update: korean, chinese (traditional), portugese, russian,
  dutch, kazakh, swedish, turkish, slovak, ukranian, spanish, french.
• Move the repository to the pallets-eco organization. #854
• Stop supporting Python 3.8 and start supporting Python 3.13 #855
• Removed required flag support from HiddenWidget,
  RangeWidget and SelectWidget to
  conform to W3C #810
• NoneOf and AnyOf
  can validate multiple valued fields like SelectMultipleField
  #538 #807
• Use GHA and pre-commit workflows inspired from Flask. #856 #860

Released 2024-01-06

• Fix SelectMultipleField value coercion on validation.
  #822 #823

Released 2023-11-01

• Display Flags values in their repr. #808
• ~SelectField and SelectMultipleField choices can be None if validate_choice is False #809
• Documentation improvements #812 #815 #817
• Unit tests improvements #813
• Python 3.12 support #818
• Restored support for 3-items tuple return value from iter_choices #816

Released 2023-10-10

• Documentation improvements #726 #733 #749
  #767 #788 #789 #793
• Translation improvements #732 #734 #754
• Implement :class:~fields.ColorField #755
• Delayed import of email_validator. #727
• <option> attributes can be passed by the :class:~fields.SelectField
choices parameter #692 #738
• Use the standard datetime formats by default for
  :class:~fields.DateTimeLocalField #761
• Python 3.11 support #763
• Added shorter format to :class:~fields.DateTimeLocalField
  defaults #761
• Stop support for python 3.7 #794
• Added shorter format to :class:~fields.WeekField
  defaults #765
• Move to pyproject.toml #796
• URL validator takes a allow_ip parameter #800
• Implement :class:~validators.ReadOnly and
  :class:~validators.Disabled #788

Released 2021-12-23

• Fixed DateTimeField and other similar fields can handle multiple formats. #720 #721
• Stop support for python 3.6 #722

Released 2021-11-07

• Fixed fields.RadioField validators. #477 #615
• fields.FormField.populate_obj always calls setattr #675
• WTForms has a new logo. #569 #689
• Fixed fields.RadioField render_kw rendering. #490 #628 #688
• Support for optgroups in fields.SelectField and fields.SelectMultipleField. #656 #667
• Minor documentation fix. #701
• Custom separators for fields.FieldList. #681 #694
• fields.DateTimeField, fields.DateField and fields.TimeField support time formats that removes leading zeros. #703
• Refactoring: split fields/core.py and fields/simple.py #710

• Drop support for Python < 3.6. #554
• fields.StringField sets data to None when form data is empty and an initial value was not provided. Although it previously set an empty string, None is consistent with the behavior of other fields. #355
• Specified version of Babel required for setup to avoid errors. #430
• Replaced use of getattr/setattr with regular variable access. #482
• ValueError raised by a validator are handled like regular exceptions. Validators need to raise validators.ValidationError or validators.StopValidation to make a validation fail. #445
• fields.SelectField, fields.SelectMultipleField and fields.RadioField choices parameter can be a callable. #608
• Choices shortcut for fields.core.SelectMultipleField. #603 #605
• Forms can have form-level errors. #55 #595
• Implemented fields.core.MonthField. #530 #593
• Filters can be inline. form.BaseForm.process takes a extra_filters parameter. #128 #592
• Fields can be passed the name argument to use a HTML name different than their Python name. #205, #601
• Render attribute names like for_ and class_ are normalized consistently so later values override those specified earlier. #449, #596
• Flags can take non-boolean values. #406 #467
• Widgets are HTML5 by default. #594 #614
• Fixed a bug when the fields.core.SelectField choices are list of strings. #598
• Error messages standardization. #613 #620 #626 #627
• fields.core.SelectMultipleField validate_choice bugfix. #606 #642
• Fixed SelectMultipleField validation when using choices list shortcut. #612 #661

Includes the translation files that were missing in the 2.3.2 release.

[Changelog](https://wtforms.readthedocs.io/en/2.3.x/changes/#version-2-3-2):

• Fixed a bug with ~fields.SelectField choices shortcut at form submission. #598 #639

• Changes: https://wtforms.readthedocs.io/en/2.3.x/changes/#version-2-3-1

• Changes: https://wtforms.readthedocs.io/en/2.3.x/changes/#version-2-3-0

It's been a while! Thanks to the new maintainers who helped get the new release ready.

2.3.x will be the last version to support Python 2. Version 3.0 will support Python >= 3.6.

Released 2018-06-07

• ~fields.StringField only sets data = '' when form data is empty and an initial value was not provided. This fixes an issue where the default value wasn't rendered with the initial form. 291, 401, 355

Released 2018-06-02

• Merged new and updated translations from the community.

• Passing data_ args to render a field converts all the underscores to hyphens when rendering the HTML attribute, not just the first one. data_foo_bar becomes data-foo-bar. 248

• The ~validators.UUID validator uses the uuid.UUID class instead of a regex. 251

• ~fields.SelectField copies the list of choices passed to it so modifying an instance's choices will not modify the global form definition. 286

• Fields call ~fields.Field.process_formdata even if the raw data is empty. 280

• Added a ~fields.MultipleFileField to handle a multi-file input. ~fields.FileField continues to handle only one value. The underlying ~widgets.FileInput widget gained a multiple argument. 281

• ~fields.SelectField choices can contain HTML (MarkupSafe Markup object or equivalent API) and will be rendered properly. 302

• fields.TimeField and html5.TimeField were added. 254

• Improved ~validators.Email. Note that it is still unreasonable to validate all emails with a regex and you should prefer validating by actually sending an email. 294

• Widgets render the required attribute when using a validator that provides the 'required' flag, such as ~validators.DataRequired. 361

• Fix a compatibility issue with SQLAlchemy 1.2 that caused ~ext.sqlalchemy.fields.QuerySelectField to fail with ValueError: too many values to unpack. 391

Released 2015-12-15

• Added render_kw to allow default rendering time options.

• Updated / added a number of localizations.

• Updated docs.

• Allow widgets to set flags.

Released 2015-01-18

• Added more localizations and updated some.

• Validators for email and URL can validate IDNA-encoded domain names and new TLDs.

• Better DeprecationWarnings.

• Support localization files in /usr/share/locale for distro packaging.

Released 2014-07-01

• Update wheel install to conditionally install ordereddict for Python 2.6.

• Doc improvements.

Released 2014-05-20

• Add new class Meta paradigm for much more powerful customization of WTForms.

• Move i18n into core. Deprecate wtforms.ext.i18n.

• Move CSRF into core. Deprecate wtforms.ext.csrf.

• Fix issue rendering SelectFields with value=True.

• Make DecimalField able to use babel locale-based number formatting.

• Drop Python 3.2 support (Python3 support for 3.3+ only).

• Passing attr=False to WTForms widgets causes the value to be ignored.

• Unique validator in wtforms.ext.sqlalchemy has been removed.

• Deprecate form._get_translations. Use Meta.get_translations instead.

Released 2013-09-10

• Fix a bug in validators which causes translations to happen once then clobber any future translations.

• ext.sqlalchemy and ext.appengine minor cleanups / deprecation.

• Allow blank string and the string false to be considered false values for BooleanField (configurable). This is technically a breaking change, but it is not likely to affect the majority of users adversely.

• ext.i18n form allows passing LANGUAGES to the constructor.

Released 2013-04-28

• Add widgets and field implementations for HTML5 specialty input types.

• ext.appengine add NDB support.

• Add translations for Korean, Traditional Chinese.

Released 2013-01-24

• Tests complete in python 3.2/3.3.

• Localization for ru, fr.

• Minor fixes in documentation for clarity.

• FieldList now can take validators on the entire FieldList.

• Fix issue with ext.sqlalchemy QuerySelectField.

• Fix issue in ext.sqlalchemy ColumnDefault conversion.

• ext.sqlalchemy supports Enum type.

• Field class now allows traversal in Django 1.4 templates.

Released 2012-08-24

• We now support Python 2.x and 3.x on the same codebase, thanks to a lot of hard work by Vinay Sajip.

• Add in ability to convert relationships to ext.sqlalchemy model_form.

• Built-in localizations for more languages.

• Distinguish Required validator into InputRequired and DataRequired.

• Better IP address validation, including IPv6 support.

• AnyOf / NoneOf now work properly formatting other datatypes than strings.

• Optional validator can optionally pass through whitespace.

Released 2012-02-29

• Fixed issues related to building for Python 3 and Python pre-releases.

• Add object_data to fields to get at the originally passed data.

Released 2012-02-28

• Output HTML5 compact syntax by default.

• Substantial code reorg, cleanup, and test improvements.

• Added ext.csrf for a way to implement CSRF protection.

• ext.sqlalchemy supports PGInet, MACADDR, and UUID field conversion.

• ext.sqlalchemy supports callable defaults.

• ext.appengine model_form now supports generating forms with the same ordering as model.

• ext.appengine ReferencePropertyField now gets get_label like the other ORM fields.

• Add localization support for WTForms built-in messages.

• Python 3 support (via 2to3).

• An empty label string can be specified on fields if desired.

• Option widget can now take kwargs customization.

• Field subclasses can provide default validators as a class property.

• DateTimeField can take time in microseconds.

• Numeric fields all set .data to None on coercion error for consistency.

Released 2011-04-24

• Documentation: Substantial documentation improvements, including adding Crash Course as a Sphinx document.

• ext.django QuerySetSelectField and ModelSelectField now accept get_label similar to sqlalchemy equivalents.

• ext.appengine model_form fixes for FloatField, TimeField, and DateTimeField.

• ext.appengine ReferencePropertyField now properly stores model object, not key.

Released 2011-01-22

• ext.appengine various field fixes.

• ext.appengine model_form changes.

• Fix issue in Optional with non-string input.

• Make numeric fields more consistent.

• Improve test coverage substantially.

Released 2010-09-17

• ext.appengine ReferencePropertyField.

• Dateutil fields render issue, and consistency issue.

• Optional validator failed when raw_data was absent

• Documentation: docs now mention HTML escaping functionality.

• Add preliminary support for providing a translations object that can translate built-in validation and coercion errors.

Released 2010-04-25

• HTML is now marked as safe (using __html__) so that compatible templating engines will not auto-escape it.

• Field._default is now Field.default.

• All fields now have a raw_data property.

• Fields which are select fields (including those in .ext) can be iterated to produce options, and have an option_widget kwarg.

• Minor bugfixes and cleanup in FieldList, Select(Multiple)Field, QuerySelectField to address behavioral consistency.

• Added FloatField, based on IntegerField.

• ext.appengine now supports FloatProperty and GeoPtProperty.

• ext.sqlalchemy QueryMultipleSelectField changed to QuerySelectMultipleField.

Released 2010-02-13

• Added a BaseForm class which provides the core processing and validation functionality of Form without requiring declarative subclassing.

• Field labels now default to a humanized field name.

• Fields now have a short_name property which is the un-prefixed name.

• DecimalField now rounds values for display without float coercion. See docs for details on how to format decimals.

• ext.sqlalchemy.fields now has an additional QuerySelectMultipleField, and all fields can now support multiple-column primary keys.

• ext.sqlalchemy.orm contains tools for making forms from ORM models.

• Added ext.dateutil for flexible date-time parsing.

• Added ext.appengine contributed by Rodrigo Moraes.

• Added AnyOf and NoneOf validators.

Released 2009-10-10

• Fields have much greater control over input processing. Filters have been added to implement a simple way to transform input data.

• Added fields that encapsulate advanced data structures such as dynamic lists or child forms for more powerful field composing.

• Fields now use widgets for rendering.

• All built-in validators have been converted to classes to clean up the code.

• Form.auto_populate and Field.populate were renamed to populate_obj to clarify that they populate another object, not the Form or Field. This is an API breaking change.

• Dropped support for Python 2.3.