Feature: Add phone number validator

This PR adds a new custom BeforeValidator annotation based phone number type instead of the concrete type that exists: PhoneNumberValidator

Args:
    default_region (str | None): The default region code to use when parsing phone numbers without an international prefix.
        If `None` (default), the region must be supplied in the phone number as an international prefix.
    number_format (str): The format of the phone number to return. See `phonenumbers.PhoneNumberFormat` for valid values.
    supported_regions (list[str]): The supported regions. If empty, all regions are supported (default).
Returns:
    str: The formatted phone number.

This provides be an option for more composable phone number types, e.g:

from phonenumbers import PhoneNumber
from pydantic_extra_types.phone_numbers import PhoneNumberValidator

# Supports any number supplied with an international code
AnyNumberType = Annotated[
    Union[str, PhoneNumber],
    PhoneNumberValidator()
]
# Supports only US phone numbers
USNumberType = Annotated[
    Union[str, PhoneNumber],
    PhoneNumberValidator(supported_regions=['US'], default_region='US')
]

class SomeModel(BaseModel):
    phone_number: AnyNumberType
    us_number: USNumberType

Seperate type instances avoid any confusion with the class scoped variables
Follows type convention set with custom pydantic types being Annotation based where possible

pydantic / pydantic-extra-types

Feature: Add phone number validator #203

Codecov Report