Locale fr_FR¶
faker.providers.address
¶
- class faker.providers.address.fr_FR.Provider(generator: Any)¶
Bases:
Provider
- address() str ¶
- Example:
‘791 Crist Parks, Sashabury, IL 86039-9874’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.address() ... '5, avenue de Lebon\n97648 Pelletier-sur-Mer' '51, boulevard de Caron\n39201 Sainte CharlotteBourg' '49, avenue de Pichon\n66366 Saint Éric' '8, rue Nathalie Germain\n90991 Saint Hélène-sur-Mer' '271, boulevard Claudine Nicolas\n38664 Munoz'
- administrative_unit() str ¶
- Example:
‘Guadeloupe’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.administrative_unit() ... 'Guyane' 'Saint-Pierre-et-Miquelon' 'Auvergne' 'Haute-Normandie' 'Nouvelle-Calédonie'
- building_number() str ¶
- Example:
‘791’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.building_number() ... '16' '88' '84' '49' '324'
- city() str ¶
- Example:
‘Sashabury’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.city() ... 'Thierrynec' 'Sainte Danielle' 'Lebon-la-Forêt' 'Pelletier-sur-Mer' 'Joly-la-Forêt'
- city_prefix() str ¶
- Example:
‘rue’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.city_prefix() ... 'Sainte' 'Sainte' 'Saint' 'Sainte' 'Sainte'
- city_suffix() str ¶
- Example:
‘town’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.city_suffix() ... 'nec' 'nec' 'Ville' '-la-Forêt' 'dan'
- country() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.country() ... 'Tonga' 'Iran' 'Slovénie' 'Venezuela' 'Kenya'
- 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() ... 'France' 'France' 'France' 'France' 'France'
- current_country_code() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.current_country_code() ... 'FR' 'FR' 'FR' 'FR' 'FR'
- department() Tuple[str, str] ¶
Randomly returns a french department (‘departmentNumber’ , ‘departmentName’). :example: (‘2B’ . ‘Haute-Corse’)
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.department() ... ('49', 'Maine-et-Loire') ('972', 'Martinique') ('53', 'Mayenne') ('06', 'Alpes-Maritimes') ('33', 'Gironde')
- department_name() str ¶
Randomly returns a french department name. :example: ‘Ardèche’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.department_name() ... 'Maine-et-Loire' 'Martinique' 'Mayenne' 'Alpes-Maritimes' 'Gironde'
- department_number() str ¶
Randomly returns a french department number.
- Example:
‘59’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.department_number() ... '49' '972' '53' '06' '33'
- postcode() str ¶
Randomly returns a postcode generated from existing french department number. exemple: ‘33260’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.postcode() ... '49876' '53141' '33623' '62514' '97648'
- region() str ¶
- Example:
‘Guadeloupe’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.region() ... 'Guyane' 'Saint-Pierre-et-Miquelon' 'Auvergne' 'Haute-Normandie' 'Nouvelle-Calédonie'
- street_address() str ¶
- Example:
‘791 Crist Parks’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.street_address() ... '50, avenue de Lebon' '45, rue de Carre' '5, boulevard de Caron' '2, chemin de Georges' '6, chemin Juliette Riou'
- street_name() str ¶
- Example:
‘Crist Parks’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.street_name() ... 'avenue Augustin Poirier' 'avenue de Lebon' 'avenue Agathe Guillon' 'boulevard Joly' 'rue Olivie Gauthier'
faker.providers.automotive
¶
- class faker.providers.automotive.fr_FR.Provider(generator: Any)¶
Bases:
Provider
Implement automotive provider for
fr_FR
locale.Sources:
faker.providers.bank
¶
- class faker.providers.bank.fr_FR.Provider(generator: Any)¶
Bases:
Provider
Implement bank provider for
fr_FR
locale.- aba() str ¶
Generate an ABA routing transit number.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.aba() ... '076048766' '057593829' '052194896' '034115783' '025659384'
- bank_country() str ¶
Generate the bank provider’s ISO 3166-1 alpha-2 country code.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.bank_country() ... 'FR' 'FR' 'FR' 'FR' 'FR'
- bban() str ¶
Generate a Basic Bank Account Number (BBAN).
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.bban() ... '66048764759382421948924' '11578156593877840801609' '75351393328711587148418' '58398947196593423209471' '12201868483396947751591'
- iban() str ¶
Generate an International Bank Account Number (IBAN).
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.iban() ... 'FR9166048764759382421948924' 'FR4711578156593877840801609' 'FR4675351393328711587148418' 'FR4358398947196593423209471' 'FR8612201868483396947751591'
- swift(length: int | None = None, primary: bool = False, use_dataset: bool = False) str ¶
Generate a SWIFT code.
SWIFT codes, reading from left to right, are composed of a 4 alphabet character bank code, a 2 alphabet character country code, a 2 alphanumeric location code, and an optional 3 alphanumeric branch code. This means SWIFT codes can only have 8 or 11 characters, so the value of
length
can only beNone
or the integers8
or11
. If the value isNone
, then a value of8
or11
will randomly be assigned.Because all 8-digit SWIFT codes already refer to the primary branch or office, the
primary
argument only has an effect if the value oflength
is11
. Ifprimary
isTrue
andlength
is11
, the 11-digit SWIFT codes generated will always end in'XXX'
to denote that they belong to primary branches/offices.For extra authenticity, localized providers may opt to include SWIFT bank codes, location codes, and branch codes used in their respective locales. If
use_dataset
isTrue
, this method will generate SWIFT codes based on those locale-specific codes if included. If those codes were not included, then it will behave as ifuse_dataset
wereFalse
, and in that mode, all those codes will just be randomly generated as per the specification.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift() ... 'YNBIFR65ZT4' 'SGQEFRSIGQ8' 'JDXCFRV4' 'LNKTFRN9' 'OQIBFR9AFZA'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift(length=8) ... 'MYNBFRQ6' 'PMZJFR4W' 'SGQEFRSI' 'YDTZFRQ8' 'WZTEFRTG'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift(length=8, use_dataset=True) ... 'MYNBFRQ6' 'PMZJFR4W' 'SGQEFRSI' 'YDTZFRQ8' 'WZTEFRTG'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift(length=11) ... 'MYNBFRQ65ZT' 'PLSGFR6ISIG' 'TZIRFRJTGEV' 'PRDLFR1UN94' 'OQIBFR9AFZA'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift(length=11, primary=True) ... 'MYNBFRQ6XXX' 'PMZJFR4WXXX' 'SGQEFRSIXXX' 'YDTZFRQ8XXX' 'WZTEFRTGXXX'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift(length=11, use_dataset=True) ... 'MYNBFRQ65ZT' 'PLSGFR6ISIG' 'TZIRFRJTGEV' 'PRDLFR1UN94' 'OQIBFR9AFZA'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift(length=11, primary=True, use_dataset=True) ... 'MYNBFRQ6XXX' 'PMZJFR4WXXX' 'SGQEFRSIXXX' 'YDTZFRQ8XXX' 'WZTEFRTGXXX'
- swift11(primary: bool = False, use_dataset: bool = False) str ¶
Generate an 11-digit SWIFT code.
This method uses
swift()
under the hood with thelength
argument set to11
. Ifprimary
is set toTrue
, the SWIFT code will always end with'XXX'
. All 11-digit SWIFT codes use this convention to refer to the primary branch/office.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift11() ... 'MYNBFRQ65ZT' 'PLSGFR6ISIG' 'TZIRFRJTGEV' 'PRDLFR1UN94' 'OQIBFR9AFZA'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift11(use_dataset=True) ... 'MYNBFRQ65ZT' 'PLSGFR6ISIG' 'TZIRFRJTGEV' 'PRDLFR1UN94' 'OQIBFR9AFZA'
- swift8(use_dataset: bool = False) str ¶
Generate an 8-digit SWIFT code.
This method uses
swift()
under the hood with thelength
argument set to8
and with theprimary
argument omitted. All 8-digit SWIFT codes already refer to the primary branch/office.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift8() ... 'MYNBFRQ6' 'PMZJFR4W' 'SGQEFRSI' 'YDTZFRQ8' 'WZTEFRTG'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.swift8(use_dataset=True) ... 'MYNBFRQ6' 'PMZJFR4W' 'SGQEFRSI' 'YDTZFRQ8' 'WZTEFRTG'
faker.providers.color
¶
- class faker.providers.color.fr_FR.Provider(generator: Any)¶
Bases:
Provider
Implement color provider for
fr_FR
locale.- color(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None, color_format: str = 'hex') str ¶
Generate a color in a human-friendly way.
Under the hood, this method first creates a color represented in the HSV color model and then converts it to the desired
color_format
. The argumenthue
controls the H value according to the following rules:If the value is a number from
0
to360
, it will serve as the H value of the generated color.If the value is a tuple/list of 2 numbers from 0 to 360, the color’s H value will be randomly selected from that range.
If the value is a valid string, the color’s H value will be randomly selected from the H range corresponding to the supplied string. Valid values are
'monochrome'
,'red'
,'orange'
,'yellow'
,'green'
,'blue'
,'purple'
, and'pink'
.
The argument
luminosity
influences both S and V values and is partially affected byhue
as well. The finer details of this relationship are somewhat involved, so please refer to the source code instead if you wish to dig deeper. To keep the interface simple, this argument either can be omitted or can accept the following string values:'bright'
,'dark'
,'light'
, or'random'
.The argument
color_format
controls in which color model the color is represented. Valid values are'hsv'
,'hsl'
,'rgb'
, or'hex'
(default).- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color(hue='red') ... '#af2f33' '#e02141' '#ef6466' '#a80a14' '#ed9e95'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color(luminosity='light') ... '#79c3e0' '#89ffa1' '#96cbf7' '#aafaff' '#e3f495'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color(hue=(100, 200), color_format='rgb') ... 'rgb(26, 155, 88)' 'rgb(9, 193, 49)' 'rgb(73, 229, 154)' 'rgb(107, 249, 166)' 'rgb(76, 204, 69)'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color(hue='orange', luminosity='bright') ... '#efc332' '#edae65' '#d1861d' '#ffcc42' '#e09533'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color(hue=135, luminosity='dark', color_format='hsv') ... 'hsv(135, 96, 45)' 'hsv(135, 98, 57)' 'hsv(135, 94, 61)' 'hsv(135, 99, 47)' 'hsv(135, 94, 50)'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color(hue=(300, 20), luminosity='random', color_format='hsl') ... 'hsl(217, 94, 27)' 'hsl(40, 23, 54)' 'hsl(268, 100, 74)' 'hsl(175, 43, 31)' 'hsl(131, 47, 11)'
- color_hsl(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None) Tuple[int, int, int] ¶
Generate a HSL color tuple in a human-friendly way.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color_hsl() ... (197, 57, 32) (132, 90, 39) (207, 76, 65) (183, 88, 33) (258, 62, 73)
- color_hsv(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None) Tuple[int, int, int] ¶
Generate a HSV color tuple in a human-friendly way.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color_hsv() ... (197, 73, 51) (132, 95, 76) (207, 58, 92) (183, 94, 64) (258, 37, 90)
- color_name() str ¶
Generate a color name.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color_name() ... 'Vert forêt' 'Bleu alice' 'Ivoire' 'Orange' 'Bleu royal'
- color_rgb(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None) Tuple[int, int, int] ¶
Generate a RGB color tuple of integers in a human-friendly way.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color_rgb() ... (35, 103, 130) (9, 193, 46) (98, 173, 234) (9, 155, 163) (170, 144, 229)
- color_rgb_float(hue: str | float | int | Sequence[int] | None = None, luminosity: str | None = None) Tuple[float, float, float] ¶
Generate a RGB color tuple of floats in a human-friendly way.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.color_rgb_float() ... (0.13770000000000002, 0.4045149999999999, 0.51) (0.038000000000000034, 0.76, 0.18239999999999984) (0.3864000000000001, 0.6798800000000002, 0.92) (0.03840000000000004, 0.6099200000000001, 0.64) (0.6668999999999999, 0.5670000000000001, 0.9)
- hex_color() str ¶
Generate a color formatted as a hex triplet.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.hex_color() ... '#d82c08' '#629f70' '#c2094d' '#e3e707' '#6baa95'
- rgb_color() str ¶
Generate a color formatted as a comma-separated RGB value.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.rgb_color() ... '197,215,20' '132,248,207' '155,244,183' '111,71,144' '71,48,128'
- rgb_css_color() str ¶
Generate a color formatted as a CSS rgb() function.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.rgb_css_color() ... 'rgb(197,215,20)' 'rgb(132,248,207)' 'rgb(155,244,183)' 'rgb(111,71,144)' 'rgb(71,48,128)'
faker.providers.company
¶
- class faker.providers.company.fr_FR.Provider(generator: Any)¶
Bases:
Provider
- bs() str ¶
- Example:
‘integrate extensible convergence’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.bs() ... 'iterate integrated e-markets' 'integrate back-end mindshare' 'synthesize wireless content' 'syndicate synergistic applications' 'productize killer mindshare'
- catch_phrase() str ¶
- Example:
‘integrate extensible convergence’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.catch_phrase() ... 'Le pouvoir de rouler en toute tranquilité' "Le pouvoir d'innover naturellement" "L'avantage de changer à la pointe" "L'assurance d'évoluer de manière sûre" "L'avantage d'innover à la pointe"
- catch_phrase_attribute() str ¶
Returns a random catch phrase attribute.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.catch_phrase_attribute() ... 'en toute sécurité' 'autrement' 'de manière sûre' 'autrement' 'de manière efficace'
- catch_phrase_noun() str ¶
Returns a random catch phrase noun.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.catch_phrase_noun() ... 'le pouvoir' 'le pouvoir' 'la sécurité' "l'assurance" 'la possibilité'
- catch_phrase_verb() str ¶
Returns a random catch phrase verb.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.catch_phrase_verb() ... "d'atteindre vos buts" "d'atteindre vos buts" 'de rouler' "d'innover" 'de concrétiser vos projets'
- company() str ¶
- Example:
‘Acme Ltd’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.company() ... 'Thierry' 'Fournier' 'Gros' 'Lebon' 'Martel'
- company_suffix() str ¶
- Example:
‘Ltd’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.company_suffix() ... 'S.A.R.L.' 'S.A.R.L.' 'SA' 'SARL' 'S.A.S.'
- siren() str ¶
Generates a siren number (9 digits). Formatted as ‘### ### ###’.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.siren() ... '660 487 646' '759 382 427' '194 892 410' '157 815 655' '938 778 404'
- siret(max_sequential_digits: int = 2) str ¶
Generates a siret number (14 digits). It is in fact the result of the concatenation of a siren number (9 digits), a sequential number (4 digits) and a control number (1 digit) concatenation. If $max_sequential_digits is invalid, it is set to 2.
The siret number is formatted as ‘### ### ### #####’. :param max_sequential_digits The maximum number of digits for the sequential number (> 0 && <= 4).
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.siret() ... '604 876 474 00494' '938 242 195 00452' '892 411 570 00328' '156 593 873 00714' '840 801 609 00560'
faker.providers.currency
¶
- class faker.providers.currency.fr_FR.Provider(generator: Any)¶
Bases:
Provider
- cryptocurrency() Tuple[str, str] ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.cryptocurrency() ... ('XRP', 'Ripple') ('STC', 'SwiftCoin') ('BC', 'BlackCoin') ('NXT', 'Nxt') ('IOTA', 'IOTA')
- cryptocurrency_code() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.cryptocurrency_code() ... 'XRP' 'STC' 'BC' 'NXT' 'IOTA'
- cryptocurrency_name() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.cryptocurrency_name() ... 'Ripple' 'SwiftCoin' 'BlackCoin' 'Nxt' 'IOTA'
- currency() Tuple[str, str] ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.currency() ... ('MWK', 'Malawian kwacha') ('NZD', 'New Zealand dollar') ('BAM', 'Bosnia and Herzegovina convertible mark') ('IRR', 'Iranian rial') ('SPL', 'Seborga luigino')
- currency_code() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.currency_code() ... 'MWK' 'NZD' 'BAM' 'IRR' 'SPL'
- currency_name() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.currency_name() ... 'Malawian kwacha' 'New Zealand dollar' 'Bosnia and Herzegovina convertible mark' 'Iranian rial' 'Seborga luigino'
- currency_symbol(code: str | None = None) str ¶
- Example:
$
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.currency_symbol() ... '$' '$' 'KM' 'kr' 'L'
- pricetag()¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.pricetag() ... '7.604,87\xa0€' '975,93\xa0€' '54,21\xa0€' '89.241,15\xa0€' '91.565,93\xa0€'
faker.providers.date_time
¶
- class faker.providers.date_time.fr_FR.Provider(generator: Any)¶
Bases:
Provider
- am_pm() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.am_pm() ... 'PM' 'PM' 'PM' 'AM' 'PM'
- century() str ¶
- Example:
‘XVII’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.century() ... 'XIII' 'XIV' 'II' 'IX' 'XVII'
- date(pattern: str = '%Y-%m-%d', end_datetime: date | datetime | timedelta | str | int | None = None) str ¶
Get a date string between January 1, 1970 and now.
- Parameters:
pattern – Format of the date (year-month-day by default)
- Example:
‘2008-11-27’
- Returns:
Date
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date() ... '2016-05-02' '2011-08-04' '1993-01-28' '1984-03-17' '1998-01-20'
- date_between(start_date: date | datetime | timedelta | str | int = '-30y', end_date: date | datetime | timedelta | str | int = 'today') date ¶
Get a Date object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().
- Parameters:
start_date – Defaults to 30 years ago
end_date – Defaults to “today”
- Example:
Date(‘1999-02-02’)
- Returns:
Date
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_between() ... datetime.date(2020, 3, 15) datetime.date(2017, 8, 10) datetime.date(2007, 6, 27) datetime.date(2002, 8, 21) datetime.date(2010, 3, 17)
- date_between_dates(date_start: date | datetime | timedelta | str | int | None = None, date_end: date | datetime | timedelta | str | int | None = None) date ¶
Takes two Date objects and returns a random date between the two given dates. Accepts Date or datetime objects
- Parameters:
date_start – Date
date_end – Date
- Returns:
Date
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_between_dates() ... datetime.date(2024, 11, 14) datetime.date(2024, 11, 14) datetime.date(2024, 11, 14) datetime.date(2024, 11, 14) datetime.date(2024, 11, 14)
- date_object(end_datetime: datetime | None = None) date ¶
Get a date object between January 1, 1970 and now
- Example:
datetime.date(2016, 9, 20)
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_object() ... datetime.date(2016, 5, 2) datetime.date(2011, 8, 4) datetime.date(1993, 1, 28) datetime.date(1984, 3, 17) datetime.date(1998, 1, 20)
- date_of_birth(tzinfo: tzinfo | None = None, minimum_age: int = 0, maximum_age: int = 115) date ¶
Generate a random date of birth represented as a Date object, constrained by optional miminimum_age and maximum_age parameters.
- Parameters:
tzinfo – Defaults to None.
minimum_age – Defaults to 0.
maximum_age – Defaults to 115.
- Example:
Date(‘1979-02-02’)
- Returns:
Date
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_of_birth() ... datetime.date(2006, 10, 28) datetime.date(1996, 10, 16) datetime.date(1957, 8, 28) datetime.date(1938, 11, 27) datetime.date(1968, 3, 6)
- date_this_century(before_today: bool = True, after_today: bool = False) date ¶
Gets a Date object for the current century.
- Parameters:
before_today – include days in current century before today
after_today – include days in current century after today
- Example:
Date(‘2012-04-04’)
- Returns:
Date
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_this_century() ... datetime.date(2020, 12, 31) datetime.date(2018, 11, 7) datetime.date(2010, 6, 17) datetime.date(2006, 6, 9) datetime.date(2012, 9, 18)
- date_this_decade(before_today: bool = True, after_today: bool = False) date ¶
Gets a Date object for the decade year.
- Parameters:
before_today – include days in current decade before today
after_today – include days in current decade after today
- Example:
Date(‘2012-04-04’)
- Returns:
Date
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_this_decade() ... datetime.date(2024, 2, 11) datetime.date(2023, 9, 10) datetime.date(2022, 1, 18) datetime.date(2021, 4, 5) datetime.date(2022, 6, 28)
- date_this_month(before_today: bool = True, after_today: bool = False) date ¶
Gets a Date object for the current month.
- Parameters:
before_today – include days in current month before today
after_today – include days in current month after today
- Example:
dtdate(‘2012-04-04’)
- Returns:
dtdate
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_this_month() ... datetime.date(2024, 11, 11) datetime.date(2024, 11, 10) datetime.date(2024, 11, 6) datetime.date(2024, 11, 4) datetime.date(2024, 11, 7)
- date_this_year(before_today: bool = True, after_today: bool = False) date ¶
Gets a Date object for the current year.
- Parameters:
before_today – include days in current year before today
after_today – include days in current year after today
- Example:
Date(‘2012-04-04’)
- Returns:
Date
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_this_year() ... datetime.date(2024, 9, 25) datetime.date(2024, 8, 29) datetime.date(2024, 5, 13) datetime.date(2024, 3, 23) datetime.date(2024, 6, 11)
- date_time(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None) datetime ¶
Get a datetime object for a date between January 1, 1970 and now
- Parameters:
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘2005-08-16 20:39:21’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time() ... datetime.datetime(2016, 5, 2, 14, 45, 46, 959429) datetime.datetime(2011, 8, 4, 15, 56, 7, 378108) datetime.datetime(1993, 1, 28, 22, 51, 24, 827167) datetime.datetime(1984, 3, 17, 2, 54, 41, 948659) datetime.datetime(1998, 1, 20, 19, 3, 5, 930083)
- date_time_ad(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None, start_datetime: date | datetime | timedelta | str | int | None = None) datetime ¶
Get a datetime object for a date between January 1, 001 and now
- Parameters:
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘1265-03-22 21:15:52’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_ad() ... datetime.datetime(1710, 1, 1, 17, 20, 42, 429283) datetime.datetime(1535, 1, 2, 16, 2, 21, 261475) datetime.datetime(852, 3, 8, 1, 14, 16, 871162) datetime.datetime(525, 1, 6, 5, 1, 22, 918510) datetime.datetime(1035, 10, 4, 3, 28, 46, 922287)
- date_time_between(start_date: date | datetime | timedelta | str | int = '-30y', end_date: date | datetime | timedelta | str | int = 'now', tzinfo: tzinfo | None = None) datetime ¶
Get a datetime object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().
- Parameters:
start_date – Defaults to 30 years ago
end_date – Defaults to “now”
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘1999-02-02 11:42:52’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_between() ... datetime.datetime(2020, 3, 15, 23, 0, 14, 236214) datetime.datetime(2017, 8, 11, 12, 25, 0, 808743) datetime.datetime(2007, 6, 28, 17, 54, 41, 361449) datetime.datetime(2002, 8, 22, 11, 5, 17, 49189) datetime.datetime(2010, 3, 18, 14, 22, 13, 171082)
- date_time_between_dates(datetime_start: date | datetime | timedelta | str | int | None = None, datetime_end: date | datetime | timedelta | str | int | None = None, tzinfo: tzinfo | None = None) datetime ¶
Takes two datetime objects and returns a random datetime between the two given datetimes. Accepts datetime objects.
- Parameters:
datetime_start – datetime
datetime_end – datetime
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘1999-02-02 11:42:52’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_between_dates() ... datetime.datetime(2024, 11, 14, 15, 49, 31) datetime.datetime(2024, 11, 14, 15, 49, 31) datetime.datetime(2024, 11, 14, 15, 49, 31) datetime.datetime(2024, 11, 14, 15, 49, 31) datetime.datetime(2024, 11, 14, 15, 49, 31)
- date_time_this_century(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime ¶
Gets a datetime object for the current century.
- Parameters:
before_now – include days in current century before today
after_now – include days in current century after today
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘2012-04-04 11:02:02’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_this_century() ... datetime.datetime(2021, 1, 1, 6, 50, 15, 332809) datetime.datetime(2018, 11, 7, 18, 10, 55, 21449) datetime.datetime(2010, 6, 17, 17, 59, 21, 942635) datetime.datetime(2006, 6, 10, 4, 5, 29, 980916) datetime.datetime(2012, 9, 18, 18, 9, 38, 586186)
- date_time_this_decade(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime ¶
Gets a datetime object for the decade year.
- Parameters:
before_now – include days in current decade before today
after_now – include days in current decade after today
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘2012-04-04 11:02:02’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_this_decade() ... datetime.datetime(2024, 2, 11, 18, 47, 54, 899072) datetime.datetime(2023, 9, 10, 21, 36, 57, 696871) datetime.datetime(2022, 1, 18, 11, 22, 47, 558085) datetime.datetime(2021, 4, 5, 18, 48, 25, 200011) datetime.datetime(2022, 6, 28, 21, 28, 35, 644946)
- date_time_this_month(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime ¶
Gets a datetime object for the current month.
- Parameters:
before_now – include days in current month before today
after_now – include days in current month after today
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘2012-04-04 11:02:02’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_this_month() ... datetime.datetime(2024, 11, 12, 12, 49, 22, 180936) datetime.datetime(2024, 11, 11, 8, 28, 35, 805672) datetime.datetime(2024, 11, 6, 17, 52, 26, 383121) datetime.datetime(2024, 11, 4, 12, 52, 46, 40110) datetime.datetime(2024, 11, 7, 23, 36, 31, 599192)
- date_time_this_year(before_now: bool = True, after_now: bool = False, tzinfo: tzinfo | None = None) datetime ¶
Gets a datetime object for the current year.
- Parameters:
before_now – include days in current year before today
after_now – include days in current year after today
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘2012-04-04 11:02:02’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.date_time_this_year() ... datetime.datetime(2024, 9, 26, 1, 59, 26, 812324) datetime.datetime(2024, 8, 29, 12, 42, 10, 231955) datetime.datetime(2024, 5, 14, 0, 27, 28, 681175) datetime.datetime(2024, 3, 23, 12, 9, 0, 243830) datetime.datetime(2024, 6, 11, 22, 8, 23, 56698)
- day_of_month() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.day_of_month() ... '02' '04' '28' '17' '20'
- day_of_week() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.day_of_week() ... 'lundi' 'jeudi' 'jeudi' 'samedi' 'mardi'
- future_date(end_date: date | datetime | timedelta | str | int = '+30d', tzinfo: tzinfo | None = None) date ¶
Get a Date object based on a random date between 1 day from now and a given date. Accepts date strings that can be recognized by strtotime().
- Parameters:
end_date – Defaults to “+30d”
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
dtdate(‘2030-01-01’)
- Returns:
dtdate
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.future_date() ... datetime.date(2024, 12, 9) datetime.date(2024, 12, 6) datetime.date(2024, 11, 27) datetime.date(2024, 11, 22) datetime.date(2024, 11, 29)
- future_datetime(end_date: date | datetime | timedelta | str | int = '+30d', tzinfo: tzinfo | None = None) datetime ¶
Get a datetime object based on a random date between 1 second form now and a given date. Accepts date strings that can be recognized by strtotime().
- Parameters:
end_date – Defaults to “+30d”
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘1999-02-02 11:42:52’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.future_datetime() ... datetime.datetime(2024, 12, 9, 23, 48, 32, 594731) datetime.datetime(2024, 12, 7, 9, 33, 9, 54467) datetime.datetime(2024, 11, 27, 6, 38, 13, 116942) datetime.datetime(2024, 11, 22, 10, 14, 43, 957843) datetime.datetime(2024, 11, 29, 23, 56, 35, 566513)
- iso8601(tzinfo: tzinfo | None = None, end_datetime: date | datetime | timedelta | str | int | None = None, sep: str = 'T', timespec: str = 'auto') str ¶
Get a timestamp in ISO 8601 format (or one of its profiles).
- Parameters:
tzinfo – timezone, instance of datetime.tzinfo subclass
sep – separator between date and time, defaults to ‘T’
timespec – format specifier for the time part, defaults to ‘auto’ - see datetime.isoformat() documentation
- Example:
‘2003-10-21T16:05:52+0000’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.iso8601() ... '2016-05-02T14:45:46.959429' '2011-08-04T15:56:07.378108' '1993-01-28T22:51:24.827167' '1984-03-17T02:54:41.948659' '1998-01-20T19:03:05.930083'
- month() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.month() ... '05' '08' '01' '03' '01'
- month_name() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.month_name() ... 'Mai' 'Août' 'Janvier' 'Mars' 'Janvier'
- past_date(start_date: date | datetime | timedelta | str | int = '-30d', tzinfo: tzinfo | None = None) date ¶
Get a Date object based on a random date between a given date and 1 day ago. Accepts date strings that can be recognized by strtotime().
- Parameters:
start_date – Defaults to “-30d”
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
dtdate(‘1999-02-02’)
- Returns:
dtdate
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.past_date() ... datetime.date(2024, 11, 8) datetime.date(2024, 11, 5) datetime.date(2024, 10, 27) datetime.date(2024, 10, 22) datetime.date(2024, 10, 29)
- past_datetime(start_date: date | datetime | timedelta | str | int = '-30d', tzinfo: tzinfo | None = None) datetime ¶
Get a datetime object based on a random date between a given date and 1 second ago. Accepts date strings that can be recognized by strtotime().
- Parameters:
start_date – Defaults to “-30d”
tzinfo – timezone, instance of datetime.tzinfo subclass
- Example:
datetime(‘1999-02-02 11:42:52’)
- Returns:
datetime
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.past_datetime() ... datetime.datetime(2024, 11, 9, 23, 48, 31, 594731) datetime.datetime(2024, 11, 7, 9, 33, 8, 54467) datetime.datetime(2024, 10, 28, 6, 38, 12, 116942) datetime.datetime(2024, 10, 23, 10, 14, 42, 957843) datetime.datetime(2024, 10, 30, 23, 56, 34, 566513)
- pytimezone(*args: Any, **kwargs: Any) tzinfo | None ¶
Generate a random timezone (see faker.timezone for any args) and return as a python object usable as a tzinfo to datetime or other fakers.
- Example:
faker.pytimezone()
- Returns:
dateutil.tz.tz.tzfile
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.pytimezone() ... tzfile('/usr/share/zoneinfo/Indian/Maldives') tzfile('/usr/share/zoneinfo/America/Barbados') tzfile('/usr/share/zoneinfo/Europe/Stockholm') tzfile('/usr/share/zoneinfo/Africa/Windhoek') tzfile('/usr/share/zoneinfo/Asia/Qatar')
- time(pattern: str = '%H:%M:%S', end_datetime: date | datetime | timedelta | str | int | None = None) str ¶
Get a time string (24h format by default)
- Parameters:
pattern – format
- Example:
‘15:02:34’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.time() ... '14:45:46' '15:56:07' '22:51:24' '02:54:41' '19:03:05'
- time_delta(end_datetime: date | datetime | timedelta | str | int | None = None) timedelta ¶
Get a timedelta object
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.time_delta() ... datetime.timedelta(0) datetime.timedelta(0) datetime.timedelta(0) datetime.timedelta(0) datetime.timedelta(0)
- time_object(end_datetime: date | datetime | timedelta | str | int | None = None) time ¶
Get a time object
- Example:
datetime.time(15, 56, 56, 772876)
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.time_object() ... datetime.time(14, 45, 46, 959429) datetime.time(15, 56, 7, 378108) datetime.time(22, 51, 24, 827167) datetime.time(2, 54, 41, 948659) datetime.time(19, 3, 5, 930083)
- time_series(start_date: date | datetime | timedelta | str | int = '-30d', end_date: date | datetime | timedelta | str | int = 'now', precision: float | None = None, distrib: Callable[[datetime], float] | None = None, tzinfo: tzinfo | None = None) Iterator[Tuple[datetime, Any]] ¶
Returns a generator yielding tuples of
(<datetime>, <value>)
.The data points will start at
start_date
, and be at every time interval specified byprecision
.distrib
is a callable that accepts<datetime>
and returns<value>
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.time_series() ... <generator object Provider.time_series at 0x7f1b3111c510> <generator object Provider.time_series at 0x7f1b3111c510> <generator object Provider.time_series at 0x7f1b3111c510> <generator object Provider.time_series at 0x7f1b3111c510> <generator object Provider.time_series at 0x7f1b3111c510>
- timezone() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.timezone() ... 'Indian/Maldives' 'America/Barbados' 'Europe/Stockholm' 'Africa/Windhoek' 'Asia/Qatar'
- unix_time(end_datetime: date | datetime | timedelta | str | int | None = None, start_datetime: date | datetime | timedelta | str | int | None = None) float ¶
Get a timestamp between January 1, 1970 and now, unless passed explicit start_datetime or end_datetime values.
On Windows, the decimal part is always 0.
- Example:
1061306726.6
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.unix_time() ... 1462200346.9594288 1312473367.3781083 728261484.8271669 448340081.9486594 885322985.9300828
faker.providers.internet
¶
- class faker.providers.internet.fr_FR.Provider(generator: Any)¶
Bases:
Provider
- ascii_company_email() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.ascii_company_email() ... 'athierry@poirier.fr' 'ebailly@guillon.net' 'rolandjoly@maurice.com' 'eugene15@vaillant.com' 'bernadette59@courtois.org'
- ascii_email() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.ascii_email() ... 'qfournier@wanadoo.fr' 'ebailly@live.com' 'rolandjoly@maurice.com' 'chauveaudavid@dbmail.com' 'monnierbernadette@dbmail.com'
- ascii_free_email() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.ascii_free_email() ... 'athierry@gmail.com' 'danielle76@club-internet.fr' 'lpelletier@sfr.fr' 'rolandjoly@yahoo.fr' 'elisabeth92@club-internet.fr'
- ascii_safe_email() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.ascii_safe_email() ... 'athierry@example.org' 'danielle76@example.com' 'lpelletier@example.org' 'rolandjoly@example.org' 'elisabeth92@example.com'
- company_email() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.company_email() ... 'athierry@poirier.fr' 'ebailly@guillon.net' 'rolandjoly@maurice.com' 'eugene15@vaillant.com' 'bernadette59@courtois.org'
- dga(year: int | None = None, month: int | None = None, day: int | None = None, tld: str | None = None, length: int | None = None) str ¶
Generates a domain name by given date https://en.wikipedia.org/wiki/Domain_generation_algorithm
- Return type:
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.dga() ... 'hxqvaffcmfsccynscisxeajjagjahtnfcmfsccynscisxeajjagjahtnfcmfscc.org' 'meydkrgdcvulautulqvjofrrnbjkfmvrewtpfttqcjafdhxckmyfamohcpnldug.org' 'iiulfpgbvqcdaehnqkbxmaqgkykorlxnwy.net' 'cpyhexmtvewxpwiiaxtgdfajuhbsyaaykvgkgreki.com' 'uqniukqjckmjabijnuqho.com'
- 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() ... 'thierry.fr' 'poirier.fr' 'bailly.fr' 'guillon.net' 'carre.org'
- domain_word() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.domain_word() ... 'thierry' 'fournier' 'gros' 'lebon' 'martel'
- email(safe: bool = True, domain: str | None = None) str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.email() ... 'athierry@example.org' 'danielle76@example.com' 'lpelletier@example.org' 'rolandjoly@example.org' 'elisabeth92@example.com'
- free_email() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.free_email() ... 'athierry@gmail.com' 'danielle76@club-internet.fr' 'lpelletier@sfr.fr' 'rolandjoly@yahoo.fr' 'elisabeth92@club-internet.fr'
- free_email_domain() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.free_email_domain() ... 'ifrance.com' 'noos.fr' 'gmail.com' 'bouygtel.fr' 'wanadoo.fr'
- 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.poirier.fr' 'laptop-47.guillon.net' 'lt-24.faivre.org' 'lt-92.perrin.com' 'web-57.monnier.fr'
- http_method() str ¶
Returns random HTTP method https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
- Return type:
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.http_method() ... 'OPTIONS' 'OPTIONS' 'GET' 'DELETE' 'PATCH'
- http_status_code(include_unassigned: bool = True) int ¶
Returns random HTTP status code https://www.rfc-editor.org/rfc/rfc9110#name-status-codes :param include_unassigned: Whether to include status codes which have
not yet been assigned or are unused
- Returns:
a random three digit status code
- Return type:
- Example:
404
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.http_status_code() ... 532 297 488 555 315
- iana_id() str ¶
Returns IANA Registrar ID https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml
- Return type:
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.iana_id() ... '6463344' '7056021' '679216' '4343903' '8577767'
- image_url(width: int | None = None, height: int | None = None, placeholder_url: str | None = None) str ¶
Returns URL to placeholder image Example: http://placehold.it/640x480
- Parameters:
width – Optional image width
height – Optional image height
placeholder_url – Optional template string of image URLs from custom placeholder service. String must contain
{width}
and{height}
placeholders, eg:https:/example.com/{width}/{height}
.
- Return type:
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.image_url() ... 'https://picsum.photos/788/861' 'https://dummyimage.com/530x995' 'https://dummyimage.com/621x976' 'https://dummyimage.com/447x285' 'https://placekitten.com/286/194'
- ipv4(network: bool = False, address_class: str | None = None, private: str | None = 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: str | None = 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: str | None = 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(multicast: bool = False) str ¶
Returns a random MAC address.
- Parameters:
multicast – Multicast address
- Returns:
MAC Address
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.mac_address() ... '66:c5:d7:14:84:f8' '48:9b:f4:b7:6f:47' '18:47:30:80:4b:9e' '6e:25:a9:f1:33:b5' '0e:a1:68:f4:e2:85'
- nic_handle(suffix: str = 'FAKE') str ¶
Returns NIC Handle ID https://www.apnic.net/manage-ip/using-whois/guide/person/
- Return type:
- 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
>>> 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:
- 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:
- 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() ... 'athierry@example.org' 'danielle76@example.com' 'lpelletier@example.org' 'rolandjoly@example.org' 'elisabeth92@example.com'
- slug(value: str | None = None) str ¶
Django algorithm
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.slug() ... 'three-image-son' 'kitchen-amount' 'much-mention' 'why-step-themselves' 'me-help-past-wait'
- tld() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.tld() ... 'fr' 'fr' 'com' 'org' 'fr'
- uri(schemes: List[str] | None = None, deep: int | None = None) str ¶
- Parameters:
schemes – a list of strings to use as schemes, one will chosen randomly. If None, it will generate http and https uris. Passing an empty list will result in schemeless uri generation like “://domain.com/index.html”.
deep – an integer specifying how many path components the URI should have..
- Returns:
a random url string.
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.uri() ... 'https://bailly.fr/categorylogin.jsp' 'https://www.ruiz.com/main/main/mainprivacy.htm' 'https://pichon.org/main/tag/tagsmain.asp' 'http://www.raymond.fr/exploreauthor.php' 'http://robin.com/list/wp-content/categoriesmain.html'
- 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: int | None = None) str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.uri_path() ... 'posts/tag' 'explore/tag' 'explore/category' 'blog' 'category'
- url(schemes: List[str] | None = 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://poirier.fr/' 'https://pelletier.net/' 'http://faivre.org/' 'http://chauveau.fr/' 'https://www.gay.fr/'
faker.providers.job
¶
- class faker.providers.job.fr_FR.Provider(generator: Any)¶
Bases:
Provider
- job() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.job() ... 'ingénieur de recherche clinique et épidémiologique' 'énergéticien' 'ingénieur méthodes mécaniques' 'ambulancier' 'dessinateur-projeteur'
faker.providers.lorem
¶
- class faker.providers.lorem.fr_FR.Provider(generator: Any)¶
Bases:
Provider
Implement lorem provider for
fr_FR
locale.Word list is drawn from the French Education Ministry’s website Eduscol. The “lexical frequency list” can be found in the source(s) below.
Sources:
- get_words_list(part_of_speech: str | None = None, ext_word_list: Sequence[str] | None = None) List[str] ¶
Get list of words.
ext_word_list
is a parameter that allows the user to provide a list of words to be used instead of the built-in word list. Ifext_word_list
is provided, then the value ofpart_of_speech
is ignored.part_of_speech
is a parameter that defines to what part of speech the returned word belongs. Ifext_word_list
is notNone
, thenpart_of_speech
is ignored. If the value ofpart_of_speech
does not correspond to an existent part of speech according to the set locale, then an exception is raised.Warning
Depending on the length of a locale provider’s built-in word list or on the length of
ext_word_list
if provided, a largenb
can exhaust said lists ifunique
isTrue
, raising an exception.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.get_words_list(part_of_speech="abc", ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... ['abc', 'def', 'ghi', 'jkl'] ['abc', 'def', 'ghi', 'jkl'] ['abc', 'def', 'ghi', 'jkl'] ['abc', 'def', 'ghi', 'jkl'] ['abc', 'def', 'ghi', 'jkl']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.get_words_list(ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... ['abc', 'def', 'ghi', 'jkl'] ['abc', 'def', 'ghi', 'jkl'] ['abc', 'def', 'ghi', 'jkl'] ['abc', 'def', 'ghi', 'jkl'] ['abc', 'def', 'ghi', 'jkl']
- paragraph(nb_sentences: int = 3, variable_nb_sentences: bool = True, ext_word_list: Sequence[str] | None = None) str ¶
Generate a paragraph.
The
nb_sentences
argument controls how many sentences the paragraph will contain, and settingvariable_nb_sentences
toFalse
will generate the exact amount, while setting it toTrue
(default) will generate a random amount (+/-40%, minimum of 1) usingrandomize_nb_elements()
.Under the hood,
sentences()
is used to generate the sentences, so the argumentext_word_list
works in the same way here as it would in that method.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.paragraph(nb_sentences=5) ... 'Appartenir verre jour terrible sauter verser. Nécessaire te ligne dresser rapport ouvrage. Voile marchand près obliger chaud. Prouver surtout police interroger. Événement engager passé courir.' 'Heure magnifique attirer terrible terrain bête seigneur. Abandonner le sol dernier entrer sombre continuer monde. Revenir chaque meilleur beauté votre. Vue jusque élever échapper céder escalier toile. Véritable obtenir noir histoire nouveau. Enlever depuis connaissance sable anglais visible.' 'Autant poésie certain cher apparaître avis précieux. Police secours mais magnifique demain cruel poète. Nation huit petit voyager terre ressembler. Entrée camarade noir espoir.' 'Afin De doigt près faute commencer. Rose bon chat pouvoir après mourir. Observer autrement ceci consulter sauter carte beauté. Année aider vendre conscience.' 'Creuser réussir traiter ailleurs grâce bon difficile. Autre élever haine attendre instant. Bon voir couler exister public secret terrible comme.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.paragraph(nb_sentences=5, variable_nb_sentences=False) ... 'Rayon geste dieu longtemps françois répéter. Verser existence suffire dame chance. Rapport ouvrage dessiner témoin. Tâche encore prouver surtout police interroger bon habitant. Passé courir métier heure magnifique attirer terrible terrain.' "Problème fort saison plaindre. Or sans espace. Prendre attitude terre d'autres revenir chaque. Honte avis ensemble livrer toute brusquement mériter. Menacer rompre matin véritable." 'Menacer durant beauté retour enlever depuis connaissance sable. Or personne jambe. Poésie certain cher apparaître. Surprendre toit mauvais fois. Dos rocher serrer supérieur nombre tu nation.' 'Larme passer précipiter visite exiger entrée camarade. Parler sentier dernier public car dans rester escalier. Bon chat pouvoir après. Particulier traiter observer autrement ceci consulter sauter. Foi fatigue visage année.' 'Corde vide printemps. Creuser réussir traiter ailleurs grâce bon difficile. Autre élever haine attendre instant. Bon voir couler exister public secret terrible comme. Vers assister plus sentiment etc.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.paragraph(nb_sentences=5, ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... 'Abc jkl def jkl jkl jkl. Ghi jkl ghi def jkl ghi. Jkl ghi ghi ghi abc. Ghi jkl ghi def. Def def ghi abc.' 'Def ghi abc jkl jkl abc jkl. Abc def jkl abc def jkl abc ghi. Jkl abc ghi abc jkl. Jkl def def def abc def jkl. Jkl ghi ghi def ghi. Def abc abc jkl abc jkl.' 'Abc ghi abc abc abc abc ghi. Ghi jkl ghi ghi abc abc ghi. Ghi def ghi jkl jkl jkl. Def abc ghi def.' 'Abc def ghi def abc. Jkl abc abc ghi abc ghi. Ghi abc abc abc jkl abc abc. Abc abc jkl abc.' 'Abc jkl jkl abc def abc def. Abc def def abc def. Abc jkl abc def ghi jkl jkl abc.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.paragraph(nb_sentences=5, variable_nb_sentences=False, ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... 'Jkl def def ghi def jkl. Jkl def jkl abc abc. Jkl ghi def jkl. Jkl def ghi jkl ghi def abc def. Ghi abc ghi def ghi abc jkl jkl.' 'Ghi def jkl ghi. Ghi jkl def. Ghi abc jkl abc jkl abc. Def abc def ghi jkl abc ghi. Ghi jkl ghi jkl.' 'Ghi def abc jkl def abc abc jkl. Ghi ghi def. Ghi abc abc abc. Jkl jkl ghi def. Def jkl jkl jkl ghi jkl ghi.' 'Def ghi ghi jkl def def abc. Ghi jkl abc ghi abc abc jkl def. Abc abc ghi abc. Ghi jkl ghi abc abc abc jkl. Def def jkl abc.' 'Abc jkl ghi. Abc jkl jkl abc def abc def. Abc def def abc def. Abc jkl abc def ghi jkl jkl abc. Jkl abc ghi jkl def.'
- paragraphs(nb: int = 3, ext_word_list: Sequence[str] | None = None) List[str] ¶
Generate a list of paragraphs.
This method uses
paragraph()
under the hood to generate paragraphs, and thenb
argument controls exactly how many sentences the list will contain. Theext_word_list
argument works in exactly the same way as well.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.paragraphs(nb=5) ... ['Appartenir verre jour terrible sauter verser. Nécessaire te ligne dresser rapport ouvrage. Voile marchand près obliger chaud.', 'Surtout police interroger bon. Engager passé courir métier heure magnifique.', 'Terrain bête seigneur presser réponse paraître or. Dernier entrer sombre continuer monde demi.', 'Honte avis ensemble livrer toute brusquement mériter. Menacer rompre matin véritable.', 'Noir histoire nouveau fin moyen écarter contenir. Anglais visible difficile autant. Sortir toit semaine surprendre. Police secours mais magnifique demain cruel poète.'] ['Dos larme passer précipiter visite exiger entrée camarade. Parler sentier dernier public car dans rester escalier. Bon chat pouvoir après.', 'Observer autrement ceci consulter sauter carte beauté. Année aider vendre conscience. Jeter propos attendre poète.', 'Pain second auteur autre élever haine. Lieu apparence bon voir. Difficile tandis que intérêt tache montrer.', 'Résistance cinq classe malheur. Nouveau hésiter complet intérieur.', 'Songer terreur peine flamme personne chiffre posséder. Que esprit après douze dépasser un étroit. Plein nombre suite si cerveau.'] ['Quoi santé avoir nourrir précéder clair. Parvenir feu sonner monsieur garde.', 'Genou peur arbre hiver dieu ciel malade. Te occuper à apparaître entretenir secours armer. Construire yeux partager bande promener voilà.', 'Engager croiser principe abri saint maladie. Contenter oh coucher éloigner. Bois si forêt avoir.', 'Réunir campagne devenir perdre rouge pauvre camarade. Doute agir appartenir point.', 'Tromper transformer témoin appeler race préférer. Prêter tache passé fauteuil marquer couvrir noir. Champ doigt essuyer.'] ['Est pain appel coin. Eaux force mener éclater jaune départ arme condamner. Propre éloigner sec également brûler minute jeune.', "Ceci campagne lettre apercevoir espérer porte. Théâtre parcourir fer vieux. Aujourd'Hui barbe raconter attendre.", 'Fond lutte horizon juger.', 'Goût fait voisin digne remplir. Contraire camarade sac seulement alors maître. Caresser former coûter appeler trou. Papier bout importance expression sang.', 'Vite chemin frapper poids soudain lendemain terre entourer. Vue partie songer meilleur tout accuser près.'] ['Animal chemin deviner répondre semaine nécessaire. Auprès barbe soleil apparence debout appartenir affirmer. Époque clair chemise personnage vêtement lire table.', 'Mouvement poésie révolution. Voix quinze tantôt court mari nuit saluer jeunesse. Offrir déjà soin ah sous quatre.', 'Montrer escalier le dire salle relever fils. Attirer passer centre dur sauter aspect.', 'Général large société principe plein cheveu voilà.', 'Or finir arbre. Rencontre ah nuage cesse entre précipiter peine. Fille remplacer juste soulever ombre.']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.paragraphs(nb=5, ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... ['Abc jkl def jkl jkl jkl. Ghi jkl ghi def jkl ghi. Jkl ghi ghi ghi abc.', 'Jkl ghi def abc. Def ghi abc ghi def ghi.', 'Jkl abc jkl ghi jkl ghi ghi. Abc def jkl abc ghi abc.', 'Def abc def ghi jkl abc ghi. Ghi jkl ghi jkl.', 'Ghi def ghi def ghi def abc. Abc jkl def abc. Jkl jkl jkl jkl. Ghi jkl ghi ghi abc abc ghi.'] ['Def def ghi ghi jkl def def abc. Ghi jkl abc ghi abc abc jkl def. Abc abc ghi abc.', 'Ghi abc abc abc jkl abc abc. Abc abc jkl abc. Def ghi abc ghi.', 'Ghi jkl abc abc def def. Ghi abc abc jkl. Def jkl def jkl ghi.', 'Jkl abc abc ghi. Ghi def abc def.', 'Jkl jkl ghi def ghi abc ghi. Ghi def abc def abc jkl def. Ghi ghi jkl jkl abc.'] ['Ghi jkl abc ghi ghi abc. Ghi def jkl ghi def.', 'Def ghi abc def def abc ghi. Jkl ghi abc abc def jkl abc. Abc jkl ghi abc ghi jkl.', 'Def abc ghi abc jkl ghi. Abc ghi abc def. Abc jkl def abc.', 'Jkl abc def ghi jkl ghi abc. Def abc abc ghi.', 'Jkl jkl jkl abc ghi ghi. Ghi jkl ghi def ghi abc ghi. Abc def def.'] ['Def ghi abc abc. Def def ghi def def abc abc abc. Ghi def jkl def abc ghi def.', 'Abc abc def abc def ghi. Jkl ghi def jkl. Abc abc ghi abc.', 'Def ghi def def.', 'Def def jkl def jkl. Abc abc jkl jkl abc ghi. Abc def abc abc jkl. Ghi abc def def jkl.', 'Jkl abc def ghi jkl def jkl def. Jkl ghi jkl ghi jkl abc ghi.'] ['Abc abc def jkl jkl ghi. Abc abc jkl abc abc abc abc. Def abc abc ghi jkl ghi jkl.', 'Ghi ghi jkl. Jkl ghi jkl abc ghi ghi jkl def. Ghi abc jkl abc jkl ghi.', 'Ghi def def def jkl jkl def. Abc ghi abc def jkl abc.', 'Def def jkl ghi ghi abc jkl.', 'Ghi def abc. Jkl abc ghi abc def ghi ghi. Def jkl def jkl ghi.']
- sentence(nb_words: int = 6, variable_nb_words: bool = True, ext_word_list: Sequence[str] | None = None) str ¶
Generate a sentence.
The
nb_words
argument controls how many words the sentence will contain, and settingvariable_nb_words
toFalse
will generate the exact amount, while setting it toTrue
(default) will generate a random amount (+/-40%, minimum of 1) usingrandomize_nb_elements()
.Under the hood,
words()
is used to generate the words, so the argumentext_word_list
works in the same way here as it would in that method.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.sentence(nb_words=10) ... 'Rayon geste dieu longtemps françois répéter embrasser jambe nécessaire te.' 'Chance changement bien retrouver voile marchand près obliger chaud blond autrefois servir.' 'Interroger bon habitant oncle tendre vers jardin soir difficile revoir.' 'Terrain bête seigneur presser réponse paraître or sans espace prouver prendre attitude terre.' 'Demi verser revenir honte avis ensemble livrer toute.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.sentence(nb_words=10, variable_nb_words=False) ... 'Sens rayon geste dieu longtemps françois répéter embrasser jambe nécessaire.' 'Te ligne dresser rapport ouvrage dessiner témoin visite robe tâche.' 'Encore prouver surtout police interroger bon habitant oncle tendre vers.' 'Jardin soir difficile revoir mensonge adresser problème fort saison plaindre.' 'Abandonner le sol dernier entrer sombre continuer monde demi verser.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.sentence(nb_words=10, ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... 'Jkl def def ghi def jkl def def ghi jkl.' 'Abc abc abc jkl jkl ghi ghi ghi abc abc abc jkl.' 'Def abc def ghi jkl jkl def jkl def jkl.' 'Jkl abc jkl ghi jkl ghi ghi jkl def ghi ghi abc jkl.' 'Abc jkl jkl def abc def ghi jkl.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.sentence(nb_words=10, variable_nb_words=True, ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... 'Jkl def def ghi def jkl def def ghi jkl.' 'Abc abc abc jkl jkl ghi ghi ghi abc abc abc jkl.' 'Def abc def ghi jkl jkl def jkl def jkl.' 'Jkl abc jkl ghi jkl ghi ghi jkl def ghi ghi abc jkl.' 'Abc jkl jkl def abc def ghi jkl.'
- sentences(nb: int = 3, ext_word_list: Sequence[str] | None = None) List[str] ¶
Generate a list of sentences.
This method uses
sentence()
under the hood to generate sentences, and thenb
argument controls exactly how many sentences the list will contain. Theext_word_list
argument works in exactly the same way as well.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.sentences() ... ['Rayon geste dieu longtemps françois répéter.', 'Verser existence suffire dame chance.', 'Rapport ouvrage dessiner témoin.'] ['Tâche encore prouver surtout police interroger bon habitant.', 'Passé courir métier heure magnifique attirer terrible terrain.', 'Problème fort saison plaindre.'] ['Or sans espace.', "Prendre attitude terre d'autres revenir chaque.", 'Honte avis ensemble livrer toute brusquement mériter.'] ['Menacer rompre matin véritable.', 'Menacer durant beauté retour enlever depuis connaissance sable.', 'Or personne jambe.'] ['Poésie certain cher apparaître.', 'Surprendre toit mauvais fois.', 'Dos rocher serrer supérieur nombre tu nation.']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.sentences(nb=5) ... ['Rayon geste dieu longtemps françois répéter.', 'Verser existence suffire dame chance.', 'Rapport ouvrage dessiner témoin.', 'Tâche encore prouver surtout police interroger bon habitant.', 'Passé courir métier heure magnifique attirer terrible terrain.'] ['Problème fort saison plaindre.', 'Or sans espace.', "Prendre attitude terre d'autres revenir chaque.", 'Honte avis ensemble livrer toute brusquement mériter.', 'Menacer rompre matin véritable.'] ['Menacer durant beauté retour enlever depuis connaissance sable.', 'Or personne jambe.', 'Poésie certain cher apparaître.', 'Surprendre toit mauvais fois.', 'Dos rocher serrer supérieur nombre tu nation.'] ['Larme passer précipiter visite exiger entrée camarade.', 'Parler sentier dernier public car dans rester escalier.', 'Bon chat pouvoir après.', 'Particulier traiter observer autrement ceci consulter sauter.', 'Foi fatigue visage année.'] ['Corde vide printemps.', 'Creuser réussir traiter ailleurs grâce bon difficile.', 'Autre élever haine attendre instant.', 'Bon voir couler exister public secret terrible comme.', 'Vers assister plus sentiment etc.']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.sentences(nb=5, ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... ['Jkl def def ghi def jkl.', 'Jkl def jkl abc abc.', 'Jkl ghi def jkl.', 'Jkl def ghi jkl ghi def abc def.', 'Ghi abc ghi def ghi abc jkl jkl.'] ['Ghi def jkl ghi.', 'Ghi jkl def.', 'Ghi abc jkl abc jkl abc.', 'Def abc def ghi jkl abc ghi.', 'Ghi jkl ghi jkl.'] ['Ghi def abc jkl def abc abc jkl.', 'Ghi ghi def.', 'Ghi abc abc abc.', 'Jkl jkl ghi def.', 'Def jkl jkl jkl ghi jkl ghi.'] ['Def ghi ghi jkl def def abc.', 'Ghi jkl abc ghi abc abc jkl def.', 'Abc abc ghi abc.', 'Ghi jkl ghi abc abc abc jkl.', 'Def def jkl abc.'] ['Abc jkl ghi.', 'Abc jkl jkl abc def abc def.', 'Abc def def abc def.', 'Abc jkl abc def ghi jkl jkl abc.', 'Jkl abc ghi jkl def.']
- text(max_nb_chars: int = 200, ext_word_list: Sequence[str] | None = None) str ¶
Generate a text string.
The
max_nb_chars
argument controls the approximate number of characters the text string will have, and depending on its value, this method may use eitherwords()
,sentences()
, orparagraphs()
for text generation. Theext_word_list
argument works in exactly the same way it would in any of those methods.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.text(max_nb_chars=20) ... 'Matière nom asseoir.' 'Prince point monde.' 'Plaindre libre.' 'Empire présent.' 'Force côte cesse.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.text(max_nb_chars=80) ... 'Rayon geste dieu longtemps françois répéter.' 'Rapport ouvrage dessiner témoin.' 'Passé courir métier heure magnifique attirer terrible terrain.' "Or sans espace. Prendre attitude terre d'autres revenir chaque." 'Menacer rompre matin véritable.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.text(max_nb_chars=160) ... 'Appartenir verre jour terrible sauter verser. Nécessaire te ligne dresser rapport ouvrage. Voile marchand près obliger chaud.' 'Terrain bête seigneur presser réponse paraître or. Dernier entrer sombre continuer monde demi.' 'Dos larme passer précipiter visite exiger entrée camarade. Parler sentier dernier public car dans rester escalier. Bon chat pouvoir après.' 'Pain second auteur autre élever haine. Lieu apparence bon voir. Difficile tandis que intérêt tache montrer.' 'Songer terreur peine flamme personne chiffre posséder. Que esprit après douze dépasser un étroit. Plein nombre suite si cerveau.'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.text(ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... 'Abc jkl def jkl jkl jkl. Ghi jkl ghi def jkl ghi. Jkl ghi ghi ghi abc.\nJkl ghi def abc. Def ghi abc ghi def ghi.\nJkl abc jkl ghi jkl ghi ghi. Abc def jkl abc ghi abc.' 'Ghi def ghi def ghi def abc. Abc jkl def abc. Jkl jkl jkl jkl. Ghi jkl ghi ghi abc abc ghi.\nDef def ghi ghi jkl def def abc. Ghi jkl abc ghi abc abc jkl def. Abc abc ghi abc.' 'Ghi jkl abc abc def def. Ghi abc abc jkl. Def jkl def jkl ghi.\nJkl abc abc ghi. Ghi def abc def.\nJkl jkl ghi def ghi abc ghi. Ghi def abc def abc jkl def. Ghi ghi jkl jkl abc.' 'Def ghi abc def def abc ghi. Jkl ghi abc abc def jkl abc. Abc jkl ghi abc ghi jkl.\nDef abc ghi abc jkl ghi. Abc ghi abc def. Abc jkl def abc.\nJkl abc def ghi jkl ghi abc. Def abc abc ghi.' 'Def ghi abc abc. Def def ghi def def abc abc abc. Ghi def jkl def abc ghi def.\nAbc abc def abc def ghi. Jkl ghi def jkl. Abc abc ghi abc.\nDef ghi def def.'
- texts(nb_texts: int = 3, max_nb_chars: int = 200, ext_word_list: Sequence[str] | None = None) List[str] ¶
Generate a list of text strings.
The
nb_texts
argument controls how many text strings the list will contain, and this method usestext()
under the hood for text generation, so the two remaining arguments,max_nb_chars
andext_word_list
will work in exactly the same way as well.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.texts(nb_texts=5) ... ['Appartenir verre jour terrible sauter verser. Nécessaire te ligne dresser rapport ouvrage. Voile marchand près obliger chaud.', 'Terrain bête seigneur presser réponse paraître or. Dernier entrer sombre continuer monde demi.\nHonte avis ensemble livrer toute brusquement mériter. Menacer rompre matin véritable.', 'Dos larme passer précipiter visite exiger entrée camarade. Parler sentier dernier public car dans rester escalier. Bon chat pouvoir après.', 'Pain second auteur autre élever haine. Lieu apparence bon voir. Difficile tandis que intérêt tache montrer.\nRésistance cinq classe malheur. Nouveau hésiter complet intérieur.', 'Quoi santé avoir nourrir précéder clair. Parvenir feu sonner monsieur garde.'] ['Engager croiser principe abri saint maladie. Contenter oh coucher éloigner. Bois si forêt avoir.\nRéunir campagne devenir perdre rouge pauvre camarade. Doute agir appartenir point.', 'Est pain appel coin. Eaux force mener éclater jaune départ arme condamner. Propre éloigner sec également brûler minute jeune.', 'Fond lutte horizon juger.\nGoût fait voisin digne remplir. Contraire camarade sac seulement alors maître. Caresser former coûter appeler trou. Papier bout importance expression sang.', 'Animal chemin deviner répondre semaine nécessaire. Auprès barbe soleil apparence debout appartenir affirmer. Époque clair chemise personnage vêtement lire table.', 'Montrer escalier le dire salle relever fils. Attirer passer centre dur sauter aspect.\nGénéral large société principe plein cheveu voilà.'] ['Part essuyer ceci pointe palais réserver cent tendre. Terre sommet point robe lutte. Apercevoir folie faute contenter exemple.', 'Boire remarquer puissance amour. Groupe général lequel soi entrée détail étude. Expérience amener étouffer accuser.\nAutorité suivre craindre cours pleurer transformer. Quitter éclater poser toute.', 'Partir connaître volonté bonheur naturel chute sur. Revoir enfoncer dernier rappeler.\nGens après cerveau aide avec autrefois. Également général tôt nommer effort éviter.', 'Oeil chiffre premier tour conseil glisser complet. Étage maintenir examiner parole bas rappeler écouter.', 'Sueur presque hier qui événement somme plein. Nous animal respirer empêcher établir. Silencieux sueur reconnaître aussi simplement droit chacun.'] ['Eh question arrivée paix ajouter intérieur. Sentir violence porte.\nAccompagner appel pain yeux son précieux. Changer mot continuer habitant prince.', 'Anglais partager somme face quelque plutôt.\nEffet bas soleil ramasser rejoindre source fumer art. Pitié peine mémoire puissance gros il devant.', "Devant main content avis solitude éternel. Dessus propre élever l'un fin. Éteindre prêter appuyer tracer autre imposer projet.\nViolence imposer caractère avouer blond réfléchir.", "Prêt remplir lourd impression particulier. Dégager caresser répéter blond puis. D'Abord souffrir vrai accompagner mari.", 'Faire partie roi sortir choix comprendre. Chair court terme lequel. Demain cerveau déjà fin oh.\nLeur terreur où aller nouveau jusque en valoir. Penser peu léger un jeune enfant sept.'] ['Étendre clef âgé mourir assurer. Cheveu aile pareil ainsi appuyer début perdre auprès.\nVie gloire suite curieux habitude existence. Peine proposer reposer front.', 'Front flot absence champ. Seigneur précieux aventure demeurer sans composer troisième. Quel secret miser printemps.', 'Relever morceau dire. Image produire français. Arrêter donner voyage deux poids premier tourner.\nLumière fine science dessiner campagne vision revoir. Nez problème point étudier terrain.', 'Montagne hésiter état accrocher.\nQuinze construire mensonge goutte tu. Malheur attitude passage nation. Part mêler fin habiter endroit admettre rencontrer.', 'Exposer tu mode fumer oreille rêver. Surveiller exprimer vision cinq corde. Pareil lequel public désirer suffire dormir.']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.texts(nb_texts=5, max_nb_chars=50) ... ['Rayon geste dieu longtemps françois répéter.', 'Rapport ouvrage dessiner témoin.', 'Problème fort saison plaindre. Or sans espace.', 'Menacer rompre matin véritable.', 'Or personne jambe.'] ['Surprendre toit mauvais fois.', 'Bon chat pouvoir après.', 'Foi fatigue visage année. Corde vide printemps.', 'Autre élever haine attendre instant.', 'Vers assister plus sentiment etc.'] ['Que esprit après douze dépasser un étroit.', 'Fixer garde pendre abattre contre.', 'Franc premier genou. Colon au préférer.', 'Armer saint vieux garder mener vent vingt.', 'Adresser rappeler visage pluie or.'] ['Jamais toit pareil aider.', 'Doute agir appartenir point.', 'Prêter tache passé fauteuil marquer couvrir noir.', 'Prison est pain appel coin vision.', 'En signe propre.'] ['Puissant sujet théâtre parcourir fer vieux.', 'Bleu militaire eaux.', 'Groupe exister au société.', 'Lequel devenir passer vrai.', 'Voisin vite chemin frapper.']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.texts(nb_texts=5, max_nb_chars=50, ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... ['Jkl def def ghi def jkl. Jkl def jkl abc abc.', 'Jkl def ghi jkl ghi def abc def.', 'Ghi def jkl ghi. Ghi jkl def.', 'Def abc def ghi jkl abc ghi. Ghi jkl ghi jkl.', 'Ghi ghi def. Ghi abc abc abc. Jkl jkl ghi def.'] ['Def ghi ghi jkl def def abc.', 'Abc abc ghi abc. Ghi jkl ghi abc abc abc jkl.', 'Abc jkl ghi. Abc jkl jkl abc def abc def.', 'Abc jkl abc def ghi jkl jkl abc.', 'Abc jkl ghi abc ghi. Jkl jkl ghi def ghi abc ghi.'] ['Ghi ghi jkl jkl abc. Def def ghi abc abc.', 'Def ghi def. Abc abc ghi.', 'Abc jkl jkl def ghi jkl jkl. Jkl def ghi def.', 'Abc ghi jkl def jkl. Def jkl ghi abc.', 'Def abc abc ghi. Def def ghi jkl jkl jkl ghi.'] ['Abc def def. Ghi def ghi abc abc jkl.', 'Def jkl ghi. Def def def abc jkl.', 'Ghi jkl jkl ghi def jkl. Abc abc ghi abc.', 'Jkl ghi abc abc abc jkl ghi. Def def abc jkl.', 'Def def ghi jkl. Ghi abc def def jkl.'] ['Jkl def jkl def def def. Ghi jkl abc ghi ghi.', 'Def ghi def jkl ghi jkl abc abc.', 'Jkl ghi jkl ghi ghi ghi jkl.', 'Ghi abc jkl abc jkl ghi. Ghi def abc jkl jkl.', 'Def jkl abc abc def. Jkl ghi abc ghi jkl def abc.']
- word(part_of_speech: str | None = None, ext_word_list: Sequence[str] | None = None) str ¶
Generate a word.
This method uses
words()
under the hood with thenb
argument set to1
to generate the result.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.word() ... 'matière' 'nom' 'asseoir' 'extraordinaire' 'prince'
>>> Faker.seed(0) >>> for _ in range(5): ... fake.word(ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... 'jkl' 'jkl' 'abc' 'ghi' 'jkl'
- words(nb: int = 3, ext_word_list: List[str] | None = None, part_of_speech: str | None = None, unique: bool = False) List[str] ¶
Generate a tuple of words.
The
nb
argument controls the number of words in the resulting list, and ifext_word_list
is provided, words from that list will be used instead of those from the locale provider’s built-in word list.if
word_list
is not provided, the method will use a default value of None, which will result in the method calling theget_words_list
method to get the word list. Ifword_list
is provided, the method will use the provided list.If
unique
isTrue
, this method will return a list containing unique words. Under the hood,random_sample()
will be used for sampling without replacement. Ifunique
isFalse
,random_choices()
is used instead, and the list returned may contain duplicates.- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.words() ... ['sens', 'rayon', 'geste'] ['dieu', 'longtemps', 'françois'] ['répéter', 'embrasser', 'jambe'] ['nécessaire', 'te', 'ligne'] ['dresser', 'rapport', 'ouvrage']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.words(nb=5) ... ['sens', 'rayon', 'geste', 'dieu', 'longtemps'] ['françois', 'répéter', 'embrasser', 'jambe', 'nécessaire'] ['te', 'ligne', 'dresser', 'rapport', 'ouvrage'] ['dessiner', 'témoin', 'visite', 'robe', 'tâche'] ['encore', 'prouver', 'surtout', 'police', 'interroger']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.words(nb=5, ext_word_list=['abc', 'def', 'ghi', 'jkl']) ... ['jkl', 'jkl', 'def', 'def', 'ghi'] ['def', 'jkl', 'def', 'def', 'ghi'] ['jkl', 'ghi', 'def', 'jkl', 'ghi'] ['def', 'jkl', 'jkl', 'jkl', 'jkl'] ['def', 'ghi', 'jkl', 'ghi', 'def']
>>> Faker.seed(0) >>> for _ in range(5): ... fake.words(nb=4, ext_word_list=['abc', 'def', 'ghi', 'jkl'], unique=True) ... ['jkl', 'def', 'abc', 'ghi'] ['jkl', 'def', 'ghi', 'abc'] ['ghi', 'jkl', 'abc', 'def'] ['ghi', 'abc', 'jkl', 'def'] ['def', 'jkl', 'abc', 'ghi']
faker.providers.person
¶
- class faker.providers.person.fr_FR.Provider(generator: Any)¶
Bases:
Provider
- first_name() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.first_name() ... 'Camille' 'Alice' 'Patricia' 'Astrid' 'Augustin'
- first_name_female() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.first_name_female() ... 'Nathalie' 'Paulette' 'Alice' 'Josette' 'Dominique'
- first_name_male() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.first_name_male() ... 'Léon' 'Marc' 'Alphonse' 'Gilles' 'Pierre'
- first_name_nonbinary() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.first_name_nonbinary() ... 'Camille' 'Alice' 'Patricia' 'Astrid' 'Augustin'
- 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() ... 'Collin' 'Thierry' 'De Oliveira' 'Fournier' 'Poirier'
- last_name_female() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.last_name_female() ... 'Collin' 'Thierry' 'De Oliveira' 'Fournier' 'Poirier'
- last_name_male() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.last_name_male() ... 'Collin' 'Thierry' 'De Oliveira' 'Fournier' 'Poirier'
- last_name_nonbinary() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.last_name_nonbinary() ... 'Collin' 'Thierry' 'De Oliveira' 'Fournier' 'Poirier'
- name() str ¶
- Example:
‘John Doe’
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.name() ... 'Paulette Fournier' 'Pierre-Patrick Lebon' 'Olivier Pelletier de la Bodin' 'Guy Joly' 'Thierry Deschamps'
- name_female() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.name_female() ... 'Paulette de Poirier' 'Véronique-Océane Bailly' 'Martine Guillon-Carpentier' 'Christine-Lorraine Joly' 'Jeannine Rossi'
- name_male() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.name_male() ... 'Marc de Poirier' 'Patrick-Luc Bailly' 'Joseph Guillon-Carpentier' 'Daniel-Guy Joly' 'Thierry Deschamps'
- name_nonbinary() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.name_nonbinary() ... 'Paulette Fournier' 'Pierre-Patrick Lebon' 'Olivier Pelletier de la Bodin' 'Guy Joly' 'Thierry Deschamps'
- prefix() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.prefix() ... 'du' 'du' 'de' 'Le' 'du'
- prefix_female() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.prefix_female() ... 'du' 'du' 'de' 'Le' 'du'
- prefix_male() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.prefix_male() ... 'du' 'du' 'de' 'Le' 'du'
- prefix_nonbinary() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.prefix_nonbinary() ... 'du' 'du' 'de' 'Le' 'du'
- 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() ... '' '' '' '' ''
faker.providers.phone_number
¶
- class faker.providers.phone_number.fr_FR.Provider(generator: Any)¶
Bases:
Provider
- area_code_with_separator() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.area_code_with_separator() ... '5 32' '5 62' '1 70' '3 89' '7 36'
- area_code_without_separator() str ¶
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.area_code_without_separator() ... '532' '562' '170' '389' '736'
- 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'
faker.providers.ssn
¶
- class faker.providers.ssn.fr_FR.Provider(generator: Any)¶
Bases:
Provider
A Faker provider for the French VAT IDs
- ssn() str ¶
Creates a French numéro de sécurité sociale https://fr.wikipedia.org/wiki/Num%C3%A9ro_de_s%C3%A9curit%C3%A9_sociale_en_France#Signification_des_chiffres_du_NIR https://www.comptavoo.com/Numero-Securite-sociale,348.html :return: a French SSN
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.ssn() ... '297070608826648' '251056311336774' '164033818514436' '179057055072335' '139029550007624'
- vat_id() str ¶
http://ec.europa.eu/taxation_customs/vies/faq.html#item_11 :return: a random French VAT ID
- Examples:
>>> Faker.seed(0) >>> for _ in range(5): ... fake.vat_id() ... 'FR6n 048764759' 'FR42 194892411' 'FRC7 815659387' 'FRU0 801609753' 'FRu1 393328711'