diff --git a/README.md b/README.md index d87d36a..eb84452 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ pip install atlus >>> atlus.get_address("789 Oak Dr, Smallville California, 98765")[0] {"addr:housenumber": "789", "addr:street": "Oak Drive", "addr:city": "Smallville", "addr:state": "CA", "addr:postcode": "98765"} >>> atlus.get_phone("(202) 900-9019") -"+1 202-900-9019" +"+1-202-900-9019" ``` ## Docs diff --git a/src/atlus/__init__.py b/src/atlus/__init__.py index ec45294..ff78c27 100644 --- a/src/atlus/__init__.py +++ b/src/atlus/__init__.py @@ -12,7 +12,7 @@ {"addr:housenumber": "789", "addr:street": "Oak Drive", "addr:city": "Smallville", "addr:state": "CA", "addr:postcode": "98765"} >>> atlus.get_phone("(202) 900-9019") -"+1 202-900-9019" +"+1-202-900-9019" ``` """ diff --git a/src/atlus/atlus.py b/src/atlus/atlus.py index a58765f..100238a 100644 --- a/src/atlus/atlus.py +++ b/src/atlus/atlus.py @@ -466,13 +466,13 @@ def get_address(address_string: str) -> tuple[dict[str, str], list[str | None]]: def get_phone(phone: str) -> str: - """Format phone numbers to the US and Canadian standard format of `+1 XXX-XXX-XXXX`. + """Format phone numbers to the US and Canadian standard format of `+1-XXX-XXX-XXXX`. ```python >>> get_phone("2029009019") - "+1 202-900-9019" + "+1-202-900-9019" >>> get_phone("(202) 900-9019") - "+1 202-900-9019" + "+1-202-900-9019" >>> get_phone("202-900-901") ValueError: Invalid phone number: 202-900-901 ``` @@ -491,6 +491,6 @@ def get_phone(phone: str) -> str: ) if phone_valid: return ( - f"+1 {phone_valid.group(1)}-{phone_valid.group(2)}-{phone_valid.group(3)}" + f"+1-{phone_valid.group(1)}-{phone_valid.group(2)}-{phone_valid.group(3)}" ) raise ValueError(f"Invalid phone number: {phone}") diff --git a/tests/test.py b/tests/test.py index 0626d26..2501b3e 100644 --- a/tests/test.py +++ b/tests/test.py @@ -433,11 +433,11 @@ def test_get_address_removed_postcode() -> None: def test_valid_phone_number() -> None: """Test cases for valid phone numbers""" - assert get_phone("2029009019") == "+1 202-900-9019" - assert get_phone("(202) 900-9019") == "+1 202-900-9019" - assert get_phone("202-900-9019") == "+1 202-900-9019" - assert get_phone("+1 202 900 9019") == "+1 202-900-9019" - assert get_phone("+1 (202) 900-9019") == "+1 202-900-9019" + assert get_phone("2029009019") == "+1-202-900-9019" + assert get_phone("(202) 900-9019") == "+1-202-900-9019" + assert get_phone("202-900-9019") == "+1-202-900-9019" + assert get_phone("+1 202 900 9019") == "+1-202-900-9019" + assert get_phone("+1 (202) 900-9019") == "+1-202-900-9019" def test_invalid_phone_number_1() -> None: