faker.providers.address.en_US

Package Contents

Classes

AddressProvider

Provider

class faker.providers.address.en_US.AddressProvider(generator: Any)

Bases: faker.providers.address.Provider

countries = ('Afghanistan', 'Albania', 'Algeria', 'American Samoa', 'Andorra', 'Angola', 'Anguilla',...
class faker.providers.address.en_US.Provider(generator: Any)

Bases: faker.providers.address.en.Provider

city_prefixes = ('North', 'East', 'West', 'South', 'New', 'Lake', 'Port')
city_suffixes = ('town', 'ton', 'land', 'ville', 'berg', 'burgh', 'borough', 'bury', 'view', 'port', 'mouth',...
building_number_formats = ('#####', '####', '###')
street_suffixes = ('Alley', 'Avenue', 'Branch', 'Bridge', 'Brook', 'Brooks', 'Burg', 'Burgs', 'Bypass', 'Camp',...
postcode_formats = ('#####', '#####-####')
states = ('Alabama', 'Alaska', 'Arizona', 'Arkansas', 'California', 'Colorado', 'Connecticut',...
states_abbr = ('AL', 'AK', 'AZ', 'AR', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'HI', 'ID', 'IL', 'IN', 'IA',...
states_postcode
territories_abbr = ('AS', 'GU', 'MP', 'PR', 'VI')
freely_associated_states_abbr = ('FM', 'MH', 'PW')
known_usps_abbr
military_state_abbr = ('AE', 'AA', 'AP')
military_ship_prefix = ('USS', 'USNS', 'USNV', 'USCGC')
military_apo_format = 'PSC ####, Box ####'
military_dpo_format = 'Unit #### Box ####'
city_formats = ('{{city_prefix}} {{first_name}}{{city_suffix}}', '{{city_prefix}} {{first_name}}',...
street_name_formats = ('{{first_name}} {{street_suffix}}', '{{last_name}} {{street_suffix}}')
street_address_formats = ('{{building_number}} {{street_name}}', '{{building_number}} {{street_name}} {{secondary_address}}')
address_formats
secondary_address_formats = ('Apt. ###', 'Suite ###')
state
city_prefix() str
secondary_address() str
administrative_unit() str
state_abbr(include_territories: bool = True, include_freely_associated_states: bool = True) str
Returns

A random two-letter USPS postal code

By default, the resulting code may abbreviate any of the fity states, five US territories, or three freely-associating sovereign states.

Parameters
  • include_territories – If True, territories will be included. If False, US territories will be excluded.

  • include_freely_associated_states – If True, freely-associated states will be included. If False, sovereign states in free association with the US will be excluded.

postcode() str
Example

86039-9874

zipcode_plus4() str
postcode_in_state(state_abbr: Optional[str] = None) str
Returns

A random postcode within the provided state abbreviation

Parameters

state_abbr – A state abbreviation

military_ship() str
Example

‘USS’

military_state() str
Example

‘APO’

military_apo() str
Example

‘PSC 5394 Box 3492

military_dpo() str
Example

‘Unit 3333 Box 9342’

zipcode() str
zipcode_in_state(state_abbr: Optional[str] = None) str
postalcode() str
postalcode_in_state(state_abbr: Optional[str] = None) str
postalcode_plus4() str