faker API reference

400 public APIs from faker (joke2k/faker) — 106 classes, 4 functions, 290 methods. Signatures extracted by static analysis of the actual source.

Repository: joke2k/faker

Kind	Count
Classes	106
Functions	4
Methods	290

API list

funcfaker.cli.execute_from_command_line(argv:Optional[str]=None) -> None

A simple method that runs a Command.

classfaker.documentor.FakerEnum

Required for faker.providers.enum

classfaker.exceptions.BaseFakerException

The base exception for all Faker exceptions.

classfaker.exceptions.UnsupportedFeature

The requested feature is not available on this system.

methodfaker.generator.Generator.format(formatter:str, *args:Any, **kwargs:Any) -> str

This is a secure way to make a fake from another Provider.

methodfaker.generator.Generator.get_providers() -> List['BaseProvider']

Returns added providers.

methodfaker.generator.Generator.seed_instance(seed:Optional[SeedType]=None) -> 'Generator'

Calls random.seed

methodfaker.generator.Generator.set_formatter(name:str, formatter:Callable) -> None

This method adds a provider method to generator.

methodfaker.providers.BaseProvider.language_code() -> str

Generate a random i18n language code (e.g.

methodfaker.providers.BaseProvider.locale() -> str

Generate a random underscored i18n locale code (e.g.

methodfaker.providers.BaseProvider.random_digit() -> int

Generate a random digit (0 to 9).

methodfaker.providers.BaseProvider.random_digit_above_two() -> int

Generate a random digit above value two (2 to 9).

methodfaker.providers.BaseProvider.random_digit_not_null() -> int

Generate a random non-zero digit (1 to 9).

methodfaker.providers.BaseProvider.random_digit_or_empty() -> Union[int, str]

Generate a random digit (0 to 9) or an empty string.

methodfaker.providers.BaseProvider.random_element(elements:ElementsType[T]=('a', 'b', 'c')) -> T

Generate a randomly sampled object from ``elements``.

method

faker.providers.BaseProvider.random_elements(elements:ElementsType[T]=('a', 'b', 'c'), length:Optional[int]=None, unique:bool=False, use_weighting:Optional[bool]=None) -> Sequence[T]

Generate a list of randomly sampled objects from ``elements``.

methodfaker.providers.BaseProvider.random_letter() -> str

Generate a random ASCII letter (a-z and A-Z).

methodfaker.providers.BaseProvider.random_lowercase_letter() -> str

Generate a random lowercase ASCII letter (a-z).

methodfaker.providers.BaseProvider.random_uppercase_letter() -> str

Generate a random uppercase ASCII letter (A-Z).

methodfaker.providers.address.Provider.address() -> str

:example: '791 Crist Parks, Sashabury, IL 86039-9874'

methodfaker.providers.address.Provider.building_number() -> str

:example: '791'

methodfaker.providers.address.Provider.city() -> str

:example: 'Sashabury'

methodfaker.providers.address.Provider.city_suffix() -> str

:example: 'town'

methodfaker.providers.address.Provider.country() -> str

:sample:

methodfaker.providers.address.Provider.current_country() -> str

:sample:

methodfaker.providers.address.Provider.current_country_code() -> str

:sample:

methodfaker.providers.address.Provider.postcode() -> str

:example: 86039-9874

methodfaker.providers.address.Provider.street_address() -> str

:example: '791 Crist Parks'

methodfaker.providers.address.Provider.street_name() -> str

:example: 'Crist Parks'

methodfaker.providers.address.Provider.street_suffix() -> str

:example: 'Avenue'

classfaker.providers.address.ar_DZ.Provider

Address provider for ar_DZ locale.

methodfaker.providers.address.az_AZ.Provider.administrative_unit() -> str

:example: 'Xankəndi'

methodfaker.providers.address.az_AZ.Provider.city() -> str

:example: 'Xankəndi'

methodfaker.providers.address.az_AZ.Provider.city_suffix() -> str

:example: 'ş.'

methodfaker.providers.address.az_AZ.Provider.district() -> str

:example: 'Babək'

methodfaker.providers.address.az_AZ.Provider.district_suffix() -> str

:example: 'r.'

methodfaker.providers.address.az_AZ.Provider.house_number() -> str

:example: 'm.

methodfaker.providers.address.az_AZ.Provider.postcode() -> str

:example: 'AZ1027'

methodfaker.providers.address.az_AZ.Provider.settlement() -> str

:example: 'Horadiz'

methodfaker.providers.address.az_AZ.Provider.settlement_suffix() -> str

:example: 'qəs.'

methodfaker.providers.address.az_AZ.Provider.street() -> str

:example: 'A.AĞAYEV'

methodfaker.providers.address.az_AZ.Provider.street_suffix() -> str

:example: 'küç.'

methodfaker.providers.address.az_AZ.Provider.village() -> str

:example: 'Didivar'

methodfaker.providers.address.az_AZ.Provider.village_suffix() -> str

:example: 'k.'

methodfaker.providers.address.bn_BD.Provider.administrative_unit() -> str

:example: 'ঢাকা'

methodfaker.providers.address.bn_BD.Provider.area_name() -> str

:example: 'উজির'

methodfaker.providers.address.bn_BD.Provider.building_name() -> str

:example: 'বাড়ী নং'

methodfaker.providers.address.bn_BD.Provider.building_number() -> str

:example: '791' to '৭৯১'

methodfaker.providers.address.bn_BD.Provider.city() -> str

:example: 'ঢাকা'

methodfaker.providers.address.bn_BD.Provider.city_prefix() -> str

:example: 'উত্তর'

methodfaker.providers.address.bn_BD.Provider.town() -> str

:example: 'নবাব'

methodfaker.providers.address.da_DK.Provider.dk_street_name() -> str

This returns the name of a street, without any suffix.

methodfaker.providers.address.de_CH.Provider.administrative_unit() -> str

Randomly returns a Swiss canton name.

methodfaker.providers.address.de_CH.Provider.canton() -> Tuple[str, str]

Randomly returns a swiss canton ('Abbreviated', 'Name').

methodfaker.providers.address.de_CH.Provider.canton_code() -> str

Randomly returns a Swiss canton code.

methodfaker.providers.address.de_CH.Provider.city_name() -> str

Randomly returns a swiss city.

methodfaker.providers.address.en_BD.Provider.administrative_unit() -> str

:example: 'Dhaka'

methodfaker.providers.address.en_BD.Provider.area_name() -> str

:example: 'Dhanmondi'

methodfaker.providers.address.en_BD.Provider.building_name() -> str

:example: 'House No.'

methodfaker.providers.address.en_BD.Provider.building_number() -> str

:example: '791'

methodfaker.providers.address.en_BD.Provider.city() -> str

:example: 'Dhaka'

methodfaker.providers.address.en_BD.Provider.city_prefix() -> str

:example: 'North'

methodfaker.providers.address.en_BD.Provider.town() -> str

:example: 'Dhanmondi'

methodfaker.providers.address.en_CA.Provider.postcode() -> str

Returns a random postcode

methodfaker.providers.address.en_IN.Provider.pincode_in_military() -> int

Random PIN Code within Army Postal Service range

methodfaker.providers.address.en_IN.Provider.union_territory() -> str

Returns random union territory name

methodfaker.providers.address.en_MS.Provider.street_name() -> str

:example: 'Crist Parks'

methodfaker.providers.address.en_US.Provider.military_apo() -> str

:example: 'PSC 5394 Box 3492

methodfaker.providers.address.en_US.Provider.military_dpo() -> str

:example: 'Unit 3333 Box 9342'

methodfaker.providers.address.en_US.Provider.military_ship() -> str

:example: 'USS'

methodfaker.providers.address.en_US.Provider.military_state() -> str

:example: 'APO'

methodfaker.providers.address.es_AR.Provider.address() -> str

:example: "Calle 1 N° 23, La Plata 1900, Buenos Aires"

methodfaker.providers.address.es_AR.Provider.building_number() -> str

:example: "23"

methodfaker.providers.address.es_AR.Provider.municipality() -> str

:example: "La Plata"

methodfaker.providers.address.es_AR.Provider.municipality_code() -> str

:example: "1900"

methodfaker.providers.address.es_AR.Provider.postcode() -> str

:example: "1900"

methodfaker.providers.address.es_AR.Provider.province() -> str

:example: "Buenos Aires"

methodfaker.providers.address.es_AR.Provider.provinces_code() -> str

:example: "BA"

methodfaker.providers.address.es_AR.Provider.secondary_address() -> str

:example: "Departamento 123"

methodfaker.providers.address.es_AR.Provider.street_address() -> str

:example: "Calle 1 N° 23"

methodfaker.providers.address.es_AR.Provider.street_municipality() -> str

:example: "La Plata"

methodfaker.providers.address.es_AR.Provider.street_name() -> str

:example: "Calle 1"

methodfaker.providers.address.es_AR.Provider.street_prefix() -> str

:example: "Calle"

methodfaker.providers.address.es_AR.Provider.street_procer() -> str

:example: "Belgrano"

methodfaker.providers.address.es_AR.Provider.street_province() -> str

:example: "San Juan"

methodfaker.providers.address.es_AR.Provider.street_suffix() -> str

:example: "Sur"

methodfaker.providers.address.es_CO.Provider.address() -> str

:example: "Calle 1 # 2-3 11001 Bogotá D.C."

methodfaker.providers.address.es_CO.Provider.building_number() -> str

:example: "2-3"

methodfaker.providers.address.es_CO.Provider.department() -> str

:example: "Bogotá, D.C."

methodfaker.providers.address.es_CO.Provider.department_code() -> str

:example: "11"

methodfaker.providers.address.es_CO.Provider.municipality() -> str

:example: "Bogotá, D.C."

methodfaker.providers.address.es_CO.Provider.municipality_code() -> str

:example: "11001"

methodfaker.providers.address.es_CO.Provider.postcode() -> str

:example: "11001"

methodfaker.providers.address.es_CO.Provider.secondary_address() -> str

:example: "Apartamento 123"

methodfaker.providers.address.es_CO.Provider.street_address() -> str

:example: "Calle 1 # 2-3"

methodfaker.providers.address.es_CO.Provider.street_name() -> str

:example: "Calle 1"

methodfaker.providers.address.es_CO.Provider.street_prefix() -> str

:example: "Calle"

methodfaker.providers.address.es_CO.Provider.street_suffix() -> str

:example: "Sur"

methodfaker.providers.address.es_MX.Provider.administrative_unit() -> str

example: u'Guerrero'

methodfaker.providers.address.es_MX.Provider.secondary_address() -> str

:example '020 Interior 999'

methodfaker.providers.address.es_MX.Provider.state_abbr() -> str

example: u'GRO'

methodfaker.providers.address.es_MX.Provider.street_prefix() -> str

:example 'Avenida'

classfaker.providers.address.fil_PH.Provider

No difference from Address Provider for en_PH locale

methodfaker.providers.address.fr_CA.Provider.street_prefix() -> str

:example: 'rue'

methodfaker.providers.address.fr_CH.Provider.administrative_unit() -> str

Randomly returns a Swiss canton name.

methodfaker.providers.address.fr_CH.Provider.canton() -> Tuple[str, str]

Randomly returns a swiss canton ('Abbreviated' , 'Name').

methodfaker.providers.address.fr_CH.Provider.canton_code() -> str

Randomly returns a Swiss canton code.

methodfaker.providers.address.fr_CH.Provider.city_prefix() -> str

:example: 'rue'

methodfaker.providers.address.fr_CH.Provider.street_prefix() -> str

:example: 'rue'

classfaker.providers.address.fr_DZ.Provider

Address provider for fr_DZ locale.

methodfaker.providers.address.fr_FR.Provider.administrative_unit() -> str

:example: 'Guadeloupe'

methodfaker.providers.address.fr_FR.Provider.city_prefix() -> str

:example: 'rue'

methodfaker.providers.address.fr_FR.Provider.department_name() -> str

Randomly returns a french department name.

methodfaker.providers.address.fr_FR.Provider.department_number() -> str

Randomly returns a french department number.

methodfaker.providers.address.fr_FR.Provider.street_prefix() -> str

:example: 'rue'

methodfaker.providers.address.hu_HU.Provider.city() -> str

:example: 'Györgyháza'

methodfaker.providers.address.hy_AM.Provider.administrative_unit() -> str

:example: 'Կոտայք'

methodfaker.providers.address.hy_AM.Provider.city() -> str

:example: 'Բյուրեղավան'

methodfaker.providers.address.hy_AM.Provider.city_prefix() -> str

:example: 'ք.'

methodfaker.providers.address.hy_AM.Provider.postcode() -> str

:example: '3159'

methodfaker.providers.address.hy_AM.Provider.postcode_in_state(state_abbr:Optional[str]=None) -> str

:example: '4703'

methodfaker.providers.address.hy_AM.Provider.secondary_address() -> str

:example: 'բն.

methodfaker.providers.address.hy_AM.Provider.state_abbr() -> str

:example: 'ՎՁ'

methodfaker.providers.address.hy_AM.Provider.street() -> str

:example: 'Ոսկերիչների'

methodfaker.providers.address.hy_AM.Provider.street_prefix() -> str

:example: 'փողոց'

methodfaker.providers.address.hy_AM.Provider.village() -> str

:example: 'Ոսկեվազ'

methodfaker.providers.address.hy_AM.Provider.village_prefix() -> str

:example: 'գ.'

methodfaker.providers.address.ja_JP.Provider.administrative_unit() -> str

:example: '東京都'

methodfaker.providers.address.ja_JP.Provider.ban() -> str

:example: '3番'

methodfaker.providers.address.ja_JP.Provider.building_name() -> str

:example: 'コーポ芝浦'

methodfaker.providers.address.ja_JP.Provider.chome() -> str

:example: '1丁目'

methodfaker.providers.address.ja_JP.Provider.city() -> str

:example: '台東区'

methodfaker.providers.address.ja_JP.Provider.gou() -> str

:example: '10号'

methodfaker.providers.address.ja_JP.Provider.postcode() -> str

:example: '101-1212'

methodfaker.providers.address.ja_JP.Provider.town() -> str

:example: '浅草'

methodfaker.providers.address.ja_JP.Provider.zipcode() -> str

:example: '101-1212'

methodfaker.providers.address.ko_KR.Provider.address_detail() -> str

:example: 가나아파트 가동 102호

methodfaker.providers.address.ko_KR.Provider.administrative_unit() -> str

:example: 경기도

methodfaker.providers.address.ko_KR.Provider.borough() -> str

:example: 중구

methodfaker.providers.address.ko_KR.Provider.building_dong() -> str

:example: 가

methodfaker.providers.address.ko_KR.Provider.building_name() -> str

:example: 김구아파트

methodfaker.providers.address.ko_KR.Provider.building_suffix() -> str

:example: 아파트

methodfaker.providers.address.ko_KR.Provider.city() -> str

:example: 고양시

methodfaker.providers.address.ko_KR.Provider.land_address() -> str

:example: 세종특별자치시 어진동 507

methodfaker.providers.address.ko_KR.Provider.land_number() -> str

:example: 507

methodfaker.providers.address.ko_KR.Provider.metropolitan_city() -> str

:example: 서울특별시

methodfaker.providers.address.ko_KR.Provider.old_postal_code() -> str

:example: 123-456

methodfaker.providers.address.ko_KR.Provider.postal_code() -> str

:example: 12345

methodfaker.providers.address.ko_KR.Provider.postcode() -> str

:example: 12345

methodfaker.providers.address.ko_KR.Provider.road() -> str

:example: 도움5로

methodfaker.providers.address.ko_KR.Provider.road_address() -> str

:example: 세종특별자치시 도움5로 19 (어진동)

methodfaker.providers.address.ko_KR.Provider.road_name() -> str

:example: 압구정

methodfaker.providers.address.ko_KR.Provider.road_number() -> str

:example: 24

methodfaker.providers.address.ko_KR.Provider.road_suffix() -> str

:example: 길

methodfaker.providers.address.ko_KR.Provider.town() -> str

:example: 가나동

methodfaker.providers.address.ko_KR.Provider.town_suffix() -> str

:example: 동

classfaker.providers.address.mk_MK.Provider

Address provider for mk_MK locale (Macedonian).

methodfaker.providers.address.ne_NP.Provider.administrative_unit() -> str

:example: सुदूरपश्चिम प्रदेश

methodfaker.providers.address.ne_NP.Provider.building_prefix() -> str

:example: वडा

methodfaker.providers.address.ne_NP.Provider.city() -> str

:example: कावासोती

methodfaker.providers.address.ne_NP.Provider.district() -> str

:example: अछाम

methodfaker.providers.address.pl_PL.Provider.administrative_unit() -> str

:example: 'Wielkopolskie'

methodfaker.providers.address.pl_PL.Provider.city() -> str

Randomly returns a city name :example: 'Konin'

methodfaker.providers.address.pl_PL.Provider.postalcode() -> str

:example: '62-200'

methodfaker.providers.address.pl_PL.Provider.postcode() -> str

:example: '62-200'

methodfaker.providers.address.pl_PL.Provider.street_prefix() -> str

Randomly returns a street prefix :example: 'aleja'

methodfaker.providers.address.pl_PL.Provider.zipcode() -> str

:example: '62-200'

methodfaker.providers.address.pt_BR.Provider.bairro() -> str

Randomly returns a bairro (neighborhood) name.

methodfaker.providers.address.pt_BR.Provider.estado() -> Tuple[str, str]

Randomly returns a Brazilian State ('sigla' , 'nome').

methodfaker.providers.address.pt_BR.Provider.postcode(formatted:bool=True) -> str

Randomly returns a postcode.

methodfaker.providers.address.pt_BR.Provider.street_prefix() -> str

:example: 'rua'

methodfaker.providers.address.pt_PT.Provider.administrative_unit() -> str

:example: 'Bragança'

methodfaker.providers.address.pt_PT.Provider.city_name() -> str

:example: 'Amora'

methodfaker.providers.address.pt_PT.Provider.concelho() -> str

:example: 'Tondela'

methodfaker.providers.address.pt_PT.Provider.freguesia() -> str

:example: 'Miranda do Douro'

methodfaker.providers.address.pt_PT.Provider.place_name() -> str

:example: "do Pombal"

methodfaker.providers.address.pt_PT.Provider.street_prefix() -> str

:example: 'Rua'

methodfaker.providers.address.ro_RO.Provider.administrative_unit() -> str

:example: u'Timiș'

methodfaker.providers.address.ro_RO.Provider.secondary_address() -> str

:example: 'Bl.

methodfaker.providers.address.ro_RO.Provider.state_abbr() -> str

:example: u'TM'

methodfaker.providers.address.ro_RO.Provider.street_prefix() -> str

:example: 'Strada'

methodfaker.providers.address.th_TH.Provider.administrative_unit() -> str

:example: 'อุบลราชธานี'

methodfaker.providers.address.th_TH.Provider.amphoe() -> str

Get a random Amphoe (district) name.

methodfaker.providers.address.th_TH.Provider.street_prefix() -> str

:example: 'ถนน'

methodfaker.providers.address.th_TH.Provider.tambon() -> str

Get a random Tambon (subdistrict) name.

classfaker.providers.address.tl_PH.Provider

No difference from Address Provider for en_PH locale

methodfaker.providers.address.uk_UA.Provider.city_name() -> str

:sample:

methodfaker.providers.address.uk_UA.Provider.city_prefix() -> str

:sample:

methodfaker.providers.address.uk_UA.Provider.postcode() -> str

The code consists of five digits (01000-99999) :sample:

methodfaker.providers.address.uk_UA.Provider.region() -> str

:sample:

methodfaker.providers.address.uk_UA.Provider.street_name() -> str

:sample:

methodfaker.providers.address.uk_UA.Provider.street_prefix() -> str

:sample:

methodfaker.providers.address.uk_UA.Provider.street_title() -> str

:sample:

classfaker.providers.address.vi_VN.Provider

Provider for generating Vietnamese addresses.

methodfaker.providers.address.vi_VN.Provider.administrative_unit() -> str

Returns a random administrative unit (province).

methodfaker.providers.address.vi_VN.Provider.city_prefix() -> str

Returns a random city prefix.

methodfaker.providers.address.vi_VN.Provider.postcode() -> str

Returns a random postcode.

classfaker.providers.address.zu_ZA.Provider

Address Provider for the zu_ZA locale (Zulu, South Africa).

methodfaker.providers.address.zu_ZA.Provider.administrative_unit() -> str

:sample:

methodfaker.providers.address.zu_ZA.Provider.building_number() -> str

:sample:

methodfaker.providers.address.zu_ZA.Provider.city_name() -> str

:sample:

methodfaker.providers.address.zu_ZA.Provider.city_name_suffix() -> str

:sample:

methodfaker.providers.address.zu_ZA.Provider.province() -> str

:sample:

methodfaker.providers.address.zu_ZA.Provider.secondary_address() -> str

:sample:

methodfaker.providers.address.zu_ZA.Provider.section_number() -> str

:sample:

methodfaker.providers.address.zu_ZA.Provider.street_name() -> str

:sample:

methodfaker.providers.address.zu_ZA.Provider.street_suffix() -> str

:sample:

classfaker.providers.automotive.Provider

Implement default automotive provider for Faker.

methodfaker.providers.automotive.Provider.license_plate() -> str

Generate a license plate.

methodfaker.providers.automotive.Provider.vin() -> str

Generate vin number.

classfaker.providers.automotive.ar_BH.Provider

Implement automotive provider for ``ar_BH`` locale.

classfaker.providers.automotive.ar_DZ.Provider

Implement automotive provider for ``ar_DZ`` locale.

classfaker.providers.automotive.ar_JO.Provider

Implement automotive provider for ``ar_JO`` locale.

methodfaker.providers.automotive.ar_JO.Provider.initials() -> str

Generate an initial number for license plates.

methodfaker.providers.automotive.ar_JO.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.ar_PS.Provider

Implement automotive provider for ``ar_PS`` locale.

methodfaker.providers.automotive.ar_PS.Provider.district() -> str

Generate a district code for license plates.

methodfaker.providers.automotive.ar_PS.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.ar_SA.Provider

Implement automotive provider for ``ar_SA`` locale.

methodfaker.providers.automotive.ar_SA.Provider.license_plate_ar() -> str

Generate a license plate in Arabic characters.

methodfaker.providers.automotive.ar_SA.Provider.license_plate_en() -> str

Generate a license plate in Latin/Western characters.

classfaker.providers.automotive.az_AZ.Provider

Implement license formats for ``az_AZ`` locale.

methodfaker.providers.automotive.az_AZ.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.bn_BD.Provider

Implement automotive provider for ``bn_BD`` locale.

methodfaker.providers.automotive.bn_BD.Provider.city_name() -> str

:example: 'ঢাকা মেট্রো'

methodfaker.providers.automotive.bn_BD.Provider.license_plate() -> str

Generate a license plate.

methodfaker.providers.automotive.bn_BD.Provider.vehicle_category_letter() -> str

:example: 'ব'

methodfaker.providers.automotive.bn_BD.Provider.vehicle_category_number() -> str

:example: '১১'

methodfaker.providers.automotive.bn_BD.Provider.vehicle_serial_number() -> str

Generate a 4 digits vehicle serial number.

funcfaker.providers.automotive.calculate_vin_str_weight(s:str, weight_factor:list) -> int

multiply s(str) by weight_factor char by char e.g.

classfaker.providers.automotive.da_DK.Provider

Implement automotive provider for ``da_DK`` locale.

classfaker.providers.automotive.de_AT.Provider

Implement automotive provider for ``de_AT`` locale.

methodfaker.providers.automotive.de_AT.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.de_CH.Provider

Implement automotive provider for ``de_CH`` locale.

methodfaker.providers.automotive.de_CH.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.de_DE.Provider

Implement automotive provider for ``de_DE`` locale.

methodfaker.providers.automotive.de_DE.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.el_GR.Provider

Implement automotive provider for ``el_GR`` locale.

methodfaker.providers.automotive.el_GR.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.en_CA.Provider

Implement automotive provider for ``en_CA`` locale.

classfaker.providers.automotive.en_GB.Provider

Implement automotive provider for ``en_GB`` locale.

classfaker.providers.automotive.en_NZ.Provider

Implement automotive provider for ``en_NZ`` locale.

classfaker.providers.automotive.en_PH.Provider

Implement automotive provider for ``en_PH`` locale.

methodfaker.providers.automotive.en_PH.Provider.automobile_license_plate() -> str

Generate an automobile license plate.

methodfaker.providers.automotive.en_PH.Provider.license_plate() -> str

Generate a license plate.

methodfaker.providers.automotive.en_PH.Provider.motorcycle_license_plate() -> str

Generate a motorcycle license plate.

methodfaker.providers.automotive.en_PH.Provider.protocol_license_plate() -> str

Generate a protocol license plate.

classfaker.providers.automotive.en_US.Provider

Implement automotive provider for ``en_US`` locale.

classfaker.providers.automotive.es_AR.Provider

Implement automotive provider for ``es_AR`` locale.

methodfaker.providers.automotive.es_AR.Provider.license_plate() -> str

Generate a license plate.

methodfaker.providers.automotive.es_AR.Provider.license_plate_mercosur() -> str

Generate an new plate with Mercosur format.

methodfaker.providers.automotive.es_AR.Provider.license_plate_old() -> str

Generate an old format license plate.

classfaker.providers.automotive.es_CL.Provider

Implement automotive provider for ``es`` locale.

methodfaker.providers.automotive.es_CL.Provider.license_plate() -> str

Generate a license plate.

methodfaker.providers.automotive.es_CL.Provider.license_plate_old() -> str

Generate an old format license plate.

classfaker.providers.automotive.es_ES.Provider

Implement automotive provider for ``es_ES`` locale.

methodfaker.providers.automotive.es_ES.Provider.license_plate() -> str

Generate a license plate.

methodfaker.providers.automotive.es_ES.Provider.license_plate_by_province(province_prefix:Optional[str]=None) -> str

Generate a provincial license plate.

methodfaker.providers.automotive.es_ES.Provider.license_plate_unified() -> str

Generate a unified license plate.

classfaker.providers.automotive.es_MX.Provider

Implement automotive provider for the ``es_MX`` locale.

methodfaker.providers.automotive.es_MX.Provider.license_plate() -> str

Generate a Mexican license plate.

methodfaker.providers.automotive.es_MX.Provider.license_plate_state() -> str

Return the official name of a random federal entity.

methodfaker.providers.automotive.es_MX.Provider.motorcycle_license_plate() -> str

Generate a Mexican motorcycle license plate.

classfaker.providers.automotive.et_EE.Provider

Implement automotive provider for ``et_EE`` locale.

classfaker.providers.automotive.fi_FI.Provider

Implement automotive provider for ``fi_FI`` locale.

classfaker.providers.automotive.fil_PH.Provider

Implement automotive provider for ``fil_PH`` locale.

classfaker.providers.automotive.fr_FR.Provider

Implement automotive provider for ``fr_FR`` locale.

classfaker.providers.automotive.he_IL.Provider

Implement automotive provider for ``he_IL`` locale.

classfaker.providers.automotive.hu_HU.Provider

Implement automotive provider for ``hu_HU`` locale.

classfaker.providers.automotive.id_ID.Provider

Implement automotive provider for ``id_ID`` locale.

classfaker.providers.automotive.it_IT.Provider

Implement automotive provider for ``it_IT`` locale.

classfaker.providers.automotive.ja_JP.Provider

Implement automotive provider for ``ja_JP`` locale.

methodfaker.providers.automotive.ja_JP.Provider.license_plate() -> str

Generate a Japanese license plate.

classfaker.providers.automotive.ko_KR.Provider

Implement automotive provider for ``ko_KR`` locale.

classfaker.providers.automotive.lt_LT.Provider

Implement automotive provider for ``lt_LT`` locale.

classfaker.providers.automotive.mk_MK.Provider

Automotive provider for mk_MK locale (Macedonian).

classfaker.providers.automotive.nl_BE.Provider

Implement automotive provider for `nl_BE` locale.

classfaker.providers.automotive.nl_NL.Provider

Implement automotive provider for `nl_NL` locale.

methodfaker.providers.automotive.nl_NL.Provider.license_plate() -> str

Generate a license plate.

methodfaker.providers.automotive.nl_NL.Provider.license_plate_car() -> str

Generate a license plate for cars.

methodfaker.providers.automotive.nl_NL.Provider.license_plate_motorbike() -> str

Generate a license plate for motorbikes.

classfaker.providers.automotive.no_NO.Provider

Implement automotive provider for ``hu_HU`` locale.

classfaker.providers.automotive.pl_PL.Provider

Implement automotive provider for ``pl_PL`` locale.

methodfaker.providers.automotive.pl_PL.Provider.license_plate_regex_formats() -> List[str]

Return a regex for matching license plates.

classfaker.providers.automotive.pt_BR.Provider

Implement automotive provider for ``pt_BR`` locale.

classfaker.providers.automotive.pt_PT.Provider

Implement automotive provider for ``pt_PT`` locale.

classfaker.providers.automotive.ro_RO.Provider

Implement automotive provider for ``ro_RO`` locale.

methodfaker.providers.automotive.ro_RO.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.ru_RU.Provider

Implement automotive provider for ``ru_RU`` locale.

methodfaker.providers.automotive.ru_RU.Provider.license_plate() -> str

Generate a license plate.

methodfaker.providers.automotive.ru_RU.Provider.plate_letter() -> str

Generate a letter for license plates.

methodfaker.providers.automotive.ru_RU.Provider.plate_number() -> str

Generate a number for license plates.

methodfaker.providers.automotive.ru_RU.Provider.plate_number_extra() -> str

Generate extra numerical code for license plates.

methodfaker.providers.automotive.ru_RU.Provider.plate_number_special() -> str

Generate a special code for license plates.

methodfaker.providers.automotive.ru_RU.Provider.plate_suffix() -> str

Generate a suffix code for license plates.

methodfaker.providers.automotive.ru_RU.Provider.vehicle_category() -> str

Generate a vehicle category code for license plates.

classfaker.providers.automotive.sk_SK.Provider

Implement automotive provider for ``sk_SK`` locale.

methodfaker.providers.automotive.sk_SK.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.sq_AL.Provider

Implement automotive provider for ``sq_AL`` locale.

classfaker.providers.automotive.sv_SE.Provider

Implement automotive provider for ``sv_SE`` locale.

classfaker.providers.automotive.th_TH.Provider

Implement automotive provider for ``th_TH`` locale.

methodfaker.providers.automotive.th_TH.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.tl_PH.Provider

Implement automotive provider for ``tl_PH`` locale.

classfaker.providers.automotive.tr_TR.Provider

Implement automotive provider for ``tr_TR`` locale.

methodfaker.providers.automotive.tr_TR.Provider.license_plate() -> str

Generate a license plate.

method

faker.providers.automotive.uk_UA.Provider.license_plate(region_name:Optional[str]=None, temporary_plate:bool=False) -> str

Generate a license plate.

methodfaker.providers.automotive.uk_UA.Provider.plate_letter_prefix(region_name:Optional[str]=None) -> str

Generate a letter for license plates.

methodfaker.providers.automotive.uk_UA.Provider.plate_letter_suffix() -> str

Generate a end letter for license plates.

methodfaker.providers.automotive.uk_UA.Provider.plate_number() -> str

Generate a number for license plates.

methodfaker.providers.automotive.uk_UA.Provider.vehicle_category() -> str

Generate a vehicle category code for license plates.

classfaker.providers.automotive.vi_VN.Provider

Implement automotive provider for ``vi_VN`` locale.

methodfaker.providers.automotive.vi_VN.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.zh_CN.Provider

Implement automotive provider for `zh_CN` locale.

methodfaker.providers.automotive.zh_CN.Provider.license_plate() -> str

Generate a license plate.

classfaker.providers.automotive.zh_TW.Provider

Implement automotive provider for ``zh_TW`` locale.

classfaker.providers.bank.Provider

Implement default bank provider for Faker.

methodfaker.providers.bank.Provider.aba() -> str

Generate an ABA routing transit number.

methodfaker.providers.bank.Provider.bank() -> str

Generate a bank name.

methodfaker.providers.bank.Provider.bban() -> str

Generate a Basic Bank Account Number (BBAN).

methodfaker.providers.bank.Provider.iban() -> str

Generate an International Bank Account Number (IBAN).

methodfaker.providers.bank.Provider.swift(length:Optional[int]=None, primary:bool=False, use_dataset:bool=False) -> str

Generate a SWIFT code.

methodfaker.providers.bank.Provider.swift11(primary:bool=False, use_dataset:bool=False) -> str

Generate an 11-digit SWIFT code.

methodfaker.providers.bank.Provider.swift8(use_dataset:bool=False) -> str

Generate an 8-digit SWIFT code.

classfaker.providers.bank.az_AZ.Provider

Implement bank provider for ``az_AZ`` locale.

classfaker.providers.bank.bn_BD.Provider

Implement bank provider for ``bn_BD`` locale.

classfaker.providers.bank.cs_CZ.Provider

Implement bank provider for ``cs_CZ`` locale.

classfaker.providers.bank.da_DK.Provider

Implement bank provider for ``da_DK`` locale.

classfaker.providers.bank.de_AT.Provider

Implement bank provider for ``de_AT`` locale.

classfaker.providers.bank.de_CH.Provider

Implement bank provider for ``de_CH`` locale.

classfaker.providers.bank.de_DE.Provider

Implement bank provider for ``de_DE`` locale.

classfaker.providers.bank.el_GR.Provider

Implement bank provider for ``el_GR`` locale.

classfaker.providers.bank.en_GB.Provider

Implement bank provider for ``en_GB`` locale.

classfaker.providers.bank.en_IE.Provider

Implement bank provider for ``en_IE`` locale.

classfaker.providers.bank.en_IN.Provider

Implement bank provider for ``en_IN`` locale.

methodfaker.providers.bank.en_IN.Provider.bank() -> str

Generate a bank name.

classfaker.providers.bank.en_PH.Provider

Implement bank provider for ``en_PH`` locale.

methodfaker.providers.bank.en_PH.Provider.bban() -> str

Generate a Basic Bank Account Number (BBAN).

methodfaker.providers.bank.en_PH.Provider.iban() -> str

Generate an International Bank Account Number (IBAN).

classfaker.providers.bank.es_AR.Provider

Implement bank provider for ``es_AR`` locale.

classfaker.providers.bank.es_ES.Provider

Implement bank provider for ``es_ES`` locale.

classfaker.providers.bank.es_MX.Provider

Bank provider for ``es_MX`` locale.

methodfaker.providers.bank.es_MX.Provider.clabe(bank_code:Optional[int]=None) -> str

Generate a mexican bank account CLABE.

funcfaker.providers.bank.es_MX.get_clabe_control_digit(clabe:str) -> int

Generate the checksum digit for a CLABE.

funcfaker.providers.bank.es_MX.is_valid_clabe(clabe:str) -> bool

Check if a CLABE is valid using the checksum.

classfaker.providers.bank.fa_IR.Provider

Implement bank provider for ``fa_IR`` locale.

classfaker.providers.bank.fi_FI.Provider

Implement bank provider for ``fi_FI`` locale.

classfaker.providers.bank.fil_PH.Provider

Implement bank provider for ``fil_PH`` locale.

classfaker.providers.bank.fr_CH.Provider

Implement bank provider for ``fr_CH`` locale.

classfaker.providers.bank.fr_FR.Provider

Implement bank provider for ``fr_FR`` locale.

classfaker.providers.bank.it_CH.Provider

Implement bank provider for ``it_CH`` locale.

classfaker.providers.bank.it_IT.Provider

Implement bank provider for ``it_IT`` locale.

classfaker.providers.bank.mk_MK.Provider

Bank provider for mk_MK locale (Macedonian).

classfaker.providers.bank.nl_BE.Provider

Implement bank provider for `nl_BE` locale.

methodfaker.providers.bank.nl_BE.Provider.bban() -> str

Generate a valid BBAN.

methodfaker.providers.bank.nl_BE.Provider.iban() -> str

Generate a valid IBAN.

classfaker.providers.bank.nl_NL.Provider

Implement bank provider for ``nl_NL`` locale.

classfaker.providers.bank.no_NO.Provider

Implement bank provider for ``no_NO`` locale.

classfaker.providers.bank.pl_PL.Provider

Implement bank provider for ``pl_PL`` locale.

classfaker.providers.bank.pt_BR.Provider

Implement bank provider for ``pt_BR`` locale.

classfaker.providers.bank.pt_PT.Provider

Implement bank provider for ``pt_PT`` locale.

classfaker.providers.bank.ro_RO.Provider

Implement bank provider for ``ro_RO`` locale.

classfaker.providers.bank.ru_RU.Provider

Implement bank provider for ``ru_RU`` locale.

methodfaker.providers.bank.ru_RU.Provider.bic() -> str

Generate a bank identification code (BIC).

methodfaker.providers.bank.ru_RU.Provider.checking_account() -> str

Generate a checking account number.

methodfaker.providers.bank.ru_RU.Provider.correspondent_account() -> str

Generate a correspondent account number.

classfaker.providers.bank.sk_SK.Provider

Implement bank provider for ``sk_SK`` locale.

classfaker.providers.bank.th_TH.Provider

Implement bank provider for ``th_TH`` locale.

classfaker.providers.bank.tl_PH.Provider

Implement bank provider for ``tl_PH`` locale.

classfaker.providers.bank.tr_TR.Provider

Implement bank provider for ``tr_TR`` locale.

classfaker.providers.bank.uk_UA.Provider

Implement bank provider for ``uk_UA`` locale.

classfaker.providers.bank.zh_CN.Provider

Implement bank provider for ``zh_CN`` locale.

classfaker.providers.barcode.Provider

Implement default barcode provider for Faker.

methodfaker.providers.barcode.Provider.ean(length:int=13, prefixes:PrefixType=()) -> str

Generate an EAN barcode of the specified ``length``.

methodfaker.providers.barcode.Provider.ean13(prefixes:PrefixType=()) -> str

Generate an EAN-13 barcode.

methodfaker.providers.barcode.Provider.ean8(prefixes:PrefixType=()) -> str

Generate an EAN-8 barcode.

methodfaker.providers.barcode.Provider.localized_ean(length:int=13) -> str

Generate a localized EAN barcode of the specified ``length``.

methodfaker.providers.barcode.Provider.localized_ean13() -> str

Generate a localized EAN-13 barcode.

methodfaker.providers.barcode.Provider.localized_ean8() -> str

Generate a localized EAN-8 barcode.

classfaker.providers.barcode.en_CA.Provider

Implement barcode provider for ``en_CA`` locale.

classfaker.providers.barcode.en_US.Provider

Implement barcode provider for ``en_US`` locale.

methodfaker.providers.barcode.en_US.Provider.ean13(prefixes:PrefixType=(), leading_zero:Optional[bool]=None) -> str

Generate an EAN-13 barcode.

method

faker.providers.barcode.en_US.Provider.upc_a(upc_ae_mode:bool=False, base:Optional[str]=None, number_system_digit:Optional[int]=None) -> str

Generate a 12-digit UPC-A barcode.

method

faker.providers.barcode.en_US.Provider.upc_e(base:Optional[str]=None, number_system_digit:Optional[int]=None, safe_mode:bool=True) -> str

Generate an 8-digit UPC-E barcode.

classfaker.providers.barcode.es_ES.Provider

Implement barcode provider for ``es_ES`` locale.

classfaker.providers.barcode.fr_CA.Provider

Implement bank provider for ``fr_CA`` locale.

classfaker.providers.barcode.ja_JP.Provider

Implement barcode provider for ``ja_JP`` locale.

methodfaker.providers.barcode.ja_JP.Provider.jan(length:int=13) -> str

Generate a JAN barcode of the specified ``length``.

methodfaker.providers.barcode.ja_JP.Provider.jan13() -> str

Generate a 13 digit JAN barcode.

methodfaker.providers.barcode.ja_JP.Provider.jan8() -> str

Generate a 8 digit JAN barcode.

classfaker.providers.color.Provider

Implement default color provider for Faker.

method

faker.providers.color.Provider.color(hue:Optional[HueType]=None, luminosity:Optional[str]=None, color_format:str='hex') -> str

Generate a color in a human-friendly way.

method

faker.providers.color.Provider.color_hsl(hue:Optional[HueType]=None, luminosity:Optional[str]=None) -> Tuple[int, int, int]

Generate a HSL color tuple.

method

faker.providers.color.Provider.color_hsv(hue:Optional[HueType]=None, luminosity:Optional[str]=None) -> Tuple[int, int, int]

Generate a HSV color tuple.

methodfaker.providers.color.Provider.color_name() -> str

Generate a color name.

method

faker.providers.color.Provider.color_rgb(hue:Optional[HueType]=None, luminosity:Optional[str]=None) -> Tuple[int, int, int]

Generate a RGB color tuple of integers.

method

faker.providers.color.Provider.color_rgb_float(hue:Optional[HueType]=None, luminosity:Optional[str]=None) -> Tuple[float, float, float]

Generate a RGB color tuple of floats.

methodfaker.providers.color.Provider.hex_color() -> str

Generate a color formatted as a hex triplet.

methodfaker.providers.color.Provider.rgb_color() -> str

Generate a color formatted as a comma-separated RGB value.

methodfaker.providers.color.Provider.rgb_css_color() -> str

Generate a color formatted as a CSS rgb() function.

methodfaker.providers.color.Provider.safe_color_name() -> str

Generate a web-safe color name.

About this data

These signatures were extracted from the public source of joke2k/faker using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries