An international phone number field for django models.
Project description
A Django library which interfaces with python-phonenumbers to validate, pretty print and convert phone numbers. python-phonenumbers is a port of Google’s libphonenumber library, which powers Android’s phone number handling.
Included are:
PhoneNumber, a pythonic wrapper around python-phonenumbers’ PhoneNumber class
PhoneNumberField, a model field
PhoneNumberField, a form field
PhoneNumberField, a serializer field
PhoneNumberPrefixWidget, a form widget for selecting a region code and entering a national number. Requires the Babel package be installed.
PhoneNumberInternationalFallbackWidget, a form widget that uses national numbers unless an international number is entered. A PHONENUMBER_DEFAULT_REGION setting needs to be added to your Django settings in order to know which national number format to recognize.
Installation
pip install django-phonenumber-field[phonenumbers]
As an alternative to the phonenumbers package, it is possible to install the phonenumberslite package which has a lower memory footprint.
pip install django-phonenumber-field[phonenumberslite]
Basic usage
First, add phonenumber_field to the list of the installed apps in your settings.py file:
INSTALLED_APPS = [
...
'phonenumber_field',
...
]
Then, you can use it like any regular model field:
from phonenumber_field.modelfields import PhoneNumberField
class MyModel(models.Model):
name = models.CharField(max_length=255)
phone_number = PhoneNumberField()
fax_number = PhoneNumberField(blank=True)
Internally, PhoneNumberField is based upon CharField and by default represents the number as a string of an international phonenumber in the database (e.g '+41524204242').
The object returned is a PhoneNumber instance, not a string. If strings are used to initialize it, e.g. via MyModel(phone_number='+41524204242') or form handling, it has to be a phone number with country code.
Settings
PHONENUMBER_DB_FORMAT
Store phone numbers strings in the specified format.
Default: "E164".
Choices:
"E164",
"INTERNATIONAL",
"NATIONAL" (requires PHONENUMBER_DEFAULT_REGION),
"RFC3966" (requires PHONENUMBER_DEFAULT_REGION).
PHONENUMBER_DEFAULT_REGION
ISO-3166-1 two-letter country code indicating how to interpret regional phone numbers.
Default: None.
PHONENUMBER_DEFAULT_FORMAT
String formatting of phone numbers.
Default: "E164".
Choices:
"E164",
"INTERNATIONAL",
"NATIONAL",
"RFC3966".
Running tests
tox needs to be installed. To run the whole test matrix with the locally available Python interpreters and generate a combined coverage report:
tox
run a specific combination:
tox -e py310-djmain,py39-djmain
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-phonenumber-field-6.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d89612eed2d6889938577743705119637f8185585dd540f080c5f2d5c218dd3 |
|
MD5 | 723742aef764f810932fbfd554ccdf1f |
|
BLAKE2b-256 | c17410276c89007dfb7ac6843f950d42dae3075f38a7cc87c025f79da9606c1e |
Hashes for django_phonenumber_field-6.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70a4c3e5a6d916ed91fbc5fabf18a6c29395fb6912e2d1173ae389cda8966ab6 |
|
MD5 | d3b909dff6e51f4aa781272676dc1080 |
|
BLAKE2b-256 | 3ea921d1c7d51d9aa007ace9155b0456ee4e024c4adb2fac87c7c8b63ec5b395 |