docs: wtforms/validators: tweak InputRequired
docs
#788
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello!
This is just a small docstring change: no behavioral changes have been made. As such, I haven't added tests or a changelog entry.
This change clarifies the behavior of the
InputRequired
validator by making its behavior around raw vs. coerced data slightly more explicitly documented: it adds an additional sentence ephasizing that "form-input data" means theformdata
parameter going into aForm
.As a justification for this clarification: we're doing a bit of refactoring on Warehouse, including replacing usages of
DataRequired
withInputRequired
. As part of that, we've observed that a large number of unit tests incorrectly assumed thatFoo(x=1)
has the same validation behavior asFoo(dict(x=1))
, which it doesn't for fields whose validators look at the field'sraw_data
.Please let me know if there's anything else I can do here!
cc @jleightcap