Merge code changes from upstream 9.0.28

Author: daviddrysdale

python/phonenumbers/phonenumberutil.py

@@ -1485,14 +1485,15 @@ def format_in_original_format(numobj, region_calling_from):
 
     Returns the formatted phone number in its original number format.
     """
-    if (numobj.raw_input is not None and not _has_formatting_pattern_for_number(numobj)):
+    format_rule = _choose_formatting_pattern_for_numobj(numobj)
+    if (numobj.raw_input is not None and format_rule is None):
         # We check if we have the formatting pattern because without that, we
         # might format the number as a group without national prefix.
         return numobj.raw_input
     if numobj.country_code_source is CountryCodeSource.UNSPECIFIED:
         return format_number(numobj, PhoneNumberFormat.NATIONAL)
 
-    formatted_number = _format_original_allow_mods(numobj, region_calling_from)
+    formatted_number = _format_original_allow_mods(numobj, region_calling_from, format_rule)
     num_raw_input = numobj.raw_input
     # If no digit is inserted/removed/modified as a result of our formatting,
     # we return the formatted phone number; otherwise we return the raw input
@@ -1505,7 +1506,7 @@ def format_in_original_format(numobj, region_calling_from):
     return formatted_number
 
 
-def _format_original_allow_mods(numobj, region_calling_from):
+def _format_original_allow_mods(numobj, region_calling_from, format_rule):
     if (numobj.country_code_source == CountryCodeSource.FROM_NUMBER_WITH_PLUS_SIGN):
         return format_number(numobj, PhoneNumberFormat.INTERNATIONAL)
     elif numobj.country_code_source == CountryCodeSource.FROM_NUMBER_WITH_IDD:
@@ -1527,12 +1528,6 @@ def _format_original_allow_mods(numobj, region_calling_from):
         if (_raw_input_contains_national_prefix(numobj.raw_input, national_prefix, region_code)):
             # If so, we can safely return the national format.
             return national_format
-        # Metadata cannot be None here because ndd_prefix_for_region() (above) returns None if
-        # there is no metadata for the region.
-        metadata = PhoneMetadata.metadata_for_region(region_code)
-        assert metadata is not None
-        national_number = national_significant_number(numobj)
-        format_rule = _choose_formatting_pattern_for_number(metadata.number_format, national_number)
         # The format rule could still be null here if the national number was
         # 0 and there was no raw input (this should not be possible for
         # numbers generated by the phonenumber library as they would also not
@@ -1578,15 +1573,28 @@ def _raw_input_contains_national_prefix(raw_input, national_prefix, region_code)
     return False
 
 
-def _has_formatting_pattern_for_number(numobj):
+def _choose_formatting_pattern_for_numobj(numobj):
     country_code = numobj.country_code
     phone_number_region = region_code_for_country_code(country_code)
     metadata = PhoneMetadata.metadata_for_region_or_calling_code(country_code, phone_number_region)
     if metadata is None:
-        return False
+        return None
     national_number = national_significant_number(numobj)
-    format_rule = _choose_formatting_pattern_for_number(metadata.number_format, national_number)
-    return format_rule is not None
+    return _choose_formatting_pattern_for_number(metadata.number_format, national_number)
+
+
+def _choose_formatting_pattern_for_number(available_formats, national_number):
+    for num_format in available_formats:
+        size = len(num_format.leading_digits_pattern)
+        # We always use the last leading_digits_pattern, as it is the most detailed.
+        if size > 0:
+            ld_pattern = re.compile(num_format.leading_digits_pattern[-1])
+            ld_match = ld_pattern.match(national_number)
+        if size == 0 or ld_match:
+            format_pattern = re.compile(num_format.pattern)
+            if fullmatch(format_pattern, national_number):
+                return num_format
+    return None
 
 
 def format_out_of_country_keeping_alpha_chars(numobj, region_calling_from):
@@ -1769,20 +1777,6 @@ def _format_nsn(number, metadata, num_format, carrier_code=None):
         return _format_nsn_using_pattern(number, formatting_pattern, num_format, carrier_code)
 
 
-def _choose_formatting_pattern_for_number(available_formats, national_number):
-    for num_format in available_formats:
-        size = len(num_format.leading_digits_pattern)
-        # We always use the last leading_digits_pattern, as it is the most detailed.
-        if size > 0:
-            ld_pattern = re.compile(num_format.leading_digits_pattern[-1])
-            ld_match = ld_pattern.match(national_number)
-        if size == 0 or ld_match:
-            format_pattern = re.compile(num_format.pattern)
-            if fullmatch(format_pattern, national_number):
-                return num_format
-    return None
-
-
 def _format_nsn_using_pattern(national_number, formatting_pattern, number_format,
                               carrier_code=None):
     # Note that carrier_code is optional - if None or an empty string, no

python/phonenumbers/phonenumberutil.pyi

@@ -152,14 +152,14 @@ def format_national_number_with_preferred_carrier_code(numobj: PhoneNumber, fall
 def format_number_for_mobile_dialing(numobj: PhoneNumber, region_calling_from: str, with_formatting: bool) -> str: ...
 def format_out_of_country_calling_number(numobj: PhoneNumber, region_calling_from: str) -> str: ...
 def format_in_original_format(numobj: PhoneNumber, region_calling_from: str) -> str: ...
-def _format_original_allow_mods(numobj: PhoneNumber, region_calling_from: str) -> str: ...
+def _format_original_allow_mods(numobj: PhoneNumber, region_calling_from: str, format_rule: NumberFormat) -> str: ...
 def _raw_input_contains_national_prefix(raw_input: str, national_prefix: str, region_code: str) -> bool: ...
-def _has_formatting_pattern_for_number(numobj: PhoneNumber) -> bool: ...
+def _choose_formatting_pattern_for_numobj(numobj: PhoneNumber) -> NumberFormat: ...
+def _choose_formatting_pattern_for_number(available_formats: list[NumberFormat], national_number: str) -> NumberFormat | None: ...
 def format_out_of_country_keeping_alpha_chars(numobj: PhoneNumber, region_calling_from: str) -> str: ...
 def national_significant_number(numobj: PhoneNumber) -> str: ...
 def _prefix_number_with_country_calling_code(country_code: int, num_format: int, formatted_number: str) -> str: ...
 def _format_nsn(number: str, metadata: PhoneMetadata, num_format: int, carrier_code: str | None = ...) -> str: ...
-def _choose_formatting_pattern_for_number(available_formats: list[NumberFormat], national_number: str) -> NumberFormat | None: ...
 def _format_nsn_using_pattern(national_number: str, formatting_pattern: NumberFormat, number_format: int, carrier_code: str | None = ...) -> str: ...
 def example_number(region_code: str) -> PhoneNumber | None: ...
 def invalid_example_number(region_code: str) -> PhoneNumber | None: ...