Skip to content

Address entity

Generate coherent locale-aware postal addresses and contact details.

Why: Use Address when street, city, postal code, region, country, and contact fields must describe one locale-aware location; use StreetNameGenerator for a single independent street label.

1
<variable name="value" entity="Address"/>

Output: Typed Address value.

Parameters

  • dataset: str | null; Default None — Country dataset controlling address structure and locale-specific values.

Attributes

  • city (str): City or locality name.
  • country (str): Human-readable country name.
  • country_code (str): ISO 3166-1 alpha-2 country code.
  • fax (str): Fax number.
  • full_address (str): Formatted single-line address string.
  • house_number (str): House or building number, including suffix.
  • mobile_phone (str): Mobile contact number.
  • office_phone (str): Office or business phone number.
  • organization (str): Organization line associated with the address.
  • phone (str): Generic contact phone number.
  • postal_code (str): Postal or ZIP code.
  • private_phone (str): Private or residential phone number.
  • state (str): State, province, or region.
  • street (str): Street or thoroughfare name.

Limits

The available attributes and values depend on the registered entity, its dataset, and its documented constructor options.