from unittest import mock
import django
import phonenumbers
from django import forms
from django.core.exceptions import ImproperlyConfigured
from django.test import SimpleTestCase, override_settings
from django.utils import translation
from django.utils.functional import lazy
from phonenumbers import COUNTRY_CODES_FOR_NON_GEO_REGIONS
from phonenumber_field.formfields import PhoneNumberField, SplitPhoneNumberField
from phonenumber_field.phonenumber import PhoneNumber
from phonenumber_field.validators import validate_phonenumber
from tests.models import (
NullablePhoneNumber,
PhoneNumberWithMaxLengthDefault,
PhoneNumberWithMaxLengthNullable,
)
ALGERIAN_PHONE_NUMBER = "+213799136332"
class PhoneNumberFormFieldTest(SimpleTestCase):
def test_error_message(self):
class PhoneNumberForm(forms.Form):
number = PhoneNumberField()
form = PhoneNumberForm({"number": "invalid"})
self.assertIs(form.is_valid(), False)
self.assertEqual(
form.errors, {"number": ["Enter a valid phone number (e.g. +12125552368)."]}
)
@override_settings(PHONENUMBER_DEFAULT_REGION="FR")
def test_error_message_uses_default_region(self):
class PhoneNumberForm(forms.Form):
number = PhoneNumberField()
form = PhoneNumberForm({"number": "invalid"})
self.assertIs(form.is_valid(), False)
self.assertEqual(
form.errors,
{
"number": [
"Enter a valid phone number (e.g. 01 23 45 67 89) "
"or a number with an international call prefix."
]
},
)
def test_override_error_message(self):
class MyPhoneNumberField(PhoneNumberField):
default_error_messages = {"invalid": "MY INVALID MESSAGE!"}
class PhoneNumberForm(forms.Form):
number = MyPhoneNumberField()
form = PhoneNumberForm({"number": "invalid"})
self.assertIs(form.is_valid(), False)
self.assertEqual(form.errors, {"number": ["MY INVALID MESSAGE!"]})
def test_override_error_message_inline(self):
class PhoneNumberForm(forms.Form):
number = PhoneNumberField(
error_messages={"invalid": "MY INLINE INVALID MESSAGE!"}
)
form = PhoneNumberForm({"number": "invalid"})
self.assertIs(form.is_valid(), False)
self.assertEqual(form.errors, {"number": ["MY INLINE INVALID MESSAGE!"]})
def test_algerian_phone_number_in_form(self):
class PhoneNumberForm(forms.Form):
number = PhoneNumberField()
form = PhoneNumberForm({"number": ALGERIAN_PHONE_NUMBER})
self.assertTrue(form.is_valid())
self.assertEqual(ALGERIAN_PHONE_NUMBER, form.cleaned_data["number"])
def test_error_message_lazy(self):
def fail_gettext(msgid):
raise Exception("gettext was called unexpectedly.")
with mock.patch(
"phonenumber_field.formfields.pgettext_lazy",
side_effect=lazy(fail_gettext, str),
):
PhoneNumberField()
def test_override_widget(self):
class MyPhoneNumberField(PhoneNumberField):
widget = forms.TextInput
class TestForm(forms.Form):
phone = MyPhoneNumberField(region="FR")
form = TestForm({"phone": "+33612345678"})
self.assertIs(form.is_valid(), True)
self.assertHTMLEqual(
form.as_p(),
"""
""",
)
@override_settings(PHONENUMBER_DEFAULT_REGION="FR")
def test_widget_uses_default_region(self):
class TestForm(forms.Form):
phone = PhoneNumberField()
form = TestForm({"phone": "+33612345678"})
self.assertIs(form.is_valid(), True)
self.assertHTMLEqual(
form.as_p(),
"""
""",
)
def test_invalid_phone_number(self):
class PhoneNumberForm(forms.Form):
number = PhoneNumberField()
form = PhoneNumberForm({"number": "+11234567890"})
self.assertIs(form.is_valid(), False)
self.assertEqual(
form.errors, {"number": ["Enter a valid phone number (e.g. +12125552368)."]}
)
def test_validate_shortcode(self):
class ShortCodePhoneNumberField(PhoneNumberField):
default_validators = [validate_phonenumber]
class TestForm(forms.Form):
phone = ShortCodePhoneNumberField(region="FR")
form = TestForm({"phone": "1010"})
self.assertIs(form.is_valid(), True)
class SplitPhoneNumberFormFieldTest(SimpleTestCase):
def example_number(self, region_code: str) -> PhoneNumber:
number = phonenumbers.example_number(region_code)
e164 = phonenumbers.format_number(number, phonenumbers.PhoneNumberFormat.E164)
return PhoneNumber.from_string(e164, region=region_code)
def test_initial_empty(self):
class TestForm(forms.Form):
phone = SplitPhoneNumberField(region="CN")
rendered = str(TestForm())
self.assertIn('', rendered)
self.assertIn('', rendered)
@override_settings(PHONENUMBER_DEFAULT_REGION="CN")
def test_uses_default_region_as_initial(self):
class TestForm(forms.Form):
phone = SplitPhoneNumberField()
rendered = str(TestForm())
self.assertIn('', rendered)
self.assertIn('', rendered)
def test_no_initial(self):
class TestForm(forms.Form):
phone = SplitPhoneNumberField()
rendered = str(TestForm())
self.assertIn('', rendered)
self.assertIn('', rendered)
for prefix in COUNTRY_CODES_FOR_NON_GEO_REGIONS:
self.assertNotIn(f"+{prefix}", rendered)
def test_initial(self):
class TestForm(forms.Form):
phone = SplitPhoneNumberField()
rendered = str(
TestForm(initial={"phone": PhoneNumber.from_string("+33612345678")})
)
self.assertIn('', rendered)
self.assertIn('', rendered)
self.assertIn(
'',
rendered,
)
def test_invalid_phone_number(self):
class TestForm(forms.Form):
phone = SplitPhoneNumberField()
form = TestForm({"phone_0": "US", "phone_1": "1234567890"})
self.assertIs(form.is_valid(), False)
self.assertEqual(
form.errors,
{"phone": ["Enter a valid phone number (e.g. (201) 555-0123)."]},
)
@override_settings(USE_I18N=True)
def test_after_translation_deactivate_all(self):
class TestForm(forms.Form):
phone = SplitPhoneNumberField()
translation.deactivate_all()
rendered = str(TestForm())
self.assertIn(
'