Handle empty input to PhoneNumberPrefixWidget

This commit changes the behavior slightly, when no phone number is
passed, the region selected by the user is reset. That’s acceptable
behavior, since the user didn’t actually enter a phone number.

phonenumber_field/widgets.py

@@ -1,4 +1,5 @@
 from django.conf import settings
+from django.core import validators
 from django.core.exceptions import ImproperlyConfigured
 from django.forms import Select, TextInput
 from django.forms.widgets import MultiWidget
@@ -90,11 +91,9 @@ def value_from_datadict(self, data, files, name):
         if national_number is None:
             national_number = ""
         number = to_python(national_number, region=region_code)
-        if isinstance(number, str):
-            number = PhoneNumber()
-            number.raw_input = national_number
-        if not number.is_valid():
-            setattr(number, "_region", region_code)
+        if number in validators.EMPTY_VALUES:
+            return number
+        number._region = region_code
         return number
 
 

tests/test_widgets.py

@@ -123,20 +123,23 @@ def test_empty_national_number(self):
         self.assertFalse(form.is_valid())
         rendered_form = form.as_ul()
         self.assertInHTML(
-            '<ul class="errorlist"><li>The phone number entered is not valid.'
-            "</li></ul>",
+            '<ul class="errorlist"><li>This field is required.</li></ul>',
             rendered_form,
         )
         self.assertInHTML(
             '<input type="text" name="phone_1" required id="id_phone_1">',
             rendered_form,
             count=1,
         )
-        self.assertInHTML(
-            '<option value="CA" selected>Canada +1</option>',
-            rendered_form,
-            count=1,
-        )
+
+    def test_not_required_empty_data(self):
+        class TestForm(forms.Form):
+            phone = formfields.PhoneNumberField(
+                required=False, widget=PhoneNumberPrefixWidget
+            )
+
+        form = TestForm(data={"phone_0": "", "phone_1": ""})
+        self.assertIs(form.is_valid(), True)
 
     def test_no_region(self):
         form = self.form_class(data={"phone_1": "654321"})
@@ -164,21 +167,25 @@ def test_no_national_number(self):
         self.assertFalse(form.is_valid())
         rendered_form = form.as_ul()
         self.assertInHTML(
-            '<ul class="errorlist"><li>The phone number entered is not valid.'
-            "</li></ul>",
-            rendered_form,
-        )
-        self.assertInHTML(
-            '<input type="text" name="phone_1" required id="id_phone_1">',
+            '<ul class="errorlist"><li>This field is required.</li></ul>',
             rendered_form,
             count=1,
         )
         self.assertInHTML(
-            '<option value="CA" selected>Canada +1</option>',
+            '<input type="text" name="phone_1" required id="id_phone_1">',
             rendered_form,
             count=1,
         )
 
+    def test_not_required_no_data(self):
+        class TestForm(forms.Form):
+            phone = formfields.PhoneNumberField(
+                required=False, widget=PhoneNumberPrefixWidget
+            )
+
+        form = TestForm(data={})
+        self.assertIs(form.is_valid(), True)
+
     def test_keeps_region_with_invalid_national_number(self):
         form = self.form_class(data={"phone_0": "CA", "phone_1": "0000"})
         self.assertFalse(form.is_valid())