Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Coerce function example #789

Merged
merged 5 commits into from
Jul 22, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/fields.rst
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,20 @@ refer to a single input from the form.
`coerce` keyword arg to :class:`~wtforms.fields.SelectField` says that we
use :func:`int()` to coerce form data. The default coerce is
:func:`str()`.

**Coerce function example**::

def coerce_none(value):
if value == 'None':
return None
return value

class NonePossible(From):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo, this should be Form

choices = [('1', 'Option 1'), ('2', 'Option 2'), ('None', 'No option')]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be a class variable, inline this in the SelectField call.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought it would improve readability. Thanks for the feedback, I have adjusted this in the new commit.

my_select_field = SelectField('Select an option', choices=choices, coerce=coerce_none)

Note when the option None is selected a 'None' str will be passed. By using a coerce
function the 'None' str will be converted to None.

**Skipping choice validation**::

Expand Down