Skip to main content

Python version of Google's common library for parsing, formatting, storing and validating international phone numbers.

Project description

phonenumbers Python Library

This is a Python port of libphonenumber, originally from:

Original Java code is Copyright (C) 2009-2011 The Libphonenumber Authors

phonenumbers Installation

Install using
$ tar xfz phonenumbers-<version>.tar.gz
$ cd phonenumbers-<version>
$ python build
$ sudo python install # or su first

Running Tests

With phonenumbers on the Python path, run:
$ python -m testwrapper

Auto-Generating Python Code

The code within the phonenumbers/data subdirectory is automatically
generated from the master XML metadata file (../resources/PhoneNumberMetadata.xml).
Similarly, the code in the phonenumbers/geodata subdirectory is automatically
generated from the files in ../resources/geocoding/

The script performs the first autogeneration.
Run it with:
python ../resources/PhoneNumberMetaData.xml phonenumbers/data .

This will:
- Create the phonenumbers/data/ directory if not present.
- Create a collection of files, one for each region code:
Each file contains the Python constructors for the metadata for that
- Create a file phonenumbers/data/ which
accumulates all of the per-region files.

The script performs the second autogeneration.
python ../resources/geocoding phonenumbers/geodata/

This approach results in a large set of Python files, but makes it easy
to apply local fixes to the formatting metadata.

Library Developer Internals

The Python code is derived from the original Java code, and
mostly sticks to the structure of that code to make it easier
to include future changes to the upstream code.

However, there are a number of differences:
- Naming conventions are converted to Python standards; in
particular, method names are connected_with_underscores
rather than beingInCamelCase.
- The PhoneNumber and PhoneMetadata classes are written by hand
based on the Java code and the protocol buffer definitions,
rather than by using the the Python protocol buffer library.
This makes the mapping to the Java code easier to follow, and
allows for the custom modifications that have been made to
the base protocol buffer. Attribute values of None are used
to indicate that a particular (optional) attribute is not
present (instead of hasAttribute() methods).
- The Java PhoneNumberUtil class was a singleton, and so its
contents are included at the top level in
Static methods from the PhoneNumberUtil class thus become
functions in; private and package methods
get a leading underscore in their name.
- Accessor functions (setAttribute() and getAttribute() are
avoided, and direct access to attributes is used instead.
- Methods named get_something_from(object) are typically renamed
to something_from(object).
- The format() methods in PhoneNumberUtil were renamed to
format_number() to avoid clashing with the Python built-in
- The internals of do not have logging.
- The Python version is less concerned with speed and size
optimization than the Java version (as Python code is more likely
to run on a server platform and less likely to run on an
embedded/smartphone platform).

Much of the functionality of this library depends on regular
expressions, so it's worth highlighting the translation between
Java and Python regexps:
- Java replacement group references are "$1 $2" etc, Python's are
"\1 \2" etc.
- Java Matcher(x).lookingAt() translates to Python re_obj.match(x)
- Java Matcher(x).find() translates to Python m =
- Java Matcher(x).matches() translates to Python m = re_obj.match(x)
together with a check that m.end() == len(x).
The last of these is encapsulated in the fullmatch() function in

Release Procedure

Standard Python v2.x version:
- Ensure that HISTORY file is up-to-date.
- Set the __version__ field in phonenumbers/
- Check that the list of symbols in phonenumbers/ __all__ is
up to date. The script helps with this.
- Check that the unit tests all run successfully:
cd python && make test
- Check that Python 2.5 is still supported:
cd python && make PYTHON=python2.5 test
- Create a release-<version> branch and shift to it with:
git checkout -b release-<version>
- Push the branch to Github with:
git push <github-remote> release-<version>
- Create a setup-tools packaged tarball dist/phonenumbers-<version>.tar.gz
make sdist # runs sdist
- Create a Debian package deb_dist/python-phonenumbers-<version>-1_all.deb
on a Linux machine with:
make deb
- Upload the tarball and Debian package to Github downloads page at:
- Push the package to PyPI with: sdist upload

Experimental Python v3.x version:
- Perform the v2.x release procedure above.
- Run the do3 script, which re-creates the python3/ directory from scratch,
based on the contents of the python/ directory.
- Check that the unit tests run:
cd python3 && make test
- Create a py3k-release-<version> branch and shift to it with:
git checkout -b py3k-release-<version>
- Push the branch to Github with:
git push origin py3k-release-<version>
- Create a setup-tools packaged tarball dist/phonenumbers3k-<version>.tar.gz
make sdist # runs python3 sdist

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for phonenumbers, version 4.9b1
Filename, size File type Python version Upload date Hashes
Filename, size phonenumbers-4.9b1.tar.gz (563.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page