Skip to content

Add hyphen to phone numbers #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
whubsch merged 2 commits into from
Dec 16, 2025
Merged

Add hyphen to phone numbers #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fa2cc8
Add hyphen to phone numbers
EMH333 Dec 16, 2025
aa36780
changing one phone format in comment
whubsch Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/atlus/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```

"""
Expand Down
8 changes: 4 additions & 4 deletions src/atlus/atlus.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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}")
10 changes: 5 additions & 5 deletions tests/test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down