This file holds summarized version history for code changes affecting the phonenumbers library.
This file does not generally include descriptions of patch releases (vX.Y.Z => vX.Y.Z+1) unless there are significant changes to code, not just metadata changes. (Metadata updates are best checked upstream.)
Merge to upstream commit 07cd7bbb8a2f; relevant code changes:
- Added a check to phonenumberutil.py that the value of the
phone-contextparameter of the tel URI follows the correct syntax as defined in RFC3966.
Merge to upstream commit
185004cabd1bb4d3. Upstream has
removed the leading_zero_possible field from the PhoneMetadata type as part of this version;
however, this change is not mirrored in the Python code due to back-compatibility concerns.
New to_string() methods have been added for enum-like classes, emitting strings that describe
integer values known to be enum values.
The library now includes .pyi stub files providing typing information about the API, thanks
to Adam Turner.
Merge to upstream commit e9d8d84f531b; relevant code changes:
- Updated As-You-Type-Formatter to exclude patterns where some digits would be dropped in the output. This also fixes the bug where an extra country code is added in some cases to the user's output. b/183053929
Merge to upstream commit 8379f2f53bbe; relevant code changes:
- Changes format_out_of_country_calling_number to always use preferred intl prefix if present, not just for numbers with a non-unique IDD. This means we will output "8~10" as the prefix if calling formatOutOfCountryCallingNumber instead of "810" for some regions that have this tilde in their prefix [designates that the user should wait before continuing to dial].
Merge to upstream commit fbfc3639d484; just metadata changes.
Merge to upstream commit ca195d5aff67; just metadata changes.
Merge to upstream commit aa1e7af6d637; relevant code changes:
- Making the application of alternate formats when finding phone numbers in text in strict-grouping and exact-match mode depend on the leading digits for each rule. This was always assumed but never actually done. This means that the false positive rate will decrease but also that more valid numbers are skipped. A subsequent CL will update patterns to increase recall.
Merge to upstream commit 45953266d45d; relevant code changes:
- Better documentation for length_of_national_destination_code to emphasise that not every number has one.
- Removed unused code in the AsYouTypeFormatter: We no longer have numbers in formatting matching patterns, only \d.
Merge to upstream commit d62a8fb2b719; relevant code changes:
- AsYouTypeFormatter changed to better choose between rules when dialling locally; previously we used the international rules when the national prefix was present since this would exclude the local-only rules. However, there are some numbers that are not internationally diallable that do use the national prefix, and this logic precluded formatting them correctly.
Merge to upstream commit d56bf9da349b; relevant code changes:
- Support Russian extension character "доб" as a valid one while parsing the numbers.
Just metadata changes.
Merge to upstream commit 7e4e754bda09; relevant code changes:
- Improve parsing logic to be smarter about national-prefix detection &
stripping based on possible-lengths (
IS_POSSIBLE_LOCAL_ONLYandINVALID_LENGTH). Enables e.g. adding Iran short-codes starting with "096" without the need to hack IR's national prefix parsing config.
Merge to upstream commit fb9aa53ecfa3; relevant code changes:
- Documentation fix for
number_type
Merge to upstream commit 1ad92eb35a44; relevant code changes:
- New method
supported_calling_codes()API to return all the calling codes that the library considers valid, both for geographical and non-geographical entities. - Added
is_sms_service_for_region(numobj, region_dialing_from)API in short number info library. An SMS service is where the primary or only intended usage is to receive and/or send text messages (SMSs). This includes MMS as MMS numbers downgrade to SMS if the other party isn't MMS-capable. Theis_sms_servicemetadata is also serialized for the first time. - Documentation update for private variables
_VALID_PUNCTUATIONand_SINGLE_INTERNATIONAL_PREFIX, also renaming the latter from_UNIQUE_INTERNATIONAL_PREFIX.
Merge to upstream commit 242a186f1fbf; relevant code changes:
- Removing
leading_zero_possiblefrom the metadata and all the places it is referenced in the build and prod code. Will be removed from the metadata proto itself in a subsequent release. This should not affect users of the library - the only place it was used wasformat_in_original_format, and only initially to try and avoid modifying the input number by removing/adding digits inadvertently. Now this is checked at the end of the method anyway. However slight formatting differences with this method on invalid numbers starting with 0s may be noticed in some countries. - Updated the documentation for the
is_number_geographicalAPI. - Small comment improvements for
parse()method to point users atkeep_raw_inputparameter. - Added a new enum for
CountryCodeSourcecalledUNSPECIFIED. This is used as a default value, and will be returned if someone callsparse(keep_raw_input=False)and then.country_code_sourcon the result. If users want an actual value for this then they should callparse(keep_raw_input=True)instead; the values that were previously returned after calling this method will not change. - Deletion of the possible number pattern in the phonemetadata.proto file and all generated code. This has not been used for a long time.
Merge to upstream commit 52cff9d8837f; relevant code changes:
- Add
can_be_internationally_dialledpublic API; This was already in JS.
Merge to upstream commit 9923d9211432; relevant code changes:
- Small fix for possible out-of-bounds exception on RFC3966 input where no phone context was actually provided.
Merge to upstream commit 02dbc0921cf5; relevant code changes:
- Changing
is_possible_with_reasonto return the enumsINVALID_LENGTHandIS_POSSIBLE_LOCAL_ONLY, where these apply.is_possible_numbercontinues to considerIS_POSSIBLEorIS_POSSIBLE_LOCAL_ONLYnumbers as possible to dial. Announcement: https://groups.google.com/d/msg/libphonenumber-discuss/sPhYzdzFCmg/6tYsS1f6DgAJ - Doc updates for
region_code_for_numberto clarify that it does not work for short-codes or invalid numbers.
Merge to upstream commit 77affd08f65f; relevant code changes:
- Doc changes to update references to ISO country codes to CLDR region codes,
which are what we actually use. Notice in some of the mapper files the
country code is still the ISO one, because it's used as part of a description
of a language only (e.g. zh-TW vs zh-CN). Edited the language comments there
since they can be two or three letters (c.f. fil for filipino). Also edited
the comment for leadingDigits at the territory level in the
phonemetadata.protofile. - New API methods:
is_possible_number_for_typeandis_possible_number_for_type_with_reason, along withsupported_types_for_regionandsupported_types_for_non_geo_entity. These allow you to query which types (e.g. Mobile) exist for a particular region, and work out if a number is possible for that type (this is a simple length check) rather than for the region as a whole.
Merge to upstream commit 46a38545ba01; relevant code changes:
- Doc fix for
geocoder.pyto explain the cases where an empty string might be returned.
Metadata changes only.
Merge to upstream commit 5507fdbf623f; relevant code changes:
- Making
national_significant_numbermore robust in the face of malicious input. This now ignores thenumber_of_leading_zerosif they are less than zero.
Merge to upstream commit ad297a10ba19; relevant code changes:
- Added two new enum values to
ValidationResult-IS_POSSIBLE_LOCAL_ONLYandINVALID_LENGTH. Added more documentation to the existing values; see the docstrings for when these are going to be used. Note that the API foris_possible_number_with_reasonhas not yet been changed to return these values.IS_POSSIBLE_LOCAL_ONLYwill be returned for some values which currently returnIS_POSSIBLE, andINVALID_LENGTHwill be returned for some values which currently returnTOO_LONG. - Fix for
is_number_matchto ignore thenumber_of_leading_zerosfield when comparing numbers unlessitalian_leading_zeroisTrue, and to consider default values to match the same value when explicitly set for these two fields. This fix shouldn't be needed for anyone correctly creating phone numbers using "parse" as recommended.
Merge to upstream commit 3b16d6b06497; relevant code changes:
- Exported
normalize_diallable_chars_only. This method is already public in the C++ implementation. It has also now been added to the Javascript implementation.
Merge to upstream commit c210dbca4e93; relevant code changes:
- Introduced new
is_carrier_specific_for_regionAPI inshortnumberinfo. This determines whether the provided short code is carrier-specific or not when dialed from the given region.
Merge to upstream commit 1eb06f31e1dd; relevant code changes:
- Removing the ability for
.._for_regionmethods inshortnumberinfo.pyto work on strings, as well of phone number objects. These have been marked deprecated for months. Any users of these methods should callphonenumbers.parsefirst to create aPhoneNumberobject, and pass this in. - Support semicolon as extension character while parsing phone numbers. This is not applicable when you are trying to find the phone numbers.
Merge to upstream commit e905483f87cf; relevant code changes:
- Removing all references to
possible_number_patternother than in the metadata itself.
Merge to upstream commit fedbc7020703; code changes:
- GitHub project changes:
- Changed tag to
vX.Y.Zfromrelease-X.Y.Z; this may affect ports and derived projects.
- Changed tag to
- Metadata structure changes in XML file:
- Mobile and Fixed-Line blocks are no longer assumed to inherit missing data
from the GeneralDesc, but are treated like every other phone number type.
This means that for the non-geographical country codes, like +800, the
example number has been moved from generalDesc to the relevant number types,
and the code in getExampleNumberForNonGeoEntity has been changed to look at
these sub-types for an example number.
This also means that the "NA" and "-1" blocks present in the metadata to
indicate that no mobile or fixed-line numbers appear for the entity have been
removed.
There should no longer be an
exampleNumberat thegeneralDesclevel, but it should be present at everyPhoneNumberDescwith data.
- Mobile and Fixed-Line blocks are no longer assumed to inherit missing data
from the GeneralDesc, but are treated like every other phone number type.
This means that for the non-geographical country codes, like +800, the
example number has been moved from generalDesc to the relevant number types,
and the code in getExampleNumberForNonGeoEntity has been changed to look at
these sub-types for an example number.
This also means that the "NA" and "-1" blocks present in the metadata to
indicate that no mobile or fixed-line numbers appear for the entity have been
removed.
There should no longer be an
- Code changes:
- Using new
possibleLengthInfoto decide whether a short number is the right length or not. This could result in more specific results; whereas before, a number from length 3 to length 6 may have been deemed possible, now we may exclude a number of length 5. - Add hash (#) as a diallable character. Numbers with # in them will no longer
have formatting applied in
format_n_original_format, andnormalize_diallable_chars_onlynow retains the # symbol. example_number_for_non_geo_entityhas been changed to look at the specific number types, not just the generalDesc, for the example numbers; this is a necessary change after the metadata structure change detailed above.
- Using new
Merge to upstream commit ad0ce0c94501; code changes:
- Fixed
phonemetadata.pynot to merge from aNumberFormat's unset boolnational_prefix_optional_when_formatting.
Merge to upstream commit 2d0d216f6032; code changes:
- Stop setting empty
preferred_domestic_carrier_code, and if we are passed such a number then treat the empty field as if unset.
Merge to upstream commit 8c37310deb49; code changes:
- Switching the internal implementation of
is_possible_numberand related functions to use the newpossibleLengthsmetadata. This affects a lot of countries, makingis_possible_numbermore restrictive as more precise data is available. It also affects parsing ambiguous and invalid numbers, as we decide whether to strip a possible national prefix (1) or country code based on the length of the number and whether it is possible before or after this. - Formatting, naming and comment tweaks to follow style guide
- Removal of unneeded
_can_be_geocodedmethod in thetimezone.pyfile, usingphonenumberutil.pyinstead
Merge to upstream commit 1ec4d341c3cd; no code changes that affect the Python version so this is just a version bump to stay in sync with upstream.
Merge to upstream commit 7cc500f588db; code changes:
phonemetadata.pyhas two more fields to represent possible lengths of phone numbers. Changedbuildmetadatafromxml.pyto alter the way that metadata about possible-lengths information is consumed when constructing metadata to populate these. Discussion list email
Merge to upstream commit ddf60b1c175e; code changes:
- Made
is_number_geographical()public and addedis_number_type_geographical(), and changed the geocoder to use this when checking whether to give a detailed answer or country-level only.
Merge to upstream commit 3f83454ed62b; no code changes that affect the Python version so this is just a version bump to stay in sync with upstream.
Merge to upstream commit 598b9a4f89d6; no code changes that affect the Python version so this is just a version bump to stay in sync with upstream.
Merge to upstream commit d933631fbf15; code changes:
- Added support for
region_code of None in example_number_for_type() - Added
invalid_example_number() - Improvements to docstring for parse method
- Update
is_number_geographicalto return true for geographical mobile numbers.
Merge to upstream commit ab5e61acc087ec9f5, which is 7.2.1 (7.2.0 had an immediate problem on release); upstream changelog mentions no code changes, but the Java implementation includes a change to use nano protobufs.
Merge to upstream commit 903ac5de5b6e1112; upstream code changelog:
- Only upstream code change doesn't affect python version
(New
MetadataSourceimplementation that reads from a single metadata file with all regions' phone number metadata.)
Merge to upstream Subversion revision 715; upstream code changelog:
- New APIs for ShortNumberInfo. The old APIs have been deprecated and will be removed in an upcoming release.
Merge to upstream Subversion revision 703; upstream code changelog:
- Changing the offline geocoder to not return any country at all if the number could belong to multiple countries
- Removing obsolete code that treated countries with no metadata as valid.
Merge to upstream Subversion revision 674; upstream code changelog:
- Better exclusion of dates when matching phone numbers from text.
- Handle phone input in RFC3966 with missing tel: prefix
Merge to upstream Subversion revision 656; upstream code changelog:
- Adding MetadataLoader support to allow custom metadata loading from alternative sources (should have no visible impact to users).
- Fixing bug where digits could be lost in as-you-type formatting and formatting patterns incorrectly applied.
Split geographic metadata into chunks.
Generate separate phonenumbers-lite package.
(No upstream changes.)
Removed beta status. Merge up to upstream Subversion revision 650; upstream code changelog:
- Better support for detecting phone numbers in text that are beside each other
- Change to how Japanese numbers beginning with "00" are modelled, with the side-effect that the maximum possible number length has been extended by 1.
- Handle
StringIndexOutOfBoundsExceptionin theAsYouTypeFormatterwhen the national prefix that was extracted was not found in the prefix. This affected countries with very long carrier codes, such as Korea. - Removal of some of the author attributions - contributions to be tracked in CONTRIBUTORS file.
The codebase now supports Python 2.5-2.7 and Python 3.x out of the box, without needing 2to3 conversion.
The top-level module no longer exports the following functions:
country_name_for_numberdescription_for_numberdescription_for_valid_number
These functions now need to be imported via the phonenumbers.geocoder submodule.
The short number functions have been renamed:
is_possible_short_number_objectbecomesis_possible_short_numberis_possible_short_numberbecomesis_possible_short_number_for_objectis_valid_short_number_objectbecomesis_valid_short_numberis_valid_short_numberbecomesis_valid_short_number_for_objectexpected_costbecomesexpected_cost_for_region, and there's a newexpected_costfunction that takes aPhoneNumberobject.
Merge up to upstream Subversion revision 622; upstream code changelog:
- Adding support for numbers with multiple Italian leading zeros, by adding a field to the phone number proto to allow an arbitrary number of leading zeros, and supporting this when parsing, validating and formatting.
- Adding more functionality to
ShortNumberInfo-> such asGetExpectedCostForRegion. - Fix for parsing short numbers that start with the national prefix.
- Updating
FormatNumberForMobileDialingto work with short numbers. - Stop finding Israeli 4-digit "star" numbers in text when no star is in fact present.
- Bug fix for finding phone numbers where the area code was also part of the country calling code.
Rename shortnumberutil.py to shortnumberinfo.py.
Merge up to upstream Subversion revision 603; upstream code changelog:
- Renamed
ShortNumberUtiltoShortNumberInfo-> the former class is now deprecated and will be deleted in a later release. At the moment it just delegates toShortNumberInfo. - New methods in the
ShortNumberInfoAPI -isCarrierSpecific, singleton interface,isPossibleShortNumber,isValidShortNumber,getShortNumberCost. Note this is an experimental API at the moment and subject to change. - Bug fixes:
- AsYouTypeFormatting: 3-digit numbers can be formatted as a group where appropriate
- AsYouTypeFormatting: Countries with an optional national prefix were considered before to have always entered it, resulting in bugs where numbers without the national prefix were not properly formatted.
- Numbers in Chile that overlap with emergency numbers are no longer marked as connecting to them
- Not requiring the NDC to be alone for countries where there is no national prefix in strict grouping when extracting phone numbers
Fix setup.py to include new .shortdata sub-package.
Merge up to upstream Subversion revision 594; upstream code changelog:
- Improve phone number extraction recall.
- Add support for loading short number metadata.
Merge up to upstream Subversion revision 579; upstream code changelog:
- Fix for as-you-type-formatting bug affecting countries with no national prefix formatting rule, such as China.
Merge up to upstream Subversion revision 574; upstream code changelog:
- Changed internal initialization code and made more fields final. Note that we now throw an exception if an attempt is made to set the metadata more than once (which should only happen during testing).
- Fix problem with
formatNumberForMobileDialingfor HU and CL.
Load metadata on demand rather than all at start of day. Merge up to upstream Subversion revision 557; upstream code changelog:
- Switch
formatNumberForMobileDialingto prefer national format to international format when the number is dialed from the same region the phone number is from.
Merge up to upstream Subversion revision 550; upstream code changelog:
- Handling UAN numbers in Argentina better when dialling them locally from a mobile
Merge up to upstream Subversion revision 532.
Merge up to upstream Subversion revision 516.
Merge up to upstream Subversion revision 500. The upstream metadata at r489 didn't match the generated Java code in 5.0; this upstream revision fixed the mismatch.
Merge up to upstream Subversion revision 492.
Merge up to upstream Subversion revision 469.
Merge up to upstream Subversion revision 441.
Merge up to upstream Subversion revision 431.
Merge up to upstream Subversion revision 426. Reinstated Python 2.5 support, accidentally broken since 4.3.
Merge up to upstream Subversion revision 419.
Merge up to upstream Subversion revision 411.
Merge up to upstream Subversion revision 396. Adjust codebase to allow 2to3 generation of Python 3.x version.
Merge up to upstream Subversion revision 383.
Merge up to upstream Subversion revision 374.
Merge up to upstream Subversion revision 362.
Merge up to upstream Subversion revision 353.
Merge up to upstream Subversion revision 325. Includes initial simplistic implementation of geocoding functionality.
Merge up to upstream Subversion revision 289 (but geocoding functionality not yet ported).
Merge up to upstream Subversion revision 277 (but geocoding functionality not yet ported). Require Python 2.5, to allow import unicodedata.
Fix GH-3: crash in parse() for number with blank metadata
Merge up to upstream Subversion revision 213.
Merge up to upstream Subversion revision 205. Changed version marker from a to b. More unit test coverage
Merge up to upstream Subversion revision 190.
Merge up to upstream version 3.3, Subversion revision 171.
Initial port of libphonenumber, from http://code.google.com/p/libphonenumber/
This version based on upstream version 3.2, Subversion revision 166 of: http://libphonenumber.googlecode.com/svn/trunk/java