Locale en_NZ

faker.providers.address

class faker.providers.address.en_NZ.Provider(generator: Any)

Bases: faker.providers.address.en.Provider

address() → str

:example ‘791 Crist Parks, Sashabury, IL 86039-9874’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.address()
...
'848 Wharetahi Street\nRD 6\nWhangapo 9024'
'5 Lewis Gardens\nBeard Flats 6478'
'45 Pukewhakaiti Road\nLeanneside 0116'
'451 Green Crescent\nRongopukekowhai 2358'
'58 Hayward Point\nManawanui 9494'
building_number() → str

:example ‘791’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.building_number()
...
'16'
'88'
'84'
'49'
'3'
city() → str

:example ‘Sashabury’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.city()
...
'Port Jonesleigh'
'Papapatahi'
'Ngaurunui'
'Fletchering'
'Blakeneath'
city_prefix() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.city_prefix()
...
'Port'
'Port'
'North'
'New'
'Lower'
city_suffix() → str

:example ‘town’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.city_suffix()
...
'stone'
'ingsmouth'
'ton'
'burn'
'leigh'
country() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.country()
...
'Tanzania'
'Hungary'
'Senegal'
'Tuvalu'
'Italy'
country_code(representation: str = 'alpha-2') → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.country_code()
...
'MV'
'PS'
'NL'
'BB'
'IL'
current_country() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.current_country()
...
'New Zealand'
'New Zealand'
'New Zealand'
'New Zealand'
'New Zealand'
current_country_code() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.current_country_code()
...
'NZ'
'NZ'
'NZ'
'NZ'
'NZ'
postcode() → str

:example 86039-9874

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.postcode()
...
'8060'
'5787'
'8147'
'6993'
'9024'
rd_number() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.rd_number()
...
'7'
'7'
'1'
'5'
'9'
secondary_address() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.secondary_address()
...
'Unit 16'
'Suite 787'
'Suite 475'
'Level 3'
'Suite 521'
street_address() → str

:example ‘791 Crist Parks’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_address()
...
'50 Papapawharetahi Street\nRD 6'
'Flat 38\n22 Street-Bartlett Cutting'
'Flat 24\n2 Rangikiwi Beach Road'
'45 Pukewhakaiti Road'
'1 Parkes Street'
street_name() → str

:example ‘Crist Parks’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_name()
...
'Tipuwaka Avenue'
'Christie-Hamilton Parade'
'Eglinton-Lucas Place'
'Miller Highway'
'Gore Range Road'
street_suffix() → str

:example ‘Avenue’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.street_suffix()
...
'Rise'
'Street'
'Lane'
'Street'
'Avenue'
te_reo_ending() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.te_reo_ending()
...
'tipu'
'whitu'
'waka'
'horo'
'rohe'
te_reo_first() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.te_reo_first()
...
'Whaka'
'Papapa'
'Tipu'
'Whanga'
'Po'
te_reo_part() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.te_reo_part()
...
'whaka'
'papapa'
'tipu'
'whanga'
'po'

faker.providers.automotive

class faker.providers.automotive.en_NZ.Provider(generator: Any)

Bases: faker.providers.automotive.Provider

Implement automotive provider for en_NZ locale.

Sources:

license_plate() → str

Generate a license plate.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.license_plate()
...
'KYN904'
'NMZ647'
'DQE242'
'FRW592'
'AXC957'

faker.providers.internet

class faker.providers.internet.en_NZ.Provider(generator: Any)

Bases: faker.providers.internet.Provider

ascii_company_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_company_email()
...
'aholloway@carter.school.nz'
'twarner@lucas-reed.kiwi'
'joshuablake@porter.maori.nz'
'lancenash@hughes.geek.nz'
'taniasullivan@carter.nz'
ascii_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_email()
...
'gjones@inspire.net.nz'
'tara59@yahoo.com'
'david19@street-bartlett.maori.nz'
'christopher15@higgins-clarke.geek.nz'
'hsaunders@brown-aldridge.nz'
ascii_free_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_free_email()
...
'aholloway@gmail.com'
'tania76@hotmail.com'
'nlucas@xtra.co.nz'
'joshuablake@xtra.co.nz'
'wendy89@yahoo.com'
ascii_safe_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ascii_safe_email()
...
'aholloway@example.org'
'tania76@example.com'
'nlucas@example.net'
'joshuablake@example.net'
'wendy89@example.org'
company_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.company_email()
...
'aholloway@carter.school.nz'
'twarner@lucas-reed.kiwi'
'joshuablake@porter.maori.nz'
'lancenash@hughes.geek.nz'
'taniasullivan@carter.nz'
dga(year: Optional[int] = None, month: Optional[int] = None, day: Optional[int] = None, tld: Optional[str] = None, length: Optional[int] = None) → str

Generates a domain name by given date https://en.wikipedia.org/wiki/Domain_generation_algorithm

Return type:str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.dga()
...
'hxqvaffcmfsccynscisxeajjagjahtnfcmfsccynscisxeajjagjahtnfcmfscc.kiwi.nz'
'meydkrgdcvulautulqvjofrrnbjkfmvrewtpfttqcjafdhxckmyfamohcpnldug.kiwi.nz'
'iiulfpgbvqcdaehnqkbxmaqgkykorlxnwy.kiwi'
'cpyhexmtvewxpwiiaxtgdfajuhbsyaaykvgkgreki.co.nz'
'uqniukqjckmjabijnuqholpsjayatffafysbsyaaytuquhbpmpviajxnaro.maori.nz'
domain_name(levels: int = 1) → str

Produce an Internet domain name with the specified number of subdomain levels.

>>> domain_name()
nichols-phillips.com
>>> domain_name(2)
williamson-hopkins.jackson.com
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.domain_name()
...
'holloway-currie.kiwi.nz'
'hamilton.school.nz'
'greig-gillies.ac.nz'
'miller.maori.nz'
'street-bartlett.maori.nz'
domain_word() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.domain_word()
...
'holloway-currie'
'christie-hamilton'
'eglinton-lucas'
'fletcher'
'blake'
email(safe: bool = True, domain: Optional[str] = None) → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.email()
...
'aholloway@example.org'
'tania76@example.com'
'nlucas@example.net'
'joshuablake@example.net'
'wendy89@example.org'
free_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.free_email()
...
'aholloway@gmail.com'
'tania76@hotmail.com'
'nlucas@xtra.co.nz'
'joshuablake@xtra.co.nz'
'wendy89@yahoo.com'
free_email_domain() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.free_email_domain()
...
'inspire.net.nz'
'inspire.net.nz'
'gmail.com'
'hotmail.com'
'xtra.co.nz'
hostname(levels: int = 1) → str

Produce a hostname with specified number of subdomain levels.

>>> hostname()
db-01.nichols-phillips.com
>>> hostname(0)
laptop-56
>>> hostname(2)
web-12.williamson-hopkins.jackson.com
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.hostname()
...
'web-66.carter.school.nz'
'laptop-47.greig-gillies.ac.nz'
'srv-42.gore.ac.nz'
'email-92.harris-williams.geek.nz'
'laptop-81.nicholson-small.kiwi'
http_method() → str

Returns random HTTP method https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods

Return type:str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.http_method()
...
'OPTIONS'
'OPTIONS'
'GET'
'DELETE'
'PATCH'
iana_id() → str

Returns IANA Registrar ID https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml

Return type:str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.iana_id()
...
'6463344'
'7056021'
'679216'
'4343903'
'8577767'
image_url(width: Optional[int] = None, height: Optional[int] = None) → str

Returns URL to placeholder image Example: http://placehold.it/640x480

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.image_url()
...
'https://www.lorempixel.com/788/861'
'https://placeimg.com/530/995/any'
'https://placekitten.com/621/976'
'https://placekitten.com/447/285'
'https://placekitten.com/286/194'
ipv4(network: bool = False, address_class: Optional[str] = None, private: Optional[str] = None) → str

Returns a random IPv4 address or network with a valid CIDR.

Parameters:
  • network – Network address
  • address_class – IPv4 address class (a, b, or c)
  • private – Public or private
Returns:

IPv4

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv4()
...
'171.174.170.81'
'95.25.112.121'
'51.105.121.194'
'195.110.164.126'
'141.250.247.54'
ipv4_network_class() → str

Returns a IPv4 network class ‘a’, ‘b’ or ‘c’.

Returns:IPv4 network class
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv4_network_class()
...
'b'
'b'
'a'
'b'
'c'
ipv4_private(network: bool = False, address_class: Optional[str] = None) → str

Returns a private IPv4.

Parameters:
  • network – Network address
  • address_class – IPv4 address class (a, b, or c)
Returns:

Private IPv4

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv4_private()
...
'172.29.117.82'
'10.248.203.131'
'172.25.180.188'
'172.22.253.123'
'192.168.71.140'
ipv4_public(network: bool = False, address_class: Optional[str] = None) → str

Returns a public IPv4 excluding private blocks.

Parameters:
  • network – Network address
  • address_class – IPv4 address class (a, b, or c)
Returns:

Public IPv4

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv4_public()
...
'166.186.169.69'
'111.198.92.30'
'168.155.75.206'
'141.250.247.54'
'212.120.204.37'
ipv6(network: bool = False) → str

Produce a random IPv6 address or network with a valid CIDR

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ipv6()
...
'e3e7:682:c209:4cac:629f:6fbf:d82c:7cd'
'f728:b4fa:4248:5e3a:a5d:2f35:6baa:9455'
'eb11:67b3:67a9:c378:7c65:c1e6:82e2:e662'
'f7c1:bd87:4da5:e709:d471:3d61:c8a7:639'
'e443:df78:9558:867f:5ba9:1fb0:7a02:4204'
mac_address() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.mac_address()
...
'c5:d7:14:84:f8:cf'
'9b:f4:b7:6f:47:90'
'47:30:80:4b:9e:32'
'25:a9:f1:33:b5:de'
'a1:68:f4:e2:85:1f'
nic_handle(suffix: str = 'FAKE') → str

Returns NIC Handle ID https://www.apnic.net/manage-ip/using-whois/guide/person/

Return type:str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.nic_handle()
...
'ZYT1598-FAKE'
'SIW493-FAKE'
'UE59352-FAKE'
'WBUN892-FAKE'
'CHQD98-FAKE'
nic_handles(count: int = 1, suffix: str = '????') → List[str]

Returns NIC Handle ID list

Return type:list[str]
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.nic_handles()
...
['ZYT1598-EWLN']
['WGNZ53-QITZ']
['UERV52-EJGW']
['CHQ498-DZJA']
['UU1864-TEMK']
port_number(is_system: bool = False, is_user: bool = False, is_dynamic: bool = False) → int

Returns a network port number https://tools.ietf.org/html/rfc6335

Parameters:
  • is_system – System or well-known ports
  • is_user – User or registered ports
  • is_dynamic – Dynamic / private / ephemeral ports
Return type:

int

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.port_number()
...
50494
55125
5306
33936
63691
ripe_id() → str

Returns RIPE Organization ID https://www.ripe.net/manage-ips-and-asns/db/support/organisation-object-in-the-ripe-database

Return type:str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.ripe_id()
...
'ORG-ZYT1598-RIPE'
'ORG-SIW493-RIPE'
'ORG-UE59352-RIPE'
'ORG-WBUN892-RIPE'
'ORG-CHQD98-RIPE'
safe_domain_name() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.safe_domain_name()
...
'example.com'
'example.com'
'example.org'
'example.com'
'example.net'
safe_email() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.safe_email()
...
'aholloway@example.org'
'tania76@example.com'
'nlucas@example.net'
'joshuablake@example.net'
'wendy89@example.org'
slug(value: Optional[str] = None) → str

Django algorithm

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.slug()
...
'molestiae-nihil'
'facilis-quaerat'
'necessitatibus'
'perferendis-magnam'
'esse-quae-deserunt'
tld() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.tld()
...
'net.nz'
'net.nz'
'nz'
'kiwi.nz'
'ac.nz'
uri() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri()
...
'https://www.christie-hamilton.kiwi.nz/category/list/main/'
'http://blake.kiwi.nz/explore/posts/list/post.html'
'https://harris.kiwi/'
'https://carter.nz/explore/author.php'
'https://nash.co.nz/'
uri_extension() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri_extension()
...
'.php'
'.php'
'.html'
'.htm'
'.asp'
uri_page() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri_page()
...
'author'
'category'
'privacy'
'category'
'index'
uri_path(deep: Optional[int] = None) → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.uri_path()
...
'posts/tag'
'explore/tag'
'explore/category'
'blog'
'category'
url(schemes: Optional[List[str]] = None) → str
Parameters:schemes – a list of strings to use as schemes, one will chosen randomly.

If None, it will generate http and https urls. Passing an empty list will result in schemeless url generation like “://domain.com”.

Returns:a random url string.
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.url()
...
'https://carter.school.nz/'
'https://lucas-reed.kiwi/'
'http://blake.kiwi.nz/'
'http://nash.geek.nz/'
'https://www.nicholson-small.kiwi/'
user_name() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.user_name()
...
'aholloway'
'carterstephen'
'twarner'
'nlucas'
'joshuablake'

faker.providers.person

class faker.providers.person.en_NZ.Provider(generator: Any)

Bases: faker.providers.person.Provider

first_name() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name()
...
'Megan'
'Jillian'
'Peter'
'John'
'Stephen'
first_name_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_female()
...
'Sarah'
'Rachel'
'Jessica'
'Emily'
'Kelly'
first_name_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_male()
...
'Scott'
'Phillip'
'Jason'
'Dean'
'Kane'
first_name_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.first_name_nonbinary()
...
'Megan'
'Jillian'
'Peter'
'John'
'Stephen'
language_name() → str

Generate a random i18n language name (e.g. English).

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.language_name()
...
'Luba-Katanga'
'Malay'
'Aymara'
'Interlingue'
'Quechua'
last_name() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name()
...
'Franklin'
'Holloway'
'Currie'
'Carter'
'Carr'
last_name_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_female()
...
'Franklin'
'Holloway'
'Currie'
'Carter'
'Carr'
last_name_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_male()
...
'Franklin'
'Holloway'
'Currie'
'Carter'
'Carr'
last_name_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.last_name_nonbinary()
...
'Franklin'
'Holloway'
'Currie'
'Carter'
'Carr'
name() → str

:example ‘John Doe’

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name()
...
'Rachel Currie'
'William Hamilton-Warner'
'William Lucas-Reed'
'Joshua Miller'
'Matthew Neal'
name_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_female()
...
'Rachel Currie'
'William Hamilton-Warner'
'William Lucas-Reed'
'Joshua Miller'
'Matthew Neal'
name_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_male()
...
'Rachel Currie'
'William Hamilton-Warner'
'William Lucas-Reed'
'Joshua Miller'
'Matthew Neal'
name_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.name_nonbinary()
...
'Rachel Currie'
'William Hamilton-Warner'
'William Lucas-Reed'
'Joshua Miller'
'Matthew Neal'
prefix() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix()
...
''
''
''
''
''
prefix_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_female()
...
''
''
''
''
''
prefix_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_male()
...
''
''
''
''
''
prefix_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.prefix_nonbinary()
...
''
''
''
''
''
suffix() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.suffix()
...
''
''
''
''
''
suffix_female() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.suffix_female()
...
''
''
''
''
''
suffix_male() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.suffix_male()
...
''
''
''
''
''
suffix_nonbinary() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.suffix_nonbinary()
...
''
''
''
''
''

faker.providers.phone_number

class faker.providers.phone_number.en_NZ.Provider(generator: Any)

Bases: faker.providers.phone_number.Provider

area_code() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.area_code()
...
'4'
'4'
'20'
'29'
'7'
country_calling_code() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.country_calling_code()
...
'+687'
'+595'
'+880'
'+964'
'+41'
msisdn() → str

https://en.wikipedia.org/wiki/MSISDN

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.msisdn()
...
'6048764759382'
'2194892411578'
'5659387784080'
'6097535139332'
'1158714841858'
phone_number() → str
Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.phone_number()
...
'+64-4-560-4876'
'(03) 293 8242'
'(029) 6892411'
'(07) 915 6593'
'(06) 784 0801'