1308067 - Fix 'DeprecationWarning: Required is going away in WTForms 3.0' warnings

Status: RESOLVED FIXED

(Release Engineering Graveyard :: Applications: Balrog (backend), defect)

Description

[Nick Thomas [:nthomas] (UTC+12)]

Partial output from docker-compose up:

balrogadmin_1  | ./auslib/admin/views/forms.py:139: DeprecationWarning: Required is going away in WTForms 3.0, use DataRequired
balrogadmin_1  |   data_version = IntegerField('data_version', validators=[Required()], widget=HiddenInput())
balrogadmin_1  | ./auslib/admin/views/forms.py:162: DeprecationWarning: Required is going away in WTForms 3.0, use DataRequired
balrogadmin_1  |   product = StringField('Product', validators=[Required()])
balrogadmin_1  | ./auslib/admin/views/forms.py:164: DeprecationWarning: Required is going away in WTForms 3.0, use DataRequired
balrogadmin_1  |   data = JSONStringField({}, 'Data', validators=[Required()])
balrogadmin_1  | ./auslib/admin/views/forms.py:171: DeprecationWarning: Required is going away in WTForms 3.0, use DataRequired
balrogadmin_1  |   backgroundRate = IntegerField('Background Rate', validators=[Required(), NumberRange(0, 100)])
balrogadmin_1  | ./auslib/admin/views/forms.py:172: DeprecationWarning: Required is going away in WTForms 3.0, use DataRequired
balrogadmin_1  |   priority = IntegerField('Priority', validators=[Required()])

WTForms isn't very active (the last release is the v2.1 we're already using, from Dec 2015) so 3.0 probably isn't OMG NOW, but lets squash this warning.

https://wtforms.readthedocs.io/en/latest/validators.html#built-in-validators has some comments regarding the choice of InputRequired vs DataRequired.

Comment 1

[A.S.]

WTF docs report that firstly InputRequired looks that form-input data was provided, and DataRequired looks at the post-coercion data. Secondly , it is suggested on the docs to use InputRequired as default preference until one has specific reasons to validate coerced values via DataRequired. 

This change will involve changing the validator from "Required" to "InputRequired".

Comment 2

[[github robot]]

Commit pushed to master at https://github.com/mozilla/balrog

https://github.com/mozilla/balrog/commit/45468273184542be77f2398d81891fdec955b285
bug 1308067 - Fixed 'DeprecationWarning: Required is going away in WTForms 3.0' warnings (#197). r=bhearsum

Comment 3

[[e-mail] (:bhearsum)]

This is in production. Thanks Ashish!