Skip to content

Commit c7103c2

Browse files
daviddrysdaledaviddrysdale
committed
Underscore-prefix internal class variables.
1 parent 2eea1fa commit c7103c2

5 files changed

Lines changed: 40 additions & 40 deletions

File tree

‎python/phonenumbers/phonemetadata.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -213,34 +213,34 @@ class PhoneMetadata(UnicodeMixin, ImmutableMixin):
213213
# The corresponding value of the map is either:
214214
# - a function which loads the region's metadata
215215
# - None, to indicate that the metadata is already loaded
216-
region_available = {} # ISO 3166-1 alpha 2 => function or None
216+
_region_available = {} # ISO 3166-1 alpha 2 => function or None
217217
# Likewise for non-geo country calling codes
218-
country_code_available = {} # country calling code (as int) => function or None
218+
_country_code_available = {} # country calling code (as int) => function or None
219219

220-
region_metadata = {} # ISO 3166-1 alpha 2 => PhoneMetadata
220+
_region_metadata = {} # ISO 3166-1 alpha 2 => PhoneMetadata
221221
# A mapping from a country calling code for a non-geographical entity to
222222
# the PhoneMetadata for that country calling code. Examples of the country
223223
# calling codes include 800 (International Toll Free Service) and 808
224224
# (International Shared Cost Service).
225-
country_code_metadata = {} # country calling code (as int) => PhoneMetadata
225+
_country_code_metadata = {} # country calling code (as int) => PhoneMetadata
226226

227227
@classmethod
228228
def metadata_for_region(kls, region_code, default=None):
229-
loader = kls.region_available.get(region_code, None)
229+
loader = kls._region_available.get(region_code, None)
230230
if loader is not None:
231231
# Region metadata is available but has not yet been loaded. Do so now.
232-
kls.region_available[region_code] = None
232+
kls._region_available[region_code] = None
233233
loader()
234-
return kls.region_metadata.get(region_code, default)
234+
return kls._region_metadata.get(region_code, default)
235235

236236
@classmethod
237237
def metadata_for_nongeo_region(kls, country_code, default=None):
238-
loader = kls.country_code_available.get(country_code, None)
238+
loader = kls._country_code_available.get(country_code, None)
239239
if loader is not None:
240240
# Region metadata is available but has not yet been loaded. Do so now.
241-
kls.country_code_available[country_code] = None
241+
kls._country_code_available[country_code] = None
242242
loader()
243-
return kls.country_code_metadata.get(country_code, default)
243+
return kls._country_code_metadata.get(country_code, default)
244244

245245
@classmethod
246246
def metadata_for_region_or_calling_code(kls, country_calling_code, region_code):
@@ -251,11 +251,11 @@ def metadata_for_region_or_calling_code(kls, country_calling_code, region_code):
251251

252252
@classmethod
253253
def register_region_loader(kls, region_code, loader):
254-
kls.region_available[region_code] = loader
254+
kls._region_available[region_code] = loader
255255

256256
@classmethod
257257
def register_nongeo_region_loader(kls, country_code, loader):
258-
kls.country_code_available[country_code] = loader
258+
kls._country_code_available[country_code] = loader
259259

260260
@mutating_method
261261
def __init__(self,
@@ -449,10 +449,10 @@ def __init__(self,
449449
if register:
450450
# Register this instance with the relevant class-wide map
451451
if self.id == REGION_CODE_FOR_NON_GEO_ENTITY:
452-
kls_map = PhoneMetadata.country_code_metadata
452+
kls_map = PhoneMetadata._country_code_metadata
453453
id = self.country_code
454454
else:
455-
kls_map = PhoneMetadata.region_metadata
455+
kls_map = PhoneMetadata._region_metadata
456456
id = self.id
457457
if id in kls_map:
458458
other = kls_map[id]

‎python/tests/asyoutypetest.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,7 +1106,7 @@ def testEdgeCases(self):
11061106
format=u'\\1 \\2 \\3',
11071107
leading_digits_pattern=['[1-59]|[78]0'],
11081108
national_prefix_formatting_rule=u'\\1')])
1109-
PhoneMetadata.region_metadata['XX'] = metadataXX
1109+
PhoneMetadata._region_metadata['XX'] = metadataXX
11101110
phonenumberutil.SUPPORTED_REGIONS.add("XX")
11111111
phonenumberutil.COUNTRY_CODE_TO_REGION_CODE[384] = ("XX",)
11121112
formatter = AsYouTypeFormatter('XX')
@@ -1122,4 +1122,4 @@ def testEdgeCases(self):
11221122
# Restore normality
11231123
del phonenumberutil.COUNTRY_CODE_TO_REGION_CODE[384]
11241124
phonenumberutil.SUPPORTED_REGIONS.remove('XX')
1125-
del PhoneMetadata.region_metadata['XX']
1125+
del PhoneMetadata._region_metadata['XX']

‎python/tests/examplenumberstest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def testEmergency(self):
151151
self.assertEqual(0, wrongTypeCounter)
152152

153153
def testGlobalNetworkNumbers(self):
154-
for callingCode in PhoneMetadata.country_code_available.keys():
154+
for callingCode in PhoneMetadata._country_code_available.keys():
155155
exampleNumber = phonenumberutil.example_number_for_non_geo_entity(callingCode)
156156
self.assertTrue(exampleNumber is not None,
157157
msg="No example phone number for calling code %s" % callingCode)

‎python/tests/phonenumberutiltest.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2476,11 +2476,11 @@ def testMetadataAsString(self):
24762476
str(metadataXX))
24772477

24782478
# Coverage test: invalid example number for region
2479-
PhoneMetadata.region_metadata['XX'] = metadataXX
2479+
PhoneMetadata._region_metadata['XX'] = metadataXX
24802480
phonenumberutil.SUPPORTED_REGIONS.add("XX")
24812481
self.assertTrue(phonenumbers.example_number_for_type("XX", PhoneNumberType.PERSONAL_NUMBER) is None)
24822482
phonenumberutil.SUPPORTED_REGIONS.remove('XX')
2483-
del PhoneMetadata.region_metadata['XX']
2483+
del PhoneMetadata._region_metadata['XX']
24842484

24852485
# And now the grand finale: check a real metadata example
24862486
self.assertEqual(r"""PhoneMetadata(id='AU', country_code=61, international_prefix='001[12]',

‎python/tests/testmetadatatest.py‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,44 @@
55

66
# Override library metadata with the test metadata. First save the original
77
# data.
8-
REAL_REGION_LOADERS = PhoneMetadata.region_available
9-
REAL_COUNTRY_CODE_LOADERS = PhoneMetadata.country_code_available
10-
REAL_REGION_METADATA = PhoneMetadata.region_metadata
11-
REAL_COUNTRY_CODE_METADATA = PhoneMetadata.country_code_metadata
8+
REAL_REGION_LOADERS = PhoneMetadata._region_available
9+
REAL_COUNTRY_CODE_LOADERS = PhoneMetadata._country_code_available
10+
REAL_REGION_METADATA = PhoneMetadata._region_metadata
11+
REAL_COUNTRY_CODE_METADATA = PhoneMetadata._country_code_metadata
1212
REAL_CC_TO_RC = phonenumberutil.COUNTRY_CODE_TO_REGION_CODE
1313

1414
# Clear the data dicts.
15-
PhoneMetadata.region_available = {}
16-
PhoneMetadata.country_code_available = {}
17-
PhoneMetadata.region_metadata = {}
18-
PhoneMetadata.country_code_metadata = {}
15+
PhoneMetadata._region_available = {}
16+
PhoneMetadata._country_code_available = {}
17+
PhoneMetadata._region_metadata = {}
18+
PhoneMetadata._country_code_metadata = {}
1919
phonenumberutil.COUNTRY_CODE_TO_REGION_CODE = {}
2020

2121
# Import the test data; this will re-populate the cleared
22-
# PhoneMetadata.region_available and PhoneMetadata.country_code_available maps
22+
# PhoneMetadata._region_available and PhoneMetadata._country_code_available maps
2323
from .testdata import _COUNTRY_CODE_TO_REGION_CODE as TEST_CC_TO_RC
24-
TEST_REGION_LOADERS = PhoneMetadata.region_available
25-
TEST_COUNTRY_CODE_LOADERS = PhoneMetadata.country_code_available
26-
TEST_REGION_METADATA = PhoneMetadata.region_metadata
27-
TEST_COUNTRY_CODE_METADATA = PhoneMetadata.country_code_metadata
24+
TEST_REGION_LOADERS = PhoneMetadata._region_available
25+
TEST_COUNTRY_CODE_LOADERS = PhoneMetadata._country_code_available
26+
TEST_REGION_METADATA = PhoneMetadata._region_metadata
27+
TEST_COUNTRY_CODE_METADATA = PhoneMetadata._country_code_metadata
2828

2929

3030
def reinstate_real_metadata():
3131
"""Reinstate real phone number metadata"""
3232
phonenumberutil.COUNTRY_CODE_TO_REGION_CODE = REAL_CC_TO_RC
33-
PhoneMetadata.region_available = REAL_REGION_LOADERS
34-
PhoneMetadata.country_code_available = REAL_COUNTRY_CODE_LOADERS
35-
PhoneMetadata.region_metadata = REAL_REGION_METADATA
36-
PhoneMetadata.country_code_metadata = REAL_COUNTRY_CODE_METADATA
33+
PhoneMetadata._region_available = REAL_REGION_LOADERS
34+
PhoneMetadata._country_code_available = REAL_COUNTRY_CODE_LOADERS
35+
PhoneMetadata._region_metadata = REAL_REGION_METADATA
36+
PhoneMetadata._country_code_metadata = REAL_COUNTRY_CODE_METADATA
3737

3838

3939
def insert_test_metadata():
4040
"""Insert test metadata into library"""
4141
phonenumberutil.COUNTRY_CODE_TO_REGION_CODE = TEST_CC_TO_RC
42-
PhoneMetadata.region_available = TEST_REGION_LOADERS
43-
PhoneMetadata.country_code_available = TEST_COUNTRY_CODE_LOADERS
44-
PhoneMetadata.region_metadata = TEST_REGION_METADATA
45-
PhoneMetadata.country_code_metadata = TEST_COUNTRY_CODE_METADATA
42+
PhoneMetadata._region_available = TEST_REGION_LOADERS
43+
PhoneMetadata._country_code_available = TEST_COUNTRY_CODE_LOADERS
44+
PhoneMetadata._region_metadata = TEST_REGION_METADATA
45+
PhoneMetadata._country_code_metadata = TEST_COUNTRY_CODE_METADATA
4646

4747
# Reinstate the real metadata so any importers of this module are not affected
4848
reinstate_real_metadata()

0 commit comments

Comments
 (0)