Class PhoneMetadata

python/phonenumbers/phonemetadata.py:240–640

Class representing metadata for international telephone numbers for a region. This class is hand created based on phonemetadata.proto. Please refer to that file for detailed descriptions of the meaning of each field. WARNING: This API isn't stable. It is considered libphonenumber-inter

class PhoneMetadata(UnicodeMixin, ImmutableMixin):
    """Class representing metadata for international telephone numbers for a region.

    This class is hand created based on phonemetadata.proto. Please refer to that file
    for detailed descriptions of the meaning of each field.

    WARNING: This API isn't stable. It is considered libphonenumber-internal
    and can change at any time. We only declare it as public for easy
    inclusion in our build tools not in this package.  Clients should not
    refer to this file, we do not commit to support backwards-compatibility or
    to warn about breaking changes.

    """
    # Lock that protects the *_available fields while they are being modified.
    # The modification involves loading data from a file, so we cannot just
    # rely on the GIL.
    _metadata_lock = threading.Lock()
    # If a region code is a key in this dict, metadata for that region is available.
    # The corresponding value of the map is either:
    #   - a function which loads the region's metadata
    #   - None, to indicate that the metadata is already loaded
    _region_available = {}  # ISO 3166-1 alpha 2 => function or None
    # Likewise for short number metadata.
    _short_region_available = {}  # ISO 3166-1 alpha 2 => function or None
    # Likewise for non-geo country calling codes.
    _country_code_available = {}  # country calling code (as int) => function or None

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

    @classmethod
    def metadata_for_region(kls, region_code, default=None):
        loader = kls._region_available.get(region_code, None)
        if loader is not None:
            # Region metadata is available but has not yet been loaded.  Do so now.
            kls._metadata_lock.acquire()
            loader(region_code)
            kls._region_available[region_code] = None
            kls._metadata_lock.release()
        return kls._region_metadata.get(region_code, default)

    @classmethod
    def short_metadata_for_region(kls, region_code, default=None):
        loader = kls._short_region_available.get(region_code, None)
        if loader is not None:
            # Region short number metadata is available but has not yet been loaded.  Do so now.
            kls._metadata_lock.acquire()
            loader(region_code)
            kls._short_region_available[region_code] = None
            kls._metadata_lock.release()
        return kls._short_region_metadata.get(region_code, default)

    @classmethod