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
5 maintainers
Metadata
5 maintainers
Release files for django-phonenumber-field 6.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django-phonenumber-field-6.4.0.tar.gz | 35.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_phonenumber_field-6.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 101.3 kB
Release files / django-phonenumber-field-6.4.0.tar.gz
| Download URL | django-phonenumber-field-6.4.0.tar.gz |
|---|---|
| Size | 35.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
72a3e7a3e7493bf2a12c07a3bc77ce89813acc16592bf04d0eee3b5a452097ed
|
|
BLAKE2b-256 checksum How to use checksums |
63ad26f5e95d24b634defd961bb0adb87bb0b2c4476c25cd602a144d7e827873
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|
Release files / django_phonenumber_field-6.4.0-py3-none-any.whl
| Download URL | django_phonenumber_field-6.4.0-py3-none-any.whl |
|---|---|
| Size | 65.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a31b4f05ac0ff898661516c84940f83adb5cdcf0ae4b9b1d31bb8ad3ff345b58
|
|
BLAKE2b-256 checksum How to use checksums |
96a2a66affe3884e6b2194239e434f4cdf06c8dfb515f3bc575afa147c22fd81
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.6
|
