Modules

Top-level package for Address Parser.

Address dataclass

Structured Address info.

Source code in addrparser/__init__.py

@dataclass
class Address:
    """Structured Address info."""

    street_name: Optional[str] = None
    house_number: Optional[str] = None
    entrance: Optional[str] = None
    apartment: Optional[str] = None
    post_office_box: Optional[str] = None
    zip_number: Optional[str] = None
    zip_name: Optional[str] = None

AddressParser

Class

Source code in addrparser/parser.py

class AddressParser:
    """Class"""

    def __init__(self, locale: str) -> None:
        """_summary_

        Args:
            locale (str): _description_

        Raises:
            ValueError: _description_
        """
        try:
            self._parser_module = _get_locale_module(locale)
        except ImportError:
            raise ValueError(f"No such locale '{locale}'")

    def parse(self, address: str) -> "Address":
        """Proxy function to localized parse functions.

        Localized parse functions parses an address in text format and returns a
        structured Address named tuple.

        Args:
            address (str): Address in text to be parsed

        Raises:
            AddressParseException: Raises a AddressParseException if the address is
                invalid

        Returns:
            Address: Named tuple containing structured address info
        """

        return self._parser_module.parse(address)

__init__(locale)

summary

Parameters:

Name	Type	Description	Default
locale	str	description	required

Raises:

Type	Description
ValueError	description

Source code in addrparser/parser.py

def __init__(self, locale: str) -> None:
    """_summary_

    Args:
        locale (str): _description_

    Raises:
        ValueError: _description_
    """
    try:
        self._parser_module = _get_locale_module(locale)
    except ImportError:
        raise ValueError(f"No such locale '{locale}'")

parse(address)

Proxy function to localized parse functions.

Localized parse functions parses an address in text format and returns a structured Address named tuple.

Parameters:

Name	Type	Description	Default
address	str	Address in text to be parsed	required

Raises:

Type	Description
AddressParseException	Raises a AddressParseException if the address is invalid

Returns:

Name	Type	Description
Address	'Address'	Named tuple containing structured address info

Source code in addrparser/parser.py

def parse(self, address: str) -> "Address":
    """Proxy function to localized parse functions.

    Localized parse functions parses an address in text format and returns a
    structured Address named tuple.

    Args:
        address (str): Address in text to be parsed

    Raises:
        AddressParseException: Raises a AddressParseException if the address is
            invalid

    Returns:
        Address: Named tuple containing structured address info
    """

    return self._parser_module.parse(address)