AddressValue Class

Address field value.

Constructor

AddressValue(*args: Any, **kwargs: Any)

Variables

Name	Description
house_number	str House or building number.
po_box	str Post office box number.
road	str Street name.
city	str Name of city, town, village, etc.
state	str First-level administrative division.
postal_code	str Postal code used for mail sorting.
country_region	str Country/region.
street_address	str Street-level address, excluding city, state, countryRegion, and postalCode.
unit	str Apartment or office number.
city_district	str Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.
state_district	str Second-level administrative division used in certain locales.
suburb	str Unofficial neighborhood name, like Chinatown.
house	str Build name, such as World Trade Center.
level	str Floor number, such as 3F.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

popitem() -> Tuple[str, Any]

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Attributes

city

Name of city, town, village, etc.

city: str | None

city_district

Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.

city_district: str | None

country_region

Country/region.

country_region: str | None

house

Build name, such as World Trade Center.

house: str | None

house_number

House or building number.

house_number: str | None

level

Floor number, such as 3F.

level: str | None

po_box

Post office box number.

po_box: str | None

postal_code

Postal code used for mail sorting.

postal_code: str | None

road

Street name.

road: str | None

state

First-level administrative division.

state: str | None

state_district

Second-level administrative division used in certain locales.

state_district: str | None

street_address

Street-level address, excluding city, state, countryRegion, and postalCode.

street_address: str | None

suburb

Unofficial neighborhood name, like Chinatown.

suburb: str | None

unit

Apartment or office number.

unit: str | None