What's Changed
Breaking changes
-
Remove
PhoneNumberInternationalFallbackWidget
by @francoisfreitag in #602Use
phonenumber_field.widgets.RegionalPhoneNumberWidget
instead. -
Move validation from widgets to the form fields by @francoisfreitag in #603
Previously, the widgets were validating the phone number, leaving no room for the django regular validation procedure. If you performed custom validation on
PhoneNumberField
s, see the migration guide below.
Other changes
- Drop support for Django 4.1 by @francoisfreitag in #604
- docs: Fix representation of serializer by @francoisfreitag in #607
Full Changelog: 7.3.0...8.0.0
Migration guide
Previously, the widgets handled part of the validation. That behavior prevents overriding validation in form fields, as widgets were casting the value into a PhoneNumber
object, validating it in the process.
Following the MultiValueField
implementation from Django (and MultiWidget
), the widget now handles the presentation logic, but makes
no attempt at validation. The new SplitPhoneNumberField
handles the logic of validating the region choice and the number, and the PhoneNumberPrefixWidget
simply dispatches the region and number data to the appropriate widget.
In order to retain backward compatibility, now that the validate_international_phonenumber
actually comes into play, its error code has been changed to invalid
, so that the custom error message for invalid shows.
validate_international_phonenumber
Review uses of the invalid_phone_number
error code. You’ll probably want to replace them with invalid
. Given that the validator usually did not come into play, you shouldn’t find many uses.
PhoneNumberField
with RegionalPhoneNumberWidget
Move the custom validation occurs in the Django Form
clean_FIELD()
(or clean()
), and no changes should be noticeable.
PhoneNumberField
with PhoneNumberPrefixWidget
Use the SplitPhoneNumberField
instead. Error messages will change slightly and should be more precise (whether the region is not part of
the choices, or the number cannot be interpreted in the selected region).
For more examples, take a look at tests.test_formfields.SplitPhoneNumberFieldTest
.
Make sure GitHub loads the diff for file tests/test_formfields.py
The following tests should cover most use cases: