Skip to content

Annotate tag()'s tag_mapping parameter #412

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

Open
NorthIsUp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Annotate tag()'s tag_mapping parameter #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion usaddress/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,9 @@ def parse(address_string: str) -> list[tuple[str, str]]:
return list(zip(tokens, tags))


def tag(address_string: str, tag_mapping=None) -> tuple[dict[str, str], str]:
def tag(
address_string: str, tag_mapping: typing.Optional[typing.Mapping[str, str]] = None
) -> tuple[dict[str, str], str]:
tagged_components: dict[str, list] = {}

last_label = None
Expand Down
4 changes: 3 additions & 1 deletion usaddress/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ def parse(address_string: str) -> list[tuple[str, str]]:
"""
...

def tag(address_string: str, tag_mapping=None) -> tuple[dict[str, str], str]:
def tag(
address_string: str, tag_mapping: typing.Optional[typing.Mapping[str, str]] = None
) -> tuple[dict[str, str], str]:
"""
Parse and merge consecutive components & strip commas.
Also return an address type (`Street Address`, `Intersection`, `PO Box`, or `Ambiguous`).
Expand Down