Class PhoneNumberDesc

python/phonenumbers/phonemetadata.py:150–229

Class representing the description of a set of phone numbers.

class PhoneNumberDesc(UnicodeMixin, ImmutableMixin):
    """Class representing the description of a set of phone numbers."""
    @mutating_method
    def __init__(self,
                 national_number_pattern=None,
                 example_number=None,
                 possible_length=None,
                 possible_length_local_only=None):
        # The national_number_pattern is the pattern that a valid national
        # significant number would match. This specifies information such as
        # its total length and leading digits.
        self.national_number_pattern = force_unicode(national_number_pattern)  # None or Unicode string holding regexp

        # An example national significant number for the specific type. It
        # should not contain any formatting information.
        self.example_number = force_unicode(example_number)  # None or Unicode string

        # These represent the lengths a phone number from this region can be. They
        # will be sorted from smallest to biggest. Note that these lengths are for
        # the full number, without country calling code or national prefix. For
        # example, for the Swiss number +41789270000, in local format 0789270000,
        # this would be 9.
        # This could be used to highlight tokens in a text that may be a phone
        # number, or to quickly prune numbers that could not possibly be a phone
        # number for this locale.
        if possible_length is None:
            possible_length = ()
        self.possible_length = possible_length  # sequence of int

        # These represent the lengths that only local phone numbers (without an area
        # code) from this region can be. They will be sorted from smallest to
        # biggest. For example, since the American number 456-1234 may be locally
        # diallable, although not diallable from outside the area, 7 could be a
        # possible value.
        # This could be used to highlight tokens in a text that may be a phone
        # number.
        # To our knowledge, area codes are usually only relevant for some fixed-line
        # and mobile numbers, so this field should only be set for those types of
        # numbers (and the general description) - however there are exceptions for
        # NANPA countries.
        if possible_length_local_only is None:
            possible_length_local_only = ()
        self.possible_length_local_only = possible_length_local_only  # sequence of int

    def merge_from(self, other):
        """Merge information from another PhoneNumberDesc object into this one."""
        if other.national_number_pattern is not None:
            self.national_number_pattern = other.national_number_pattern
        if other.example_number is not None:
            self.example_number = other.example_number

    def __eq__(self, other):
        if not isinstance(other, PhoneNumberDesc):
            return False
        return (repr(self) == repr(other))

    def __ne__(self, other):
        return not self.__eq__(other)