????
Your IP : 216.73.216.181
"""
flask_security.phone_util
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Utility class for managing phone numbers
:copyright: (c) 2020-2024 by J. Christopher Wagner (jwag).
:license: MIT, see LICENSE for more details.
Avoid making 'phonenumbers' a required package unless needed.
"""
from __future__ import annotations
import typing as t
from .utils import config_value, get_message
if t.TYPE_CHECKING: # pragma: no cover
import flask
class PhoneUtil:
"""
Provide parsing and validation for user inputted phone numbers.
Subclass this to use a different underlying phone number parsing library.
To provide your own implementation, pass in the class as ``phone_util_cls``
at init time. Your class will be instantiated once as part of
Flask-Security initialization.
.. versionadded:: 3.4.0
.. versionchanged:: 4.0.0
__init__ takes app argument, and is instantiated at Flask-Security
initialization time rather than at first request.
"""
def __init__(self, app: flask.Flask):
"""Instantiate class.
:param app: The Flask application being initialized.
"""
pass
def validate_phone_number(self, input_data: str) -> str | None:
"""Return ``None`` if a valid phone number else
the ``PHONE_INVALID`` error message."""
import phonenumbers
try:
z = phonenumbers.parse(
input_data, region=config_value("PHONE_REGION_DEFAULT")
)
if phonenumbers.is_valid_number(z):
return None
except phonenumbers.phonenumberutil.NumberParseException:
pass
return get_message("PHONE_INVALID")[0]
def get_canonical_form(self, input_data: str) -> str | None:
"""Validate and return a canonical form to be stored in DB
and compared against.
Returns ``None`` if input isn't a valid phone number.
"""
import phonenumbers
try:
z = phonenumbers.parse(
input_data, region=config_value("PHONE_REGION_DEFAULT")
)
if phonenumbers.is_valid_number(z):
return phonenumbers.format_number(
z, phonenumbers.PhoneNumberFormat.E164
)
return None
except phonenumbers.phonenumberutil.NumberParseException:
return None