Skip to content

Commit c265fd4

Browse files
daviddrysdaledaviddrysdale
committed
Make area_description_for_number internal.
This matches the visibility (private) of the corresponding Java method.
1 parent 44af411 commit c265fd4

3 files changed

Lines changed: 17 additions & 35 deletions

File tree

‎python/phonenumbers/__init__.py‎

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -119,24 +119,6 @@
119119

120120
# The geodata occupies a lot of space, so only perform the import on first use
121121
# of geocoder functionality.
122-
def area_description_for_number(*args, **kwargs):
123-
"""Return a text description of the area of a PhoneNumber for the given language.
124-
125-
Arguments:
126-
numobj -- The PhoneNumber object for which we want to get a text description.
127-
lang -- A 2-letter lowercase ISO 639-1 language code for the language in
128-
which the description should be returned (e.g. "en")
129-
script -- A 4-letter titlecase (first letter uppercase, rest lowercase)
130-
ISO script code as defined in ISO 15924, separated by an
131-
underscore (e.g. "Hant")
132-
region -- A 2-letter uppercase ISO 3166-1 country code (e.g. "GB")
133-
134-
Returns a text description in the given language code, for the given phone
135-
number's area, or an empty string if no description is available."""
136-
from .geocoder import area_description_for_number as real_fn
137-
return real_fn(*args, **kwargs)
138-
139-
140122
def country_name_for_number(*args, **kwargs):
141123
"""Return the given PhoneNumber object's country name in the given language.
142124
@@ -271,7 +253,6 @@ def description_for_valid_number(*args, **kwargs):
271253
# end of items from phonenumberutil.py
272254
'connects_to_emergency_number', 'is_emergency_number', 'ShortNumberCost',
273255
'PhoneNumberMatch', 'PhoneNumberMatcher', 'Leniency',
274-
'area_description_for_number',
275256
'country_name_for_number',
276257
'description_for_number',
277258
'description_for_valid_number',

‎python/phonenumbers/geocoder.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
"""Phone number geocoding functionality
22
33
>>> import phonenumbers
4-
>>> from phonenumbers.geocoder import area_description_for_number
4+
>>> from phonenumbers.geocoder import description_for_number
55
>>> gb_number = phonenumbers.parse("+442083612345", "GB")
66
>>> de_number = phonenumbers.parse("0891234567", "DE")
77
>>> ch_number = phonenumbers.parse("0431234567", "CH")
8-
>>> str(area_description_for_number(gb_number, "en"))
8+
>>> str(description_for_number(gb_number, "en"))
99
'London'
10-
>>> str(area_description_for_number(gb_number, "fr")) # fall back to English
10+
>>> str(description_for_number(gb_number, "fr")) # fall back to English
1111
'London'
12-
>>> str(area_description_for_number(gb_number, "en", region="GB"))
12+
>>> str(description_for_number(gb_number, "en", region="GB"))
1313
'London'
14-
>>> str(area_description_for_number(gb_number, "en", region="US"))
15-
'London'
16-
>>> str(area_description_for_number(de_number, "en"))
14+
>>> str(description_for_number(gb_number, "en", region="US")) # fall back to country
15+
'United Kingdom'
16+
>>> str(description_for_number(de_number, "en"))
1717
'Munich'
18-
>>> u'M\xfcnchen' == area_description_for_number(de_number, "de")
18+
>>> u'M\xfcnchen' == description_for_number(de_number, "de")
1919
True
20-
>>> u'Z\xfcrich' == area_description_for_number(ch_number, "de")
20+
>>> u'Z\xfcrich' == description_for_number(ch_number, "de")
2121
True
22-
>>> str(area_description_for_number(ch_number, "en"))
22+
>>> str(description_for_number(ch_number, "en"))
2323
'Zurich'
24-
>>> str(area_description_for_number(ch_number, "fr"))
24+
>>> str(description_for_number(ch_number, "fr"))
2525
'Zurich'
26-
>>> str(area_description_for_number(ch_number, "it"))
26+
>>> str(description_for_number(ch_number, "it"))
2727
'Zurigo'
2828
2929
"""
@@ -92,7 +92,7 @@ def _find_lang(langdict, lang, script, region):
9292
return None
9393

9494

95-
def area_description_for_number(numobj, lang, script=None, region=None):
95+
def _area_description_for_number(numobj, lang, script=None, region=None):
9696
"""Return a text description of the area of a PhoneNumber for the given language.
9797
9898
Arguments:
@@ -197,7 +197,7 @@ def description_for_valid_number(numobj, lang, script=None, region=None):
197197
number, or an empty string if no description is available."""
198198
number_region = region_code_for_number(numobj)
199199
if region is None or region == number_region:
200-
area_description = area_description_for_number(numobj, lang, script, region)
200+
area_description = _area_description_for_number(numobj, lang, script, region)
201201
if area_description != "":
202202
return area_description
203203
else:

‎python/tests/geocodertest.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
from phonenumbers import PhoneNumber, FrozenPhoneNumber
2323
from phonenumbers import geocoder
2424
from phonenumbers import description_for_number, country_name_for_number
25-
from phonenumbers import description_for_valid_number, area_description_for_number
25+
from phonenumbers import description_for_valid_number
26+
from phonenumbers.geocoder import _area_description_for_number
2627

2728
# Allow override library geocoding metadata with the test metadata.
2829
REAL_GEOCODE_DATA = geocoder.GEOCODE_DATA
@@ -161,7 +162,7 @@ def testCoverage(self):
161162
invalid_number = PhoneNumber(country_code=210, national_number=123456L)
162163
self.assertEqual("", country_name_for_number(invalid_number, "en"))
163164
# Ensure we exercise all public entrypoints directly
164-
self.assertEqual("CA", area_description_for_number(US_NUMBER1, "en"))
165+
self.assertEqual("CA", _area_description_for_number(US_NUMBER1, "en"))
165166
self.assertEqual("CA", description_for_valid_number(US_NUMBER1, "en"))
166167
self.assertEqual("", description_for_valid_number(US_INVALID_NUMBER, "en"))
167168
# Add in some script and region specific fictional names

0 commit comments

Comments
 (0)