Fake Data: Italian as spoken in United States (it_CH)¶
The basic concepts of fake data are described in the main tutorial.
Our fake data can be localized to many languages. We have detailed docs about the other languages.
Current Locale: it_CH (United States)
- Fake Data: Italian as spoken in United States (it_CH)
- Commonly Used
- Rarely Used
- Salesforce Fakers
- Address Fakers
- fake: Address
- fake: AdministrativeUnit
- fake: BuildingNumber
- fake: CityPrefix
- fake: CitySuffix
- fake: CountryCode
- fake: CurrentCountryCode
- fake: MilitaryApo
- fake: MilitaryDpo
- fake: MilitaryShip
- fake: MilitaryState
- fake: PostalcodeInState
- fake: PostalcodePlus4
- fake: Postcode
- fake: PostcodeInState
- fake: SecondaryAddress
- fake: StateAbbr
- fake: StreetName
- fake: StreetSuffix
- fake: Zipcode
- fake: ZipcodeInState
- fake: ZipcodePlus4
- Automotive Fakers
- Bank Fakers
- Barcode Fakers
- Color Fakers
- Company Fakers
- Credit_Card Fakers
- Currency Fakers
- Date_Time Fakers
- fake: AmPm
- fake: Century
- fake: Date
- fake: DateBetween
- fake: DateBetweenDates
- fake: DateObject
- fake: DateOfBirth
- fake: DateThisCentury
- fake: DateThisDecade
- fake: DateThisMonth
- fake: DateThisYear
- fake: DayOfMonth
- fake: DayOfWeek
- fake: FutureDate
- fake: Month
- fake: MonthName
- fake: PastDate
- fake: PastDatetime
- fake: Pytimezone
- fake: TimeDelta
- fake: TimeObject
- fake: TimeSeries
- fake: Timezone
- fake: UnixTime
- Decorators.Py Fakers
- Emoji Fakers
- File Fakers
- Geo Fakers
- Internet Fakers
- fake: Dga
- fake: HttpMethod
- fake: HttpStatusCode
- fake: IanaId
- fake: ImageUrl
- fake: Ipv4
- fake: Ipv4NetworkClass
- fake: Ipv4Private
- fake: Ipv4Public
- fake: Ipv6
- fake: MacAddress
- fake: NicHandle
- fake: NicHandles
- fake: PortNumber
- fake: RipeId
- fake: Tld
- fake: Uri
- fake: UriExtension
- fake: UriPage
- fake: UriPath
- fake: Url
- Isbn Fakers
- Job Fakers
- Lorem Fakers
- Misc Fakers
- Passport Fakers
- Person Fakers
- Phone_Number Fakers
- Profile Fakers
- Providers Fakers
- fake: Bothify
- fake: Hexify
- fake: LanguageCode
- fake: Lexify
- fake: Locale
- fake: Numerify
- fake: RandomChoices
- fake: RandomDigit
- fake: RandomDigitAboveTwo
- fake: RandomDigitNotNull
- fake: RandomDigitNotNullOrEmpty
- fake: RandomDigitOrEmpty
- fake: RandomElement
- fake: RandomElements
- fake: RandomInt
- fake: RandomLetter
- fake: RandomLetters
- fake: RandomLowercaseLetter
- fake: RandomNumber
- fake: RandomSample
- fake: RandomUppercaseLetter
- fake: RandomizeNbElements
- Python Fakers
- Sbn Fakers
- Ssn Fakers
- User_Agent Fakers
Commonly Used¶
Salesforce Fakers¶
fake: Email¶
Email address using one of the "example" domains
Aliases: email
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Contact
fields:
FirstName:
fake: FirstName
LastName:
fake: LastName
Email:
fake: Email
- object: Contact
fields:
FirstName: ${{fake.FirstName}} Sam
LastName: ${{fake.FirstName}} Senior
Email: ${{fake.Email}}
Outputs:
Contact(id=1, FirstName=Kerri, LastName=Vasquez, Email=Ke.Vasquez@example.com)
Contact(id=2, FirstName=Hunter Sam, LastName=Dwayne Senior, Email=lydia92@example.com)
fake: Postalcode¶
Return whatever counts as a postalcode for a particular locale
Aliases: postalcode
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.postalcode
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
BillingPostalCode:
fake: postalcode
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingPostalCode: ${{fake.Postalcode}}
Outputs:
Account(id=1, Name=Wise-Watts, BillingPostalCode=80571)
Account(id=2, Name=Baird, Riley and Shea Holdings, BillingPostalCode=72921)
fake: State¶
Return a state, province or other appropriate administrative unit
Aliases: state
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.state
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
BillingState:
fake: State
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingState: ${{fake.State}}
Outputs:
Account(id=1, Name=Gutierrez Ltd, BillingState=Montana)
Account(id=2, Name=Tapia, Zuniga and Macdonald Holdings, BillingState=South Dakota)
Address Fakers¶
fake: City¶
Example:: 'Sashabury'
Aliases: city
Source: faker : faker.providers.address.en_US.Provider.city
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
BillingCity:
fake: City
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingCity: ${{fake.City}}
Outputs:
Account(id=1, Name=Chan, Ortiz and Hughes, BillingCity=Kirstenfort)
Account(id=2, Name=Lowe PLC Holdings, BillingCity=Gilbertside)
fake: Country¶
Aliases: country
Source: faker : faker.providers.address.en_US.Provider.country
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
BillingCountry:
fake: Country
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingCountry: ${{fake.Country}}
Outputs:
Account(id=1, Name=Beck, Strickland and Ortiz, BillingCountry=Nepal)
Account(id=2, Name=Barker-Allison Holdings, BillingCountry=Dominican Republic)
fake: CurrentCountry¶
Aliases: current_country, currentcountry
Source: faker : faker.providers.address.en_US.Provider.current_country
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
BillingCountry:
fake: CurrentCountry
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingCountry: ${{fake.CurrentCountry}}
Outputs:
Account(id=1, Name=Fowler, Hogan and Ward, BillingCountry=United States)
Account(id=2, Name=Woodard and Sons Holdings, BillingCountry=United States)
fake: StreetAddress¶
Example:: '791 Crist Parks'
Aliases: street_address, streetaddress
Source: faker : faker.providers.address.en_US.Provider.street_address
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
BillingStreet:
fake: StreetAddress
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingStreet: ${{fake.StreetAddress}}
Outputs:
Account(id=1, Name=Howell Inc, BillingStreet=35256 Edward Tunnel Apt. 309)
Account(id=2, Name=Krause, Huerta and Clayton Holdings, BillingStreet=13991 Ortiz Land)
Company Fakers¶
fake: CatchPhrase¶
Example:: 'Robust full-range hub'
Aliases: catch_phrase, catchphrase
Source: faker : faker.providers.company.en_US.Provider.catch_phrase
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
Description:
fake: CatchPhrase
- object: Account
fields:
Name: ${{fake.Company}} Holdings
Description: 'Our Motto: ${{fake.CatchPhrase}}'
Outputs:
Account(id=1, Name=Whitaker Group, Description=Secured bandwidth-monitored firmware)
Account(id=2, Name=George Inc Holdings, Description=Our Motto: Stand-alone exuding hardware)
fake: Company¶
Example:: 'Acme Ltd'
Aliases: company
Source: faker : faker.providers.company.en_US.Provider.company
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
- object: Account
fields:
Name: ${{fake.Company}} Holdings
Outputs:
Account(id=1, Name=Mckee Group)
Account(id=2, Name=Fowler LLC Holdings)
Date_Time Fakers¶
fake: Time¶
Get a time string (24h format by default)
Param: pattern: format
Example:: '15:02:34'
Aliases: time
Source: faker : faker.providers.date_time.en_US.Provider.time
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Time}}
Outputs:
SomeObject(id=1, formula_field_example=22:06:55)
fake: Year¶
Aliases: year
Source: faker : faker.providers.date_time.en_US.Provider.year
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Student
fields:
GraduationYear:
fake: year
- object: Student
fields:
GraduationYear: ${{year}}
Outputs:
Student(id=1, GraduationYear=1997)
Student(id=2, GraduationYear=)
Lorem Fakers¶
fake: Paragraph¶
Generate a paragraph.
The nb_sentences
argument controls how many sentences the paragraph
will contain, and setting variable_nb_sentences
to False
will
generate the exact amount, while setting it to True
(default) will
generate a random amount (+/-40%, minimum of 1) using
|randomize_nb_elements|.
Under the hood, |sentences| is used to generate the sentences, so the
argument ext_word_list
works in the same way here as it would in
that method.
ext_word_list=['abc', 'def', 'ghi', 'jkl']
Aliases: paragraph
Source: faker : faker.providers.lorem.la.Provider.paragraph
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Paragraph}}
Outputs:
SomeObject(id=1, formula_field_example=Autem mollitia provident molestias repellendus molestiae vitae. Molestias enim at reiciendis et doloribus delectus reprehenderit. Nostrum omnis labore.)
fake: Sentence¶
Generate a sentence.
The nb_words
argument controls how many words the sentence will
contain, and setting variable_nb_words
to False
will generate
the exact amount, while setting it to True
(default) will generate
a random amount (+/-40%, minimum of 1) using |randomize_nb_elements|.
Under the hood, |words| is used to generate the words, so the argument
ext_word_list
works in the same way here as it would in that method.
ext_word_list=['abc', 'def', 'ghi', 'jkl']
Aliases: sentence
Source: faker : faker.providers.lorem.la.Provider.sentence
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Sentence}}
Outputs:
SomeObject(id=1, formula_field_example=Eius repellat sed tempora nihil veniam neque.)
fake: Text¶
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 either |words|, |sentences|, or |paragraphs| for text
generation. The ext_word_list
argument works in exactly the same way
it would in any of those methods.
Aliases: text
Source: faker : faker.providers.lorem.la.Provider.text
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Text}}
Outputs:
SomeObject(id=1, formula_field_example=Quibusdam repudiandae aspernatur nisi praesentium cum. Odit fugiat soluta necessitatibus impedit.)
fake: Word¶
Generate a word.
This method uses |words| under the hood with the nb
argument set to
1
to generate the result.
Aliases: word
Source: faker : faker.providers.lorem.la.Provider.word
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Word}}
Outputs:
SomeObject(id=1, formula_field_example=nesciunt)
Person Fakers¶
fake: FirstName¶
Aliases: first_name, firstname
Source: faker : faker.providers.person.en_US.Provider.first_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Contact
fields:
FirstName:
fake: FirstName
LastName:
fake: LastName
- object: Contact
fields:
FirstName: ${{fake.FirstName}} Sam
LastName: ${{fake.LastName}}-Jones
Outputs:
Contact(id=1, FirstName=Adrian, LastName=Clements)
Contact(id=2, FirstName=Lisa Sam, LastName=Glenn-Jones)
fake: FirstNameFemale¶
Aliases: first_name_female, firstnamefemale
Source: faker : faker.providers.person.en_US.Provider.first_name_female
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Contact
fields:
FirstName:
fake: FirstNameFemale
LastName:
fake: LastName
- object: Contact
fields:
FirstName: ${{fake.FirstNameFemale}} Beth
LastName: ${{fake.LastName}}-Jones
Outputs:
Contact(id=1, FirstName=Sophia, LastName=Armstrong)
Contact(id=2, FirstName=Jasmin Beth, LastName=Sandoval-Jones)
fake: FirstNameMale¶
Aliases: first_name_male, firstnamemale
Source: faker : faker.providers.person.en_US.Provider.first_name_male
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Contact
fields:
FirstName:
fake: FirstNameMale
LastName:
fake: LastName
- object: Contact
fields:
FirstName: ${{fake.FirstNameMale}} Beth
LastName: ${{fake.LastName}}-Jones
Outputs:
Contact(id=1, FirstName=Leonard, LastName=Salas)
Contact(id=2, FirstName=Calvin Beth, LastName=Gonzalez-Jones)
fake: FirstNameNonbinary¶
Aliases: first_name_nonbinary, firstnamenonbinary
Source: faker : faker.providers.person.en_US.Provider.first_name_nonbinary
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Contact
fields:
FirstName:
fake: FirstNameNonBinary
LastName:
fake: LastName
- object: Contact
fields:
FirstName: ${{fake.FirstNameNonBinary}} Mary-John
LastName: ${{fake.LastName}}-Jones
Outputs:
Contact(id=1, FirstName=Frederick, LastName=Stuart)
Contact(id=2, FirstName=Ricky Mary-John, LastName=Webb-Jones)
fake: LastName¶
Aliases: last_name, lastname
Source: faker : faker.providers.person.en_US.Provider.last_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Contact
fields:
FirstName:
fake: FirstName
LastName:
fake: LastName
- object: Contact
fields:
FirstName: ${{fake.FirstName}} Sam
LastName: ${{fake.FirstName}} Senior
Outputs:
Contact(id=1, FirstName=Autumn, LastName=Chavez)
Contact(id=2, FirstName=Jay Sam, LastName=Stanley Senior)
Phone_Number Fakers¶
fake: PhoneNumber¶
Aliases: phone_number, phonenumber
Source: faker : faker.providers.phone_number.en_US.Provider.phone_number
Recipe:
- var: snowfakery_locale
value: it_CH
- object: Account
fields:
Name:
fake: Company
Phone:
fake: PhoneNumber
- object: Account
fields:
Name: ${{fake.Company}} Holdings
Phone: ${{fake.PhoneNumber}} ext. 23
Outputs:
Account(id=1, Name=Pruitt-Gutierrez, Phone=390-904-2294x56824)
Account(id=2, Name=Montgomery, Benitez and Torres Holdings, Phone=928-714-6546x1187 ext. 23)
Rarely Used¶
Salesforce Fakers¶
fake: DateTime¶
Aliases: date_time, datetime
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.date_time_between
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateTime}}
Outputs:
SomeObject(id=1, formula_field_example=2004-08-08 05:28:54.511124+00:00)
fake: DateTimeBetween¶
Aliases: date_time_between, datetimebetween
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.date_time_between
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateTimeBetween}}
Outputs:
SomeObject(id=1, formula_field_example=2007-02-02 09:38:53.992604+00:00)
fake: DateTimeBetweenDates¶
Aliases: date_time_between_dates, datetimebetweendates
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.date_time_between
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateTimeBetweenDates}}
Outputs:
SomeObject(id=1, formula_field_example=2021-02-14 21:16:27.387276+00:00)
fake: FutureDatetime¶
Aliases: future_datetime, futuredatetime
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.future_datetime
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FutureDatetime}}
Outputs:
SomeObject(id=1, formula_field_example=2024-04-28 05:40:18.554112+00:00)
fake: Iso8601¶
Aliases: iso8601
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.iso8601
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Iso8601}}
Outputs:
SomeObject(id=1, formula_field_example=1973-07-29T11:59:27.277581+00:00)
fake: UserName¶
Globally unique Salesforce-style username in the form of an email address
Aliases: user_name, username
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.user_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UserName}}
Outputs:
SomeObject(id=1, formula_field_example=Levi_Stevens_350d278d-41a8-46e1-a5e0-49937f411fed@desktop-11.perez.info)
fake: Alias¶
Salesforce-style 8-character alias: really an 8 char-truncated firstname. Not necessarily unique, but likely to be unique if you create small numbers of them.
Aliases: alias
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.alias
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Alias}}
Outputs:
SomeObject(id=1, formula_field_example=Marvin)
fake: RealisticMaybeRealEmail¶
Like fake: email except that the email domain may be real and therefore the email address itself may be real. Use with caution, you might accidentally email strangers!!!
Aliases: realistic_maybe_real_email, realisticmayberealemail
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.realistic_maybe_real_email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RealisticMaybeRealEmail}}
Outputs:
SomeObject(id=1, formula_field_example=garrisonkaren@example.org)
Address Fakers¶
fake: Address¶
Example:: '791 Crist Parks, Sashabury, IL 86039-9874'
Aliases: address
Source: faker : faker.providers.address.en_US.Provider.address
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Address}}
Outputs:
SomeObject(id=1, formula_field_example=PSC 4115, Box 7815
APO AA 41945)
fake: AdministrativeUnit¶
Aliases: administrative_unit, administrativeunit
Source: faker : faker.providers.address.en_US.Provider.administrative_unit
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.AdministrativeUnit}}
Outputs:
SomeObject(id=1, formula_field_example=Nebraska)
fake: BuildingNumber¶
Example:: '791'
Aliases: building_number, buildingnumber
Source: faker : faker.providers.address.en_US.Provider.building_number
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.BuildingNumber}}
Outputs:
SomeObject(id=1, formula_field_example=382)
fake: CityPrefix¶
Aliases: city_prefix, cityprefix
Source: faker : faker.providers.address.en_US.Provider.city_prefix
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CityPrefix}}
Outputs:
SomeObject(id=1, formula_field_example=Port)
fake: CitySuffix¶
Example:: 'town'
Aliases: city_suffix, citysuffix
Source: faker : faker.providers.address.en_US.Provider.city_suffix
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CitySuffix}}
Outputs:
SomeObject(id=1, formula_field_example=ton)
fake: CountryCode¶
Aliases: country_code, countrycode
Source: faker : faker.providers.address.en_US.Provider.country_code
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CountryCode}}
Outputs:
SomeObject(id=1, formula_field_example=NL)
fake: CurrentCountryCode¶
Aliases: current_country_code, currentcountrycode
Source: faker : faker.providers.address.en_US.Provider.current_country_code
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CurrentCountryCode}}
Outputs:
SomeObject(id=1, formula_field_example=US)
fake: MilitaryApo¶
Example:: 'PSC 5394 Box 3492
Aliases: military_apo, militaryapo
Source: faker : faker.providers.address.en_US.Provider.military_apo
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MilitaryApo}}
Outputs:
SomeObject(id=1, formula_field_example=PSC 1948, Box 9241)
fake: MilitaryDpo¶
Example:: 'Unit 3333 Box 9342'
Aliases: military_dpo, militarydpo
Source: faker : faker.providers.address.en_US.Provider.military_dpo
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MilitaryDpo}}
Outputs:
SomeObject(id=1, formula_field_example=Unit 1948 Box 9241)
fake: MilitaryShip¶
Example:: 'USS'
Aliases: military_ship, militaryship
Source: faker : faker.providers.address.en_US.Provider.military_ship
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MilitaryShip}}
Outputs:
SomeObject(id=1, formula_field_example=USS)
fake: MilitaryState¶
Example:: 'APO'
Aliases: military_state, militarystate
Source: faker : faker.providers.address.en_US.Provider.military_state
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MilitaryState}}
Outputs:
SomeObject(id=1, formula_field_example=AE)
fake: PostalcodeInState¶
Aliases: postalcode_in_state, postalcodeinstate
Source: faker : faker.providers.address.en_US.Provider.postalcode_in_state
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PostalcodeInState}}
Outputs:
SomeObject(id=1, formula_field_example=13981)
fake: PostalcodePlus4¶
Aliases: postalcode_plus4, postalcodeplus4
Source: faker : faker.providers.address.en_US.Provider.postalcode_plus4
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PostalcodePlus4}}
Outputs:
SomeObject(id=1, formula_field_example=67514-7962)
fake: Postcode¶
Aliases: postcode
Source: faker : faker.providers.address.en_US.Provider.postcode
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Postcode}}
Outputs:
SomeObject(id=1, formula_field_example=55626)
fake: PostcodeInState¶
Return:s: A random postcode within the provided state abbreviation
Param: state_abbr: A state abbreviation
Aliases: postcode_in_state, postcodeinstate
Source: faker : faker.providers.address.en_US.Provider.postcode_in_state
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PostcodeInState}}
Outputs:
SomeObject(id=1, formula_field_example=13981)
fake: SecondaryAddress¶
Aliases: secondary_address, secondaryaddress
Source: faker : faker.providers.address.en_US.Provider.secondary_address
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SecondaryAddress}}
Outputs:
SomeObject(id=1, formula_field_example=Suite 938)
fake: StateAbbr¶
Return:s: A random two-letter USPS postal code
By default, the resulting code may abbreviate any of the fifty states, five US territories, or three freely-associating sovereign states.
Param: include_territories: If True, territories will be included. If False, US territories will be excluded.
Param: include_freely_associated_states: If True, freely-associated states will be included. If False, sovereign states in free association with the US will be excluded.
Aliases: state_abbr, stateabbr
Source: faker : faker.providers.address.en_US.Provider.state_abbr
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.StateAbbr}}
Outputs:
SomeObject(id=1, formula_field_example=WV)
fake: StreetName¶
Example:: 'Crist Parks'
Aliases: street_name, streetname
Source: faker : faker.providers.address.en_US.Provider.street_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.StreetName}}
Outputs:
SomeObject(id=1, formula_field_example=Goodwin Tunnel)
fake: StreetSuffix¶
Example:: 'Avenue'
Aliases: street_suffix, streetsuffix
Source: faker : faker.providers.address.en_US.Provider.street_suffix
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.StreetSuffix}}
Outputs:
SomeObject(id=1, formula_field_example=Trace)
fake: Zipcode¶
Aliases: zipcode
Source: faker : faker.providers.address.en_US.Provider.zipcode
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Zipcode}}
Outputs:
SomeObject(id=1, formula_field_example=55626)
fake: ZipcodeInState¶
Aliases: zipcode_in_state, zipcodeinstate
Source: faker : faker.providers.address.en_US.Provider.zipcode_in_state
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.ZipcodeInState}}
Outputs:
SomeObject(id=1, formula_field_example=13981)
fake: ZipcodePlus4¶
Aliases: zipcode_plus4, zipcodeplus4
Source: faker : faker.providers.address.en_US.Provider.zipcode_plus4
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.ZipcodePlus4}}
Outputs:
SomeObject(id=1, formula_field_example=67514-7962)
Automotive Fakers¶
fake: LicensePlate¶
Generate a license plate.
Aliases: license_plate, licenseplate
Source: faker : faker.providers.automotive.en_US.Provider.license_plate
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LicensePlate}}
Outputs:
SomeObject(id=1, formula_field_example=194-EJEY)
fake: Vin¶
Generate vin number.
Aliases: vin
Source: faker : faker.providers.automotive.en_US.Provider.vin
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Vin}}
Outputs:
SomeObject(id=1, formula_field_example=16S1YMFL25CEF0V66)
Bank Fakers¶
fake: Aba¶
Generate an ABA routing transit number.
Aliases: aba
Source: faker : faker.providers.bank.it_CH.Provider.aba
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Aba}}
Outputs:
SomeObject(id=1, formula_field_example=052194896)
fake: BankCountry¶
Generate the bank provider's ISO 3166-1 alpha-2 country code.
Aliases: bank_country, bankcountry
Source: faker : faker.providers.bank.it_CH.Provider.bank_country
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.BankCountry}}
Outputs:
SomeObject(id=1, formula_field_example=CH)
fake: Bban¶
Generate a Basic Bank Account Number (BBAN).
Aliases: bban
Source: faker : faker.providers.bank.it_CH.Provider.bban
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Bban}}
Outputs:
SomeObject(id=1, formula_field_example=87784080160975351)
fake: Iban¶
Generate an International Bank Account Number (IBAN).
Aliases: iban
Source: faker : faker.providers.bank.it_CH.Provider.iban
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Iban}}
Outputs:
SomeObject(id=1, formula_field_example=CH2487784080160975351)
fake: Swift¶
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 be None
or the integers 8
or 11
. If the
value is None
, then a value of 8
or 11
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 of
length
is 11
. If primary
is True
and length
is
11
, 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
is True
, 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 if use_dataset
were
False
, and in that mode, all those codes will just be randomly
generated as per the specification.
Aliases: swift
Source: faker : faker.providers.bank.it_CH.Provider.swift
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift}}
Outputs:
SomeObject(id=1, formula_field_example=JDXCCHV4)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift(length=8)}}
Outputs:
SomeObject(id=1, formula_field_example=ZRACCHZA)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift(length=8, use_dataset=True)}}
Outputs:
SomeObject(id=1, formula_field_example=OCCKCH65)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift(length=11)}}
Outputs:
SomeObject(id=1, formula_field_example=SHJFCHMLCQ4)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift(length=11, primary=True)}}
Outputs:
SomeObject(id=1, formula_field_example=IQZHCHN0XXX)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift(length=11, use_dataset=True)}}
Outputs:
SomeObject(id=1, formula_field_example=LZFKCH1DGJO)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift(length=11, primary=True, use_dataset=True)}}
Outputs:
SomeObject(id=1, formula_field_example=CLDBCHBMXXX)
fake: Swift11¶
Generate an 11-digit SWIFT code.
This method uses |swift| under the hood with the length
argument set
to 11
. If primary
is set to True
, the SWIFT code will always
end with 'XXX'
. All 11-digit SWIFT codes use this convention to
refer to the primary branch/office.
Aliases: swift11
Source: faker : faker.providers.bank.it_CH.Provider.swift11
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift11}}
Outputs:
SomeObject(id=1, formula_field_example=TZIRCHJTGEV)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift11(use_dataset=True)}}
Outputs:
SomeObject(id=1, formula_field_example=TPKHCHUEMOP)
fake: Swift8¶
Generate an 8-digit SWIFT code.
This method uses |swift| under the hood with the length
argument set
to 8
and with the primary
argument omitted. All 8-digit SWIFT
codes already refer to the primary branch/office.
Aliases: swift8
Source: faker : faker.providers.bank.it_CH.Provider.swift8
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift8}}
Outputs:
SomeObject(id=1, formula_field_example=SGQECHSI)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift8(use_dataset=True)}}
Outputs:
SomeObject(id=1, formula_field_example=XCVKCH49)
Barcode Fakers¶
fake: Ean¶
Generate an EAN barcode of the specified length
.
The value of length
can only be 8
or 13
(default) which will
create an EAN-8 or an EAN-13 barcode respectively.
If a value for prefixes
is specified, the result will begin with one
of the sequences in prefixes
.
Aliases: ean
Source: faker : faker.providers.barcode.en_US.Provider.ean
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean(length=13)}}
Outputs:
SomeObject(id=1, formula_field_example=1578156593879)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean(length=8)}}
Outputs:
SomeObject(id=1, formula_field_example=13933289)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean(prefixes=('00', ))}}
Outputs:
SomeObject(id=1, formula_field_example=0015871484187)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean(prefixes=('45', '49'))}}
Outputs:
SomeObject(id=1, formula_field_example=4598947196598)
fake: Ean13¶
Generate an EAN-13 barcode.
If leading_zero
is True
, the leftmost digit of the barcode will
be set to 0
. If False
, the leftmost digit cannot be 0
. If
None
(default), the leftmost digit can be any digit.
If a value for prefixes
is specified, the result will begin with one
of the sequences in prefixes
and will ignore leading_zero
.
This method uses the standard barcode provider's |ean13| under the
hood with the prefixes
argument set to the correct value to attain
the behavior described above.
.. note:: EAN-13 barcode that starts with a zero can be converted to UPC-A by dropping the leading zero. This may cause problems with readers that treat all of these code as UPC-A codes and drop the first digit when reading it.
You can set the argument prefixes
( or leading_zero
for
convenience) explicitly to avoid or to force the generated barcode to
start with a zero. You can also generate actual UPC-A barcode with
|EnUsBarcodeProvider.upc_a|.
Aliases: ean13
Source: faker : faker.providers.barcode.en_US.Provider.ean13
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean13}}
Outputs:
SomeObject(id=1, formula_field_example=1578156593879)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean13(leading_zero=False)}}
Outputs:
SomeObject(id=1, formula_field_example=5418583989479)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean13(leading_zero=True)}}
Outputs:
SomeObject(id=1, formula_field_example=0694775159171)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean13(prefixes=('00', ))}}
Outputs:
SomeObject(id=1, formula_field_example=0004135256011)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean13(prefixes=('45', '49'))}}
Outputs:
SomeObject(id=1, formula_field_example=4998910139919)
fake: Ean8¶
Generate an EAN-8 barcode.
This method uses |ean| under the hood with the length
argument
explicitly set to 8
.
If a value for prefixes
is specified, the result will begin with one
of the sequences in prefixes
.
Aliases: ean8
Source: faker : faker.providers.barcode.en_US.Provider.ean8
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean8}}
Outputs:
SomeObject(id=1, formula_field_example=42194897)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean8(prefixes=('00', ))}}
Outputs:
SomeObject(id=1, formula_field_example=00115780)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean8(prefixes=('45', '49'))}}
Outputs:
SomeObject(id=1, formula_field_example=49593877)
fake: LocalizedEan¶
Generate a localized EAN barcode of the specified length
.
The value of length
can only be 8
or 13
(default) which will
create an EAN-8 or an EAN-13 barcode respectively.
This method uses the standard barcode provider's |ean| under the hood
with the prefixes
argument explicitly set to local_prefixes
of
a localized barcode provider implementation.
Aliases: localized_ean, localizedean
Source: faker : faker.providers.barcode.en_US.Provider.localized_ean
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan}}
Outputs:
SomeObject(id=1, formula_field_example=1381565938779)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan(length=13)}}
Outputs:
SomeObject(id=1, formula_field_example=0948418583985)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan(length=8)}}
Outputs:
SomeObject(id=1, formula_field_example=10220184)
fake: LocalizedEan13¶
Generate a localized EAN-13 barcode.
This method uses |localized_ean| under the hood with the length
argument explicitly set to 13
.
Aliases: localized_ean13, localizedean13
Source: faker : faker.providers.barcode.en_US.Provider.localized_ean13
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan13}}
Outputs:
SomeObject(id=1, formula_field_example=1381565938779)
fake: LocalizedEan8¶
Generate a localized EAN-8 barcode.
This method uses |localized_ean| under the hood with the length
argument explicitly set to 8
.
Aliases: localized_ean8, localizedean8
Source: faker : faker.providers.barcode.en_US.Provider.localized_ean8
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan8}}
Outputs:
SomeObject(id=1, formula_field_example=04948926)
fake: UpcA¶
Generate a 12-digit UPC-A barcode.
The value of upc_ae_mode
controls how barcodes will be generated. If
False
(default), barcodes are not guaranteed to have a UPC-E
equivalent. In this mode, the method uses |EnUsBarcodeProvider.ean13|
under the hood, and the values of base
and number_system_digit
will be ignored.
If upc_ae_mode
is True
, the resulting barcodes are guaranteed to
have a UPC-E equivalent, and the values of base
and
number_system_digit
will be used to control what is generated.
Under this mode, base
is expected to have a 6-digit string value. If
any other value is supplied, a random 6-digit string will be used
instead. As for number_system_digit
, the expected value is a 0
or a 1
. If any other value is provided, this method will randomly
choose from the two.
.. important::
When upc_ae_mode
is enabled, you might encounter instances where
different values of base
(e.g. '120003'
and '120004'
)
produce the same UPC-A barcode. This is normal, and the reason lies
within the whole conversion process. To learn more about this and
what base
and number_system_digit
actually represent, please
refer to |EnUsBarcodeProvider.upc_e|.
Aliases: upc_a, upca
Source: faker : faker.providers.barcode.en_US.Provider.upc_a
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcA}}
Outputs:
SomeObject(id=1, formula_field_example=156593877847)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcA(upc_ae_mode=True, number_system_digit=0)}}
Outputs:
SomeObject(id=1, formula_field_example=093328000074)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcA(upc_ae_mode=True, number_system_digit=1)}}
Outputs:
SomeObject(id=1, formula_field_example=183980000090)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcA(upc_ae_mode=True, base='123456', number_system_digit=0)}}
Outputs:
SomeObject(id=1, formula_field_example=012345000065)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcA(upc_ae_mode=True, base='120003', number_system_digit=0)}}
Outputs:
SomeObject(id=1, formula_field_example=012000000003)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcA(upc_ae_mode=True, base='120004', number_system_digit=0)}}
Outputs:
SomeObject(id=1, formula_field_example=012000000003)
fake: UpcE¶
Generate an 8-digit UPC-E barcode.
UPC-E barcodes can be expressed in 6, 7, or 8-digit formats, but this
method uses the 8 digit format, since it is trivial to convert to the
other two formats. The first digit (starting from the left) is
controlled by number_system_digit
, and it can only be a 0
or a
1
. The last digit is the check digit that is inherited from the
UPC-E barcode's UPC-A equivalent. The middle six digits are collectively
referred to as the base
(for a lack of a better term).
On that note, this method uses base
and number_system_digit
to
first generate a UPC-A barcode for the check digit, and what happens
next depends on the value of safe_mode
. The argument safe_mode
exists, because there are some UPC-E values that share the same UPC-A
equivalent. For example, any UPC-E barcode of the form abc0000d
,
abc0003d
, and abc0004d
share the same UPC-A value
abc00000000d
, but that UPC-A value will only convert to abc0000d
because of (a) how UPC-E is just a zero-suppressed version of UPC-A and
(b) the rules around the conversion.
If safe_mode
is True
(default), this method performs another set
of conversions to guarantee that the UPC-E barcodes generated can be
converted to UPC-A, and that UPC-A barcode can be converted back to the
original UPC-E barcode. Using the example above, even if the bases
120003
or 120004
are used, the resulting UPC-E barcode will
always use the base 120000
.
If safe_mode
is False
, then the number_system_digit
,
base
, and the computed check digit will just be concatenated
together to produce the UPC-E barcode, and attempting to convert the
barcode to UPC-A and back again to UPC-E will exhibit the behavior
described above.
Aliases: upc_e, upce
Source: faker : faker.providers.barcode.en_US.Provider.upc_e
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE}}
Outputs:
SomeObject(id=1, formula_field_example=04219484)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='123456')}}
Outputs:
SomeObject(id=1, formula_field_example=11234562)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='123456', number_system_digit=0)}}
Outputs:
SomeObject(id=1, formula_field_example=01234565)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='123456', number_system_digit=1)}}
Outputs:
SomeObject(id=1, formula_field_example=11234562)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='120000', number_system_digit=0)}}
Outputs:
SomeObject(id=1, formula_field_example=01200003)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='120003', number_system_digit=0)}}
Outputs:
SomeObject(id=1, formula_field_example=01200003)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='120004', number_system_digit=0)}}
Outputs:
SomeObject(id=1, formula_field_example=01200003)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='120000', number_system_digit=0, safe_mode=False)}}
Outputs:
SomeObject(id=1, formula_field_example=01200003)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='120003', number_system_digit=0, safe_mode=False)}}
Outputs:
SomeObject(id=1, formula_field_example=01200033)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UpcE(base='120004', number_system_digit=0, safe_mode=False)}}
Outputs:
SomeObject(id=1, formula_field_example=01200043)
Color Fakers¶
fake: Color¶
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
argument hue
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 by hue
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).
Aliases: color
Source: faker : faker.providers.color.en_US.Provider.color
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(hue='red')}}
Outputs:
SomeObject(id=1, formula_field_example=#ef6466)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(luminosity='light')}}
Outputs:
SomeObject(id=1, formula_field_example=#f9e38b)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(hue=(100, 200), color_format='rgb')}}
Outputs:
SomeObject(id=1, formula_field_example=rgb(119, 229, 207))
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(hue='orange', luminosity='bright')}}
Outputs:
SomeObject(id=1, formula_field_example=#cc7824)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(hue=135, luminosity='dark', color_format='hsv')}}
Outputs:
SomeObject(id=1, formula_field_example=hsv(135, 98, 42))
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(hue=(300, 20), luminosity='random', color_format='hsl')}}
Outputs:
SomeObject(id=1, formula_field_example=hsl(67, 85, 27))
fake: ColorHsl¶
Generate a HSL color tuple in a human-friendly way.
Aliases: color_hsl, colorhsl
Source: faker : faker.providers.color.en_US.Provider.color_hsl
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorHsl}}
Outputs:
SomeObject(id=1, formula_field_example=(207, 76, 65))
fake: ColorHsv¶
Generate a HSV color tuple in a human-friendly way.
Aliases: color_hsv, colorhsv
Source: faker : faker.providers.color.en_US.Provider.color_hsv
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorHsv}}
Outputs:
SomeObject(id=1, formula_field_example=(207, 58, 92))
fake: ColorName¶
Generate a color name.
Aliases: color_name, colorname
Source: faker : faker.providers.color.en_US.Provider.color_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorName}}
Outputs:
SomeObject(id=1, formula_field_example=BlueViolet)
fake: ColorRgb¶
Generate a RGB color tuple of integers in a human-friendly way.
Aliases: color_rgb, colorrgb
Source: faker : faker.providers.color.en_US.Provider.color_rgb
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorRgb}}
Outputs:
SomeObject(id=1, formula_field_example=(98, 173, 234))
fake: ColorRgbFloat¶
Generate a RGB color tuple of floats in a human-friendly way.
Aliases: color_rgb_float, colorrgbfloat
Source: faker : faker.providers.color.en_US.Provider.color_rgb_float
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorRgbFloat}}
Outputs:
SomeObject(id=1, formula_field_example=(0.3864000000000001, 0.6798800000000002, 0.92))
fake: HexColor¶
Generate a color formatted as a hex triplet.
Aliases: hex_color, hexcolor
Source: faker : faker.providers.color.en_US.Provider.hex_color
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.HexColor}}
Outputs:
SomeObject(id=1, formula_field_example=#c2094d)
fake: RgbColor¶
Generate a color formatted as a comma-separated RGB value.
Aliases: rgb_color, rgbcolor
Source: faker : faker.providers.color.en_US.Provider.rgb_color
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RgbColor}}
Outputs:
SomeObject(id=1, formula_field_example=155,244,183)
fake: RgbCssColor¶
Generate a color formatted as a CSS rgb() function.
Aliases: rgb_css_color, rgbcsscolor
Source: faker : faker.providers.color.en_US.Provider.rgb_css_color
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RgbCssColor}}
Outputs:
SomeObject(id=1, formula_field_example=rgb(155,244,183))
fake: SafeColorName¶
Generate a web-safe color name.
Aliases: safe_color_name, safecolorname
Source: faker : faker.providers.color.en_US.Provider.safe_color_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SafeColorName}}
Outputs:
SomeObject(id=1, formula_field_example=fuchsia)
fake: SafeHexColor¶
Generate a web-safe color formatted as a hex triplet.
Aliases: safe_hex_color, safehexcolor
Source: faker : faker.providers.color.en_US.Provider.safe_hex_color
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SafeHexColor}}
Outputs:
SomeObject(id=1, formula_field_example=#99ffbb)
Company Fakers¶
fake: Bs¶
Example:: 'integrate extensible convergence'
Aliases: bs
Source: faker : faker.providers.company.en_US.Provider.bs
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Bs}}
Outputs:
SomeObject(id=1, formula_field_example=synthesize wireless content)
fake: CompanySuffix¶
Example:: 'Ltd'
Aliases: company_suffix, companysuffix
Source: faker : faker.providers.company.en_US.Provider.company_suffix
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CompanySuffix}}
Outputs:
SomeObject(id=1, formula_field_example=Inc)
Credit_Card Fakers¶
fake: CreditCardExpire¶
Generate a credit card expiry date.
This method uses |date_time_between| under the hood to generate the
expiry date, so the start
and end
arguments work in the same way
here as it would in that method. For the actual formatting of the expiry
date, |strftime| is used and date_format
is simply passed
to that method.
Aliases: credit_card_expire, creditcardexpire
Source: faker : faker.providers.credit_card.en_US.Provider.credit_card_expire
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CreditCardExpire}}
Outputs:
SomeObject(id=1, formula_field_example=07/28)
fake: CreditCardFull¶
Generate a set of credit card details.
Aliases: credit_card_full, creditcardfull
Source: faker : faker.providers.credit_card.en_US.Provider.credit_card_full
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CreditCardFull}}
Outputs:
SomeObject(id=1, formula_field_example=JCB 16 digit
Courtney Odonnell
3597535139332876 03/25
CVC: 587
)
fake: CreditCardNumber¶
Generate a valid credit card number.
Aliases: credit_card_number, creditcardnumber
Source: faker : faker.providers.credit_card.en_US.Provider.credit_card_number
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CreditCardNumber}}
Outputs:
SomeObject(id=1, formula_field_example=348778408016097)
fake: CreditCardProvider¶
Generate a credit card provider name.
Aliases: credit_card_provider, creditcardprovider
Source: faker : faker.providers.credit_card.en_US.Provider.credit_card_provider
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CreditCardProvider}}
Outputs:
SomeObject(id=1, formula_field_example=Maestro)
fake: CreditCardSecurityCode¶
Generate a credit card security code.
Aliases: credit_card_security_code, creditcardsecuritycode
Source: faker : faker.providers.credit_card.en_US.Provider.credit_card_security_code
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CreditCardSecurityCode}}
Outputs:
SomeObject(id=1, formula_field_example=593)
Currency Fakers¶
fake: Cryptocurrency¶
Aliases: cryptocurrency
Source: faker : faker.providers.currency.en_US.Provider.cryptocurrency
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Cryptocurrency}}
Outputs:
SomeObject(id=1, formula_field_example=('BC', 'BlackCoin'))
fake: CryptocurrencyCode¶
Aliases: cryptocurrency_code, cryptocurrencycode
Source: faker : faker.providers.currency.en_US.Provider.cryptocurrency_code
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CryptocurrencyCode}}
Outputs:
SomeObject(id=1, formula_field_example=BC)
fake: CryptocurrencyName¶
Aliases: cryptocurrency_name, cryptocurrencyname
Source: faker : faker.providers.currency.en_US.Provider.cryptocurrency_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CryptocurrencyName}}
Outputs:
SomeObject(id=1, formula_field_example=BlackCoin)
fake: Currency¶
Aliases: currency
Source: faker : faker.providers.currency.en_US.Provider.currency
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Currency}}
Outputs:
SomeObject(id=1, formula_field_example=('BAM', 'Bosnia and Herzegovina convertible mark'))
fake: CurrencyCode¶
Aliases: currency_code, currencycode
Source: faker : faker.providers.currency.en_US.Provider.currency_code
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CurrencyCode}}
Outputs:
SomeObject(id=1, formula_field_example=BAM)
fake: CurrencyName¶
Aliases: currency_name, currencyname
Source: faker : faker.providers.currency.en_US.Provider.currency_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CurrencyName}}
Outputs:
SomeObject(id=1, formula_field_example=Bosnia and Herzegovina convertible mark)
fake: CurrencySymbol¶
Example:: $
Aliases: currency_symbol, currencysymbol
Source: faker : faker.providers.currency.en_US.Provider.currency_symbol
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CurrencySymbol}}
Outputs:
SomeObject(id=1, formula_field_example=KM)
fake: Pricetag¶
Aliases: pricetag
Source: faker : faker.providers.currency.en_US.Provider.pricetag
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pricetag}}
Outputs:
SomeObject(id=1, formula_field_example=$54.21)
Date_Time Fakers¶
fake: AmPm¶
Aliases: am_pm, ampm
Source: faker : faker.providers.date_time.en_US.Provider.am_pm
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.AmPm}}
Outputs:
SomeObject(id=1, formula_field_example=PM)
fake: Century¶
Example:: 'XVII'
Aliases: century
Source: faker : faker.providers.date_time.en_US.Provider.century
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Century}}
Outputs:
SomeObject(id=1, formula_field_example=II)
fake: Date¶
Get a date string between January 1, 1970 and now.
Param: pattern: Format of the date (year-month-day by default)
Example:: '2008-11-27'
Return:: Date
Aliases: date
Source: faker : faker.providers.date_time.en_US.Provider.date
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Date}}
Outputs:
SomeObject(id=1, formula_field_example=1992-10-31)
fake: DateBetween¶
Get a Date object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().
Param: start_date: Defaults to 30 years ago
Param: end_date: Defaults to "today"
Example:: Date('1999-02-02')
Return:: Date
Aliases: date_between, datebetween
Source: faker : faker.providers.date_time.en_US.Provider.date_between
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateBetween}}
Outputs:
SomeObject(id=1, formula_field_example=2006-11-27)
fake: DateBetweenDates¶
Takes two Date objects and returns a random date between the two given dates. Accepts Date or datetime objects
Param: date_start: Date
Param: date_end: Date
Return:: Date
Aliases: date_between_dates, datebetweendates
Source: faker : faker.providers.date_time.en_US.Provider.date_between_dates
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateBetweenDates}}
Outputs:
SomeObject(id=1, formula_field_example=2024-04-16)
fake: DateObject¶
Get a date object between January 1, 1970 and now
Example:: datetime.date(2016, 9, 20)
Aliases: date_object, dateobject
Source: faker : faker.providers.date_time.en_US.Provider.date_object
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateObject}}
Outputs:
SomeObject(id=1, formula_field_example=1992-10-31)
fake: DateOfBirth¶
Generate a random date of birth represented as a Date object, constrained by optional miminimum_age and maximum_age parameters.
Param: tzinfo: Defaults to None.
Param: minimum_age: Defaults to 0.
Param: maximum_age: Defaults to 115.
Example:: Date('1979-02-02')
Return:: Date
Aliases: date_of_birth, dateofbirth
Source: faker : faker.providers.date_time.en_US.Provider.date_of_birth
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateOfBirth}}
Outputs:
SomeObject(id=1, formula_field_example=1957-01-28)
fake: DateThisCentury¶
Gets a Date object for the current century.
Param: before_today: include days in current century before today
Param: after_today: include days in current century after today
Example:: Date('2012-04-04')
Return:: Date
Aliases: date_this_century, datethiscentury
Source: faker : faker.providers.date_time.en_US.Provider.date_this_century
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateThisCentury}}
Outputs:
SomeObject(id=1, formula_field_example=2010-03-20)
fake: DateThisDecade¶
Gets a Date object for the decade year.
Param: before_today: include days in current decade before today
Param: after_today: include days in current decade after today
Example:: Date('2012-04-04')
Return:: Date
Aliases: date_this_decade, datethisdecade
Source: faker : faker.providers.date_time.en_US.Provider.date_this_decade
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateThisDecade}}
Outputs:
SomeObject(id=1, formula_field_example=2021-10-21)
fake: DateThisMonth¶
Gets a Date object for the current month.
Param: before_today: include days in current month before today
Param: after_today: include days in current month after today
Example:: dtdate('2012-04-04')
Return:: dtdate
Aliases: date_this_month, datethismonth
Source: faker : faker.providers.date_time.en_US.Provider.date_this_month
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateThisMonth}}
Outputs:
SomeObject(id=1, formula_field_example=2024-04-07)
fake: DateThisYear¶
Gets a Date object for the current year.
Param: before_today: include days in current year before today
Param: after_today: include days in current year after today
Example:: Date('2012-04-04')
Return:: Date
Aliases: date_this_year, datethisyear
Source: faker : faker.providers.date_time.en_US.Provider.date_this_year
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DateThisYear}}
Outputs:
SomeObject(id=1, formula_field_example=2024-02-14)
fake: DayOfMonth¶
Aliases: day_of_month, dayofmonth
Source: faker : faker.providers.date_time.en_US.Provider.day_of_month
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DayOfMonth}}
Outputs:
SomeObject(id=1, formula_field_example=31)
fake: DayOfWeek¶
Aliases: day_of_week, dayofweek
Source: faker : faker.providers.date_time.en_US.Provider.day_of_week
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DayOfWeek}}
Outputs:
SomeObject(id=1, formula_field_example=Saturday)
fake: FutureDate¶
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().
Param: end_date: Defaults to "+30d"
Param: tzinfo: timezone, instance of datetime.tzinfo subclass
Example:: dtdate('2030-01-01')
Return:: dtdate
Aliases: future_date, futuredate
Source: faker : faker.providers.date_time.en_US.Provider.future_date
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FutureDate}}
Outputs:
SomeObject(id=1, formula_field_example=2024-04-29)
fake: Month¶
Aliases: month
Source: faker : faker.providers.date_time.en_US.Provider.month
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Month}}
Outputs:
SomeObject(id=1, formula_field_example=10)
fake: MonthName¶
Aliases: month_name, monthname
Source: faker : faker.providers.date_time.en_US.Provider.month_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MonthName}}
Outputs:
SomeObject(id=1, formula_field_example=October)
fake: PastDate¶
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().
Param: start_date: Defaults to "-30d"
Param: tzinfo: timezone, instance of datetime.tzinfo subclass
Example:: dtdate('1999-02-02')
Return:: dtdate
Aliases: past_date, pastdate
Source: faker : faker.providers.date_time.en_US.Provider.past_date
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PastDate}}
Outputs:
SomeObject(id=1, formula_field_example=2024-03-29)
fake: PastDatetime¶
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().
Param: start_date: Defaults to "-30d"
Param: tzinfo: timezone, instance of datetime.tzinfo subclass
Example:: datetime('1999-02-02 11:42:52')
Return:: datetime
Aliases: past_datetime, pastdatetime
Source: faker : faker.providers.date_time.en_US.Provider.past_datetime
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PastDatetime}}
Outputs:
SomeObject(id=1, formula_field_example=2024-03-30 14:04:20.116942)
fake: Pytimezone¶
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()
Return:: dateutil.tz.tz.tzfile
Aliases: pytimezone
Source: faker : faker.providers.date_time.en_US.Provider.pytimezone
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pytimezone}}
Outputs:
SomeObject(id=1, formula_field_example=tzfile('/usr/share/zoneinfo/Europe/Stockholm'))
fake: TimeDelta¶
Get a timedelta object
Aliases: time_delta, timedelta
Source: faker : faker.providers.date_time.en_US.Provider.time_delta
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.TimeDelta}}
Outputs:
SomeObject(id=1, formula_field_example=0:00:00)
fake: TimeObject¶
Get a time object
Example:: datetime.time(15, 56, 56, 772876)
Aliases: time_object, timeobject
Source: faker : faker.providers.date_time.en_US.Provider.time_object
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.TimeObject}}
Outputs:
SomeObject(id=1, formula_field_example=22:06:57.155480)
fake: TimeSeries¶
Returns a generator yielding tuples of (<datetime>, <value>)
.
The data points will start at start_date
, and be at every time interval specified by
precision
.
distrib
is a callable that accepts <datetime>
and returns <value>
Aliases: time_series, timeseries
Source: faker : faker.providers.date_time.en_US.Provider.time_series
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.TimeSeries}}
Outputs:
SomeObject(id=1, formula_field_example=<generator object Provider.time_series at 0x7f6f93fd67a0>)
fake: Timezone¶
Aliases: timezone
Source: faker : faker.providers.date_time.en_US.Provider.timezone
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Timezone}}
Outputs:
SomeObject(id=1, formula_field_example=Europe/Stockholm)
fake: UnixTime¶
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
Aliases: unix_time, unixtime
Source: faker : faker.providers.date_time.en_US.Provider.unix_time
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UnixTime}}
Outputs:
SomeObject(id=1, formula_field_example=720569217.1554801)
Decorators.Py Fakers¶
fake: AsciiCompanyEmail¶
Aliases: ascii_company_email, asciicompanyemail
Source: faker : faker.providers.internet.en_US.Provider.ascii_company_email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.AsciiCompanyEmail}}
Outputs:
SomeObject(id=1, formula_field_example=kerrivasquez@snyder-frost.com)
fake: AsciiEmail¶
Aliases: ascii_email, asciiemail
Source: faker : faker.providers.internet.en_US.Provider.ascii_email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.AsciiEmail}}
Outputs:
SomeObject(id=1, formula_field_example=patricia38@gmail.com)
fake: AsciiFreeEmail¶
Aliases: ascii_free_email, asciifreeemail
Source: faker : faker.providers.internet.en_US.Provider.ascii_free_email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.AsciiFreeEmail}}
Outputs:
SomeObject(id=1, formula_field_example=lcortez@gmail.com)
fake: AsciiSafeEmail¶
Aliases: ascii_safe_email, asciisafeemail
Source: faker : faker.providers.internet.en_US.Provider.ascii_safe_email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.AsciiSafeEmail}}
Outputs:
SomeObject(id=1, formula_field_example=lcortez@example.org)
fake: CompanyEmail¶
Aliases: company_email, companyemail
Source: faker : faker.providers.internet.en_US.Provider.company_email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CompanyEmail}}
Outputs:
SomeObject(id=1, formula_field_example=kerrivasquez@snyder-frost.com)
fake: DomainName¶
Produce an Internet domain name with the specified number of subdomain levels.
domain_name() nichols-phillips.com domain_name(2) williamson-hopkins.jackson.com
Aliases: domain_name, domainname
Source: faker : faker.providers.internet.en_US.Provider.domain_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DomainName}}
Outputs:
SomeObject(id=1, formula_field_example=hendrix-mayer.com)
fake: DomainWord¶
Aliases: domain_word, domainword
Source: faker : faker.providers.internet.en_US.Provider.domain_word
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.DomainWord}}
Outputs:
SomeObject(id=1, formula_field_example=pham)
fake: FreeEmail¶
Aliases: free_email, freeemail
Source: faker : faker.providers.internet.en_US.Provider.free_email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FreeEmail}}
Outputs:
SomeObject(id=1, formula_field_example=lcortez@gmail.com)
fake: FreeEmailDomain¶
Aliases: free_email_domain, freeemaildomain
Source: faker : faker.providers.internet.en_US.Provider.free_email_domain
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FreeEmailDomain}}
Outputs:
SomeObject(id=1, formula_field_example=gmail.com)
fake: Hostname¶
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
Aliases: hostname
Source: faker : faker.providers.internet.en_US.Provider.hostname
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Hostname}}
Outputs:
SomeObject(id=1, formula_field_example=lt-24.frost.org)
fake: SafeDomainName¶
Aliases: safe_domain_name, safedomainname
Source: faker : faker.providers.internet.en_US.Provider.safe_domain_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SafeDomainName}}
Outputs:
SomeObject(id=1, formula_field_example=example.org)
fake: SafeEmail¶
Aliases: safe_email, safeemail
Source: faker : faker.providers.internet.en_US.Provider.safe_email
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SafeEmail}}
Outputs:
SomeObject(id=1, formula_field_example=lcortez@example.org)
fake: Slug¶
Django algorithm
Aliases: slug
Source: faker : faker.providers.internet.en_US.Provider.slug
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Slug}}
Outputs:
SomeObject(id=1, formula_field_example=necessitatibus)
Emoji Fakers¶
fake: Emoji¶
Example:: '😉'
Aliases: emoji
Source: faker : faker.providers.emoji.Provider.emoji
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Emoji}}
Outputs:
SomeObject(id=1, formula_field_example=⏮️)
File Fakers¶
fake: FileExtension¶
Generate a file extension under the specified category
.
If category
is None
, a random category will be used. The list of
valid categories include: 'audio'
, 'image'
, 'office'
,
'text'
, and 'video'
.
Aliases: file_extension, fileextension
Source: faker : faker.providers.file.Provider.file_extension
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FileExtension}}
Outputs:
SomeObject(id=1, formula_field_example=webm)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FileExtension(category='image')}}
Outputs:
SomeObject(id=1, formula_field_example=jpg)
fake: FileName¶
Generate a random file name with extension.
If extension
is None
, a random extension will be created
under the hood using |file_extension| with the specified
category
. If a value for extension
is provided, the
value will be used instead, and category
will be ignored.
The actual name part itself is generated using |word|. If
extension is an empty string then no extension will be added,
and file_name will be the same as |word|.
Aliases: file_name, filename
Source: faker : faker.providers.file.Provider.file_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FileName(category='audio')}}
Outputs:
SomeObject(id=1, formula_field_example=placeat.wav)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FileName(extension='abcdef')}}
Outputs:
SomeObject(id=1, formula_field_example=perferendis.abcdef)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FileName(category='audio', extension='abcdef')}}
Outputs:
SomeObject(id=1, formula_field_example=esse.abcdef)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FileName(extension='')}}
Outputs:
SomeObject(id=1, formula_field_example=id)
fake: FilePath¶
Generate an pathname to a file.
This method uses |file_name| under the hood to generate the file
name itself, and depth
controls the depth of the directory
path, and |word| is used under the hood to generate the
different directory names.
If absolute
is True
(default), the generated path starts
with /
and is absolute. Otherwise, the generated path is
relative.
If used, extension
can be either a string, forcing that
extension, a sequence of strings (one will be picked at random),
or an empty sequence (the path will have no extension). Default
behaviour is the same as |file_name|
if file_system
is set (default="linux"), the generated path uses
specified file system path standard, the list of valid file systems include:
'windows'
, 'linux'
.
Aliases: file_path, filepath
Source: faker : faker.providers.file.Provider.file_path
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(depth=3)}}
Outputs:
SomeObject(id=1, formula_field_example=/sit/consequatur/deserunt/id.avi)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(depth=5, category='video')}}
Outputs:
SomeObject(id=1, formula_field_example=/perferendis/quod/enim/tempore/similique/ipsam.webm)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(depth=5, category='video', extension='abcdef')}}
Outputs:
SomeObject(id=1, formula_field_example=/voluptatibus/itaque/exercitationem/iusto/possimus/similique.abcdef)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(extension=[])}}
Outputs:
SomeObject(id=1, formula_field_example=/eaque/at)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(extension='')}}
Outputs:
SomeObject(id=1, formula_field_example=/occaecati/quisquam)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(extension=["a", "bc", "def"])}}
Outputs:
SomeObject(id=1, formula_field_example=/ipsum/beatae.a)
fake: MimeType¶
Generate a mime type under the specified category
.
If category
is None
, a random category will be used. The list of
valid categories include 'application'
, 'audio'
, 'image'
,
'message'
, 'model'
, 'multipart'
, 'text'
, and
'video'
.
Aliases: mime_type, mimetype
Source: faker : faker.providers.file.Provider.mime_type
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MimeType}}
Outputs:
SomeObject(id=1, formula_field_example=video/x-ms-wmv)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MimeType(category='application')}}
Outputs:
SomeObject(id=1, formula_field_example=application/rss+xml)
fake: UnixDevice¶
Generate a Unix device file name.
If prefix
is None
, a random prefix will be used. The list of
valid prefixes include: 'sd'
, 'vd'
, and 'xvd'
.
Aliases: unix_device, unixdevice
Source: faker : faker.providers.file.Provider.unix_device
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UnixDevice}}
Outputs:
SomeObject(id=1, formula_field_example=/dev/vdq)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UnixDevice(prefix='mmcblk')}}
Outputs:
SomeObject(id=1, formula_field_example=/dev/mmcblkz)
fake: UnixPartition¶
Generate a Unix partition name.
This method uses |unix_device| under the hood to create a device file
name with the specified prefix
.
Aliases: unix_partition, unixpartition
Source: faker : faker.providers.file.Provider.unix_partition
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UnixPartition}}
Outputs:
SomeObject(id=1, formula_field_example=/dev/vdm4)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UnixPartition(prefix='mmcblk')}}
Outputs:
SomeObject(id=1, formula_field_example=/dev/mmcblkq2)
Geo Fakers¶
fake: Coordinate¶
Optionally center the coord and pick a point within radius.
Aliases: coordinate
Source: faker : faker.providers.geo.en_US.Provider.coordinate
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Coordinate}}
Outputs:
SomeObject(id=1, formula_field_example=-158.265114)
fake: Latitude¶
Aliases: latitude
Source: faker : faker.providers.geo.en_US.Provider.latitude
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Latitude}}
Outputs:
SomeObject(id=1, formula_field_example=-79.132557)
fake: Latlng¶
Aliases: latlng
Source: faker : faker.providers.geo.en_US.Provider.latlng
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Latlng}}
Outputs:
SomeObject(id=1, formula_field_example=(Decimal('47.244262'), Decimal('80.880444')))
fake: LocalLatlng¶
Returns a location known to exist on land in a country specified by country_code
.
Defaults to 'en_US'. See the land_coords
list for available locations/countries.
Aliases: local_latlng, locallatlng
Source: faker : faker.providers.geo.en_US.Provider.local_latlng
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalLatlng}}
Outputs:
SomeObject(id=1, formula_field_example=('30.17746', '-81.38758', 'Palm Valley', 'US', 'America/New_York'))
fake: LocationOnLand¶
Returns a random tuple specifying a coordinate set guaranteed to exist on land.
Format is (latitude, longitude, place name, two-letter country code, timezone)
Pass coords_only
to return coordinates without metadata.
Aliases: location_on_land, locationonland
Source: faker : faker.providers.geo.en_US.Provider.location_on_land
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LocationOnLand}}
Outputs:
SomeObject(id=1, formula_field_example=('-7.60361', '37.00438', 'Kidodi', 'TZ', 'Africa/Dar_es_Salaam'))
fake: Longitude¶
Aliases: longitude
Source: faker : faker.providers.geo.en_US.Provider.longitude
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Longitude}}
Outputs:
SomeObject(id=1, formula_field_example=-158.265114)
Internet Fakers¶
fake: Dga¶
Generates a domain name by given date https://en.wikipedia.org/wiki/Domain_generation_algorithm
:type year: int :type month: int :type day: int :type tld: str :type length: int :rtype: str
Aliases: dga
Source: faker : faker.providers.internet.en_US.Provider.dga
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Dga}}
Outputs:
SomeObject(id=1, formula_field_example=iiulfpgbvqcdaehnqkbxmaqgkykorlxnwy.com)
fake: HttpMethod¶
Returns random HTTP method https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
:rtype: str
Aliases: http_method, httpmethod
Source: faker : faker.providers.internet.en_US.Provider.http_method
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.HttpMethod}}
Outputs:
SomeObject(id=1, formula_field_example=GET)
fake: HttpStatusCode¶
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
Return:: a random three digit status code :rtype: int
Example:: 404
Aliases: http_status_code, httpstatuscode
Source: faker : faker.providers.internet.en_US.Provider.http_status_code
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.HttpStatusCode}}
Outputs:
SomeObject(id=1, formula_field_example=488)
fake: IanaId¶
Returns IANA Registrar ID https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml
:rtype: str
Aliases: iana_id, ianaid
Source: faker : faker.providers.internet.en_US.Provider.iana_id
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.IanaId}}
Outputs:
SomeObject(id=1, formula_field_example=679216)
fake: ImageUrl¶
Returns URL to placeholder image Example: http://placehold.it/640x480
Param: width: Optional image width
Param: height: Optional image height
Param: 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}
.
:rtype: str
Aliases: image_url, imageurl
Source: faker : faker.providers.internet.en_US.Provider.image_url
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.ImageUrl}}
Outputs:
SomeObject(id=1, formula_field_example=https://dummyimage.com/621x976)
fake: Ipv4¶
Returns a random IPv4 address or network with a valid CIDR.
Param: network: Network address
Param: address_class: IPv4 address class (a, b, or c)
Param: private: Public or private
Return:s: IPv4
Aliases: ipv4
Source: faker : faker.providers.internet.en_US.Provider.ipv4
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ipv4}}
Outputs:
SomeObject(id=1, formula_field_example=51.105.121.194)
fake: Ipv4NetworkClass¶
Returns a IPv4 network class 'a', 'b' or 'c'.
Return:s: IPv4 network class
Aliases: ipv4_network_class, ipv4networkclass
Source: faker : faker.providers.internet.en_US.Provider.ipv4_network_class
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ipv4NetworkClass}}
Outputs:
SomeObject(id=1, formula_field_example=a)
fake: Ipv4Private¶
Returns a private IPv4.
Param: network: Network address
Param: address_class: IPv4 address class (a, b, or c)
Return:s: Private IPv4
Aliases: ipv4_private, ipv4private
Source: faker : faker.providers.internet.en_US.Provider.ipv4_private
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ipv4Private}}
Outputs:
SomeObject(id=1, formula_field_example=172.25.180.188)
fake: Ipv4Public¶
Returns a public IPv4 excluding private blocks.
Param: network: Network address
Param: address_class: IPv4 address class (a, b, or c)
Return:s: Public IPv4
Aliases: ipv4_public, ipv4public
Source: faker : faker.providers.internet.en_US.Provider.ipv4_public
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ipv4Public}}
Outputs:
SomeObject(id=1, formula_field_example=168.155.75.206)
fake: Ipv6¶
Produce a random IPv6 address or network with a valid CIDR
Aliases: ipv6
Source: faker : faker.providers.internet.en_US.Provider.ipv6
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ipv6}}
Outputs:
SomeObject(id=1, formula_field_example=eb11:67b3:67a9:c378:7c65:c1e6:82e2:e662)
fake: MacAddress¶
Returns a random MAC address.
Param: multicast: Multicast address
Return:s: MAC Address
Aliases: mac_address, macaddress
Source: faker : faker.providers.internet.en_US.Provider.mac_address
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MacAddress}}
Outputs:
SomeObject(id=1, formula_field_example=18:47:30:80:4b:9e)
fake: NicHandle¶
Returns NIC Handle ID https://www.apnic.net/manage-ip/using-whois/guide/person/
:rtype: str
Aliases: nic_handle, nichandle
Source: faker : faker.providers.internet.en_US.Provider.nic_handle
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.NicHandle}}
Outputs:
SomeObject(id=1, formula_field_example=UE59352-FAKE)
fake: NicHandles¶
Returns NIC Handle ID list
:rtype: list[str]
Aliases: nic_handles, nichandles
Source: faker : faker.providers.internet.en_US.Provider.nic_handles
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.NicHandles}}
Outputs:
SomeObject(id=1, formula_field_example=['UERV52-EJGW'])
fake: PortNumber¶
Returns a network port number https://tools.ietf.org/html/rfc6335
Param: is_system: System or well-known ports
Param: is_user: User or registered ports
Param: is_dynamic: Dynamic / private / ephemeral ports :rtype: int
Aliases: port_number, portnumber
Source: faker : faker.providers.internet.en_US.Provider.port_number
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PortNumber}}
Outputs:
SomeObject(id=1, formula_field_example=5306)
fake: RipeId¶
Returns RIPE Organization ID https://www.ripe.net/manage-ips-and-asns/db/support/organisation-object-in-the-ripe-database
:rtype: str
Aliases: ripe_id, ripeid
Source: faker : faker.providers.internet.en_US.Provider.ripe_id
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RipeId}}
Outputs:
SomeObject(id=1, formula_field_example=ORG-UE59352-RIPE)
fake: Tld¶
Aliases: tld
Source: faker : faker.providers.internet.en_US.Provider.tld
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Tld}}
Outputs:
SomeObject(id=1, formula_field_example=com)
fake: Uri¶
Param: 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".
Param: deep: an integer specifying how many path components the URI should have..
Return:: a random url string.
Aliases: uri
Source: faker : faker.providers.internet.en_US.Provider.uri
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Uri}}
Outputs:
SomeObject(id=1, formula_field_example=http://randall-patterson.com/explorehome.php)
fake: UriExtension¶
Aliases: uri_extension, uriextension
Source: faker : faker.providers.internet.en_US.Provider.uri_extension
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UriExtension}}
Outputs:
SomeObject(id=1, formula_field_example=.html)
fake: UriPage¶
Aliases: uri_page, uripage
Source: faker : faker.providers.internet.en_US.Provider.uri_page
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UriPage}}
Outputs:
SomeObject(id=1, formula_field_example=privacy)
fake: UriPath¶
Aliases: uri_path, uripath
Source: faker : faker.providers.internet.en_US.Provider.uri_path
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UriPath}}
Outputs:
SomeObject(id=1, formula_field_example=explore/category)
fake: Url¶
Param: 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".
Return:: a random url string.
Aliases: url
Source: faker : faker.providers.internet.en_US.Provider.url
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Url}}
Outputs:
SomeObject(id=1, formula_field_example=http://frost.org/)
Isbn Fakers¶
fake: Isbn10¶
Aliases: isbn10
Source: faker : faker.providers.isbn.Provider.isbn10
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Isbn10}}
Outputs:
SomeObject(id=1, formula_field_example=0-15-781565-X)
fake: Isbn13¶
Aliases: isbn13
Source: faker : faker.providers.isbn.Provider.isbn13
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Isbn13}}
Outputs:
SomeObject(id=1, formula_field_example=978-0-15-781565-8)
Job Fakers¶
fake: Job¶
Aliases: job
Source: faker : faker.providers.job.en_US.Provider.job
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Job}}
Outputs:
SomeObject(id=1, formula_field_example=Architect)
Lorem Fakers¶
fake: Paragraphs¶
Generate a list of paragraphs.
This method uses |paragraph| under the hood to generate paragraphs, and
the nb
argument controls exactly how many sentences the list will
contain. The ext_word_list
argument works in exactly the same way
as well.
Aliases: paragraphs
Source: faker : faker.providers.lorem.la.Provider.paragraphs
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Paragraphs}}
Outputs:
SomeObject(id=1, formula_field_example=['Nobis asperiores commodi deleniti rerum blanditiis at. Alias accusantium vero delectus. Laboriosam quas aperiam perspiciatis.', 'Nulla saepe architecto asperiores error ipsa. Magnam aliquam aut voluptates. Ea temporibus iusto temporibus necessitatibus.', 'Ratione culpa cum minus. Nisi ipsam cupiditate iusto.'])
fake: Sentences¶
Generate a list of sentences.
This method uses |sentence| under the hood to generate sentences, and
the nb
argument controls exactly how many sentences the list will
contain. The ext_word_list
argument works in exactly the same way
as well.
Aliases: sentences
Source: faker : faker.providers.lorem.la.Provider.sentences
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Sentences}}
Outputs:
SomeObject(id=1, formula_field_example=['Sit necessitatibus quo quae cumque aperiam.', 'Ipsum suscipit tenetur nobis.', 'Sunt libero est.'])
fake: Texts¶
Generate a list of text strings.
The nb_texts
argument controls how many text strings the list will
contain, and this method uses |text| under the hood for text generation,
so the two remaining arguments, max_nb_chars
and ext_word_list
will work in exactly the same way as well.
ext_word_list=['abc', 'def', 'ghi', 'jkl']
Aliases: texts
Source: faker : faker.providers.lorem.la.Provider.texts
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Texts}}
Outputs:
SomeObject(id=1, formula_field_example=['Vero temporibus aliquam ducimus. Velit pariatur nemo. Dolorem quod suscipit occaecati magnam. In esse beatae incidunt necessitatibus ullam vel.', 'Architecto tempora dignissimos dignissimos perferendis vel. Quibusdam eos porro ut.\nDeleniti beatae exercitationem vero. Adipisci dignissimos ex vero.', 'In aliquid consequatur accusantium aspernatur asperiores. Error impedit unde nihil error explicabo.\nOdio odio minus fugiat ab vitae. Ipsam fuga veritatis at delectus autem.'])
fake: Words¶
Generate a tuple of words.
The nb
argument controls the number of words in the resulting list,
and if ext_word_list
is provided, words from that list will be used
instead of those from the locale provider's built-in word list.
If unique
is True
, this method will return a list containing
unique words. Under the hood, |random_sample| will be used for sampling
without replacement. If unique
is False
, |random_choices| is
used instead, and the list returned may contain duplicates.
part_of_speech
is a parameter that defines to what part of speech
the returned word belongs. If ext_word_list
is not None
, then
part_of_speech
is ignored. If the value of part_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 large nb
can
exhaust said lists if unique
is True
, raising an exception.
Aliases: words
Source: faker : faker.providers.lorem.la.Provider.words
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Words}}
Outputs:
SomeObject(id=1, formula_field_example=['error', 'non', 'incidunt'])
Misc Fakers¶
fake: Binary¶
Generate a random binary blob of length
bytes.
If this faker instance has been seeded, performance will be signficiantly reduced, to conform to the seeding.
Aliases: binary
Source: faker : faker.providers.misc.en_US.Provider.binary
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Binary(length=64)}}
Outputs:
SomeObject(id=1, formula_field_example=b'\xdf\\\x1f\xef\x143\xc8f\x85\xb7\xf0Vh\x1dQR\xaf\x80<\xe2Y\x06\xf1\xd1\x9f\xb6\xc6\x80N\x06\xea(\xab\x17\x8fEz\xf6\xb4\x93\xb7C\x9e\xc6\xd4)\x00b\xabQzr\xe5\xc1\xd4\x10\xcd\xd6\x17T\xe4 \x84P')
fake: Boolean¶
Generate a random boolean value based on chance_of_getting_true
.
Aliases: boolean
Source: faker : faker.providers.misc.en_US.Provider.boolean
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Boolean(chance_of_getting_true=25)}}
Outputs:
SomeObject(id=1, formula_field_example=False)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Boolean(chance_of_getting_true=50)}}
Outputs:
SomeObject(id=1, formula_field_example=False)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Boolean(chance_of_getting_true=75)}}
Outputs:
SomeObject(id=1, formula_field_example=True)
fake: Csv¶
Generate random comma-separated values.
For more information on the different arguments of this method, please refer to
:meth:dsv() <faker.providers.misc.Provider.dsv>
which is used under the hood.
data_columns=('{{name}}', '{{address}}', '{{safe_color_name}}'), num_rows=10, include_row_ids=True
Aliases: csv
Source: faker : faker.providers.misc.en_US.Provider.csv
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Csv(data_columns=('{{name}}', '{{address}}'), num_rows=10,
include_row_ids=False)}}
Outputs:
SomeObject(id=1, formula_field_example="Krystal Ramirez PhD","Unit 6475 Box 9382
DPO AA 18817"
"Dr. Ruben Escobar","PSC 4115, Box 7815
APO AA 41945"
"Dr. Max Hanna DVM","USS Raymond
FPO AP 02341"
"Dr. Xavier Johnson","Unit 5351 Box 3933
DPO AE 71671"
"Mrs. Bethany Vazquez DVM","418 Meza Plains Apt. 989
Haleyland, PA 50950"
"Ms. Jade Spencer","PSC 2094, Box 7112
APO AE 05565"
"Dr. Ronald Valdez","PSC 3969, Box 4775
APO AE 43010"
"Dr. Tom Sawyer","USNS Howell
FPO AE 96378"
"Candice Escobar","PSC 5256, Box 0123
APO AE 75718"
"Mr. Corey Walter","PSC 9916, Box 1510
APO AP 03336"
)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Csv(header=('Name', 'Address', 'Favorite Color'),
data_columns=('{{name}}', '{{address}}', '{{safe_color_name}}'), num_rows=10,
include_row_ids=True)}}
Outputs:
SomeObject(id=1, formula_field_example="ID","Name","Address","Favorite Color"
"1","Mr. Corey Yates IV","691 Cox Forges
Lake Tylerstad, NE 24135","black"
"2","Mrs. Sabrina Patterson DVM","PSC 4579, Box 2302
APO AE 45368","blue"
"3","Carla Trevino","Unit 2076 Box 9845
DPO AA 86696","olive"
"4","Steve Mccullough Jr.","Unit 1508 Box 4237
DPO AA 80472","olive"
"5","Ms. Valerie Vega","Unit 6109 Box 3523
DPO AE 84046","lime"
"6","Tracie Donaldson DVM","960 Hannah Circles Suite 278
Irwinside, PA 99523","black"
"7","Randall Dominguez","USCGC Collins
FPO AA 25142","blue"
"8","Mr. Alex Christensen","Unit 5030 Box 0891
DPO AE 16085","silver"
"9","Dr. Hunter Lam III","1047 Ricky Dale Suite 124
North Calvinborough, TX 34536","blue"
"10","Miss Priscilla Krause","765 Luke Lane Suite 022
Andreamouth, WY 48630","yellow"
)
fake: Dsv¶
Generate random delimiter-separated values.
This method's behavior share some similarities with csv.writer
. The dialect
and
**fmtparams
arguments are the same arguments expected by csv.writer
to control its
behavior, and instead of expecting a file-like object to where output will be written, the
output is controlled by additional keyword arguments and is returned as a string.
The dialect
argument defaults to 'faker-csv'
which is the name of a csv.excel
subclass with full quoting enabled.
The header
argument expects a list or a tuple of strings that will serve as the header row
if supplied. The data_columns
argument expects a list or a tuple of string tokens, and these
string tokens will be passed to :meth:pystr_format() <faker.providers.python.Provider.pystr_format>
for data generation. Argument Groups are used to pass arguments to the provider methods.
Both header
and data_columns
must be of the same length.
Example: fake.set_arguments('top_half', {'min_value': 50, 'max_value': 100}) fake.dsv(data_columns=('{{ name }}', '{{ pyint:top_half }}'))
The num_rows
argument controls how many rows of data to generate, and the include_row_ids
argument may be set to True
to include a sequential row ID column.
Aliases: dsv
Source: faker : faker.providers.misc.en_US.Provider.dsv
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Dsv(dialect='excel', data_columns=('{{name}}',
'{{address}}'))}}
Outputs:
SomeObject(id=1, formula_field_example=Krystal Ramirez PhD,"Unit 6475 Box 9382
DPO AA 18817"
Dr. Ruben Escobar,"PSC 4115, Box 7815
APO AA 41945"
Dr. Max Hanna DVM,"USS Raymond
FPO AP 02341"
Dr. Xavier Johnson,"Unit 5351 Box 3933
DPO AE 71671"
Mrs. Bethany Vazquez DVM,"418 Meza Plains Apt. 989
Haleyland, PA 50950"
Ms. Jade Spencer,"PSC 2094, Box 7112
APO AE 05565"
Dr. Ronald Valdez,"PSC 3969, Box 4775
APO AE 43010"
Dr. Tom Sawyer,"USNS Howell
FPO AE 96378"
Candice Escobar,"PSC 5256, Box 0123
APO AE 75718"
Mr. Corey Walter,"PSC 9916, Box 1510
APO AP 03336"
)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Dsv(dialect='excel-tab', data_columns=('{{name}}',
'{{address}}'), include_row_ids=True)}}
Outputs:
SomeObject(id=1, formula_field_example=1 Mr. Corey Yates IV "691 Cox Forges
Lake Tylerstad, NE 24135"
2 Reginald Moody "634 Levine Street
Sosashire, GA 91949"
3 Mr. Dave Rubio III "USNV Ellis
FPO AP 58475"
4 Alejandro Leon DDS "USNV Figueroa
FPO AP 33391"
5 Steve Mccullough Jr. "Unit 1508 Box 4237
DPO AA 80472"
6 Tabitha Le "PSC 4661, Box 0935
APO AE 31881"
7 Dr. Kevin Odonnell DDS "960 Hannah Circles Suite 278
Irwinside, PA 99523"
8 Arthur Roman "USNV Moses
FPO AA 07035"
9 Darlene Conley MD "PSC 0665, Box 0300
APO AP 69752"
10 Mr. Collin Shields "PSC 4421, Box 7610
APO AA 59873"
)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Dsv(data_columns=('{{name}}', '{{address}}'), num_rows=5,
delimiter='$')}}
Outputs:
SomeObject(id=1, formula_field_example="Dr. Dakota Wilkerson"$"USS Rasmussen
FPO AE 36992"
"Barry Ramirez"$"PSC 4855, Box 9097
APO AP 84930"
"Dr. Kathryn Rasmussen DDS"$"PSC 6940, Box 2245
APO AA 48630"
"Dr. William Green"$"29456 Tom Crescent Suite 304
Port Lauren, VA 09789"
"Kirsten Blevins"$"USNV Blake
FPO AE 13529"
)
fake: FixedWidth¶
Generate random fixed width values.
Using a list of tuple records that is passed as data_columns
, that
defines the structure that will be generated. Arguments within the
record are provider specific, and should be a dictionary that will be
passed to the provider method.
Data Column List format [('field width', 'definition', {'arguments'})]
The definition can be 'provider', 'provider:argument_group', tokenized 'string {{ provider:argument_group }}' that is passed to the python provider method pystr_format() for generation, or a fixed '@word'. Using Lists, Tuples, and Dicts as a definition for structure.
Argument Groups can be used to pass arguments to the provider methods, but will override the arguments supplied in the tuple record.
Example: fake.set_arguments('top_half', {'min_value': 50, 'max_value': 100}) fake.fixed_width(data_columns=[(20, 'name'), (3, 'pyint:top_half')])
Param: data_columns: specification for the data structure :type data_columns: list
Param: num_rows: number of rows the generator will yield :type num_rows: int
Param: align: positioning of the value. (left, middle, right) :type align: str
Return:: Serialized Fixed Width data :rtype: str
'max_value': 100})], align='right', num_rows=2
Aliases: fixed_width, fixedwidth
Source: faker : faker.providers.misc.en_US.Provider.fixed_width
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.FixedWidth(data_columns=[(20, 'name'), (3, 'pyint',
{'min_value':50, 'max_value':100})], align='right', num_rows=2)}}
Outputs:
SomeObject(id=1, formula_field_example= Krystal Ramirez PhD 82
Dr. Jasmine Bright D 72)
fake: Json¶
Generate random JSON structure values.
Using a dictionary or list of records that is passed as data_columns
,
define the structure that is used to build JSON structures. For complex
data structures it is recommended to use the dictionary format.
Data Column Dictionary format: {'key name': 'definition'}
The definition can be 'provider', 'provider:argument_group', tokenized 'string {{ provider:argument_group }}' that is passed to the python provider method pystr_format() for generation, or a fixed '@word'. Using Lists, Tuples, and Dicts as a definition for structure.
Example: fake.set_arguments('top_half', {'min_value': 50, 'max_value': 100}) fake.json(data_columns={'Name': 'name', 'Score': 'pyint:top_half'})
Data Column List format: [('key name', 'definition', {'arguments'})]
With the list format the definition can be a list of records, to create a list within the structure data. For literal entries within the list, set the 'field_name' to None.
Param: data_columns: specification for the data structure :type data_columns: dict
Param: num_rows: number of rows the returned :type num_rows: int
Param: indent: number of spaces to indent the fields :type indent: int
Param: cls: optional json encoder to use for non-standard objects such as datetimes :type cls: json.JSONEncoder
Return:: Serialized JSON data :rtype: str
'Details': {'Name': 'name', 'Address': 'address'}}, num_rows=2
num_rows=1
{'min_value': 50, 'max_value': 100})], num_rows=1
Aliases: json
Source: faker : faker.providers.misc.en_US.Provider.json
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Json(data_columns={'Spec':'@1.0.1', 'ID':'pyint',
'Details':{'Name':'name', 'Address':'address'}}, num_rows=2)}}
Outputs:
SomeObject(id=1, formula_field_example=[{"Spec": "1.0.1", "ID": 6311, "Details": {"Name": "Andrea Little DVM", "Address": "Unit 4759 Box 3824\nDPO AE 99565"}}, {"Spec": "1.0.1", "ID": 1553, "Details": {"Name": "Morgan Escobar", "Address": "PSC 4115, Box 7815\nAPO AA 41945"}}])
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Json(data_columns={'Candidates':['name', 'name',
'name']}, num_rows=1)}}
Outputs:
SomeObject(id=1, formula_field_example={"Candidates": ["Dr. Max Hanna DVM", "Ariel Raymond", "Chad Buck"]})
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Json(data_columns=[('Name', 'name'), ('Points',
'pyint', {'min_value':50, 'max_value':100})], num_rows=1)}}
Outputs:
SomeObject(id=1, formula_field_example={"Name": "Tracie Tapia MD", "Points": 89})
fake: JsonBytes¶
Generate random JSON structure and return as bytes.
For more information on the different arguments of this method, refer to
:meth:json() <faker.providers.misc.Provider.json>
which is used under the hood.
Aliases: json_bytes, jsonbytes
Source: faker : faker.providers.misc.en_US.Provider.json_bytes
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.JsonBytes}}
Outputs:
SomeObject(id=1, formula_field_example=b'[{"name": "Dr. Dakota Wilkerson", "residency": "USS Rasmussen\\nFPO AE 36992"}, {"name": "Barry Ramirez", "residency": "PSC 4855, Box 9097\\nAPO AP 84930"}, {"name": "Dr. Kathryn Rasmussen DDS", "residency": "PSC 6940, Box 2245\\nAPO AA 48630"}, {"name": "Dr. William Green", "residency": "29456 Tom Crescent Suite 304\\nPort Lauren, VA 09789"}, {"name": "Kirsten Blevins", "residency": "USNV Blake\\nFPO AE 13529"}, {"name": "Dr. Jody Frye PhD", "residency": "76045 Jimmy Road Suite 111\\nLake Max, AR 50939"}, {"name": "Chris Mcgee", "residency": "USCGC Mcgrath\\nFPO AA 77163"}, {"name": "Dr. Cameron Luna IV", "residency": "USNS Hammond\\nFPO AE 47492"}, {"name": "Mr. Andres Rowland", "residency": "Unit 3176 Box 4303\\nDPO AP 19683"}, {"name": "Mr. Nathan Navarro", "residency": "USNS Graham\\nFPO AP 64451"}]')
fake: Md5¶
Generate a random MD5 hash.
If raw_output
is False
(default), a hexadecimal string representation of the MD5 hash
will be returned. If True
, a bytes
object representation will be returned instead.
Aliases: md5
Source: faker : faker.providers.misc.en_US.Provider.md5
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Md5(raw_output=False)}}
Outputs:
SomeObject(id=1, formula_field_example=3e92bfaaa510a799067f34c18e175ab3)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Md5(raw_output=True)}}
Outputs:
SomeObject(id=1, formula_field_example=b'\x0c\xedTD"\xae\x9dt\xb4%u#4Pl\xb5')
fake: NullBoolean¶
Generate None
, True
, or False
, each with equal probability.
Aliases: null_boolean, nullboolean
Source: faker : faker.providers.misc.en_US.Provider.null_boolean
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.NullBoolean}}
Outputs:
SomeObject(id=1, formula_field_example=False)
fake: Password¶
Generate a random password of the specified length
.
The arguments special_chars
, digits
, upper_case
, and lower_case
control
what category of characters will appear in the generated password. If set to True
(default), at least one character from the corresponding category is guaranteed to appear.
Special characters are characters from !@#$%^&*()_+
, digits are characters from
0123456789
, and uppercase and lowercase characters are characters from the ASCII set of
letters.
Aliases: password
Source: faker : faker.providers.misc.en_US.Provider.password
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Password(length=12)}}
Outputs:
SomeObject(id=1, formula_field_example=n0geTt4p&S&z)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Password(length=40, special_chars=False, upper_case=False)}}
Outputs:
SomeObject(id=1, formula_field_example=3z7cqux6oy2ouc9lf6gtkibc09k0qc1a8ycacymm)
fake: Psv¶
Generate random pipe-separated values.
For more information on the different arguments of this method, please refer to
:meth:dsv() <faker.providers.misc.Provider.dsv>
which is used under the hood.
data_columns=('{{name}}', '{{address}}', '{{safe_color_name}}'), num_rows=10, include_row_ids=True
Aliases: psv
Source: faker : faker.providers.misc.en_US.Provider.psv
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Psv(data_columns=('{{name}}', '{{address}}'), num_rows=10,
include_row_ids=False)}}
Outputs:
SomeObject(id=1, formula_field_example="Krystal Ramirez PhD"|"Unit 6475 Box 9382
DPO AA 18817"
"Dr. Ruben Escobar"|"PSC 4115, Box 7815
APO AA 41945"
"Dr. Max Hanna DVM"|"USS Raymond
FPO AP 02341"
"Dr. Xavier Johnson"|"Unit 5351 Box 3933
DPO AE 71671"
"Mrs. Bethany Vazquez DVM"|"418 Meza Plains Apt. 989
Haleyland, PA 50950"
"Ms. Jade Spencer"|"PSC 2094, Box 7112
APO AE 05565"
"Dr. Ronald Valdez"|"PSC 3969, Box 4775
APO AE 43010"
"Dr. Tom Sawyer"|"USNS Howell
FPO AE 96378"
"Candice Escobar"|"PSC 5256, Box 0123
APO AE 75718"
"Mr. Corey Walter"|"PSC 9916, Box 1510
APO AP 03336"
)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Psv(header=('Name', 'Address', 'Favorite Color'),
data_columns=('{{name}}', '{{address}}', '{{safe_color_name}}'), num_rows=10,
include_row_ids=True)}}
Outputs:
SomeObject(id=1, formula_field_example="ID"|"Name"|"Address"|"Favorite Color"
"1"|"Mr. Corey Yates IV"|"691 Cox Forges
Lake Tylerstad, NE 24135"|"black"
"2"|"Mrs. Sabrina Patterson DVM"|"PSC 4579, Box 2302
APO AE 45368"|"blue"
"3"|"Carla Trevino"|"Unit 2076 Box 9845
DPO AA 86696"|"olive"
"4"|"Steve Mccullough Jr."|"Unit 1508 Box 4237
DPO AA 80472"|"olive"
"5"|"Ms. Valerie Vega"|"Unit 6109 Box 3523
DPO AE 84046"|"lime"
"6"|"Tracie Donaldson DVM"|"960 Hannah Circles Suite 278
Irwinside, PA 99523"|"black"
"7"|"Randall Dominguez"|"USCGC Collins
FPO AA 25142"|"blue"
"8"|"Mr. Alex Christensen"|"Unit 5030 Box 0891
DPO AE 16085"|"silver"
"9"|"Dr. Hunter Lam III"|"1047 Ricky Dale Suite 124
North Calvinborough, TX 34536"|"blue"
"10"|"Miss Priscilla Krause"|"765 Luke Lane Suite 022
Andreamouth, WY 48630"|"yellow"
)
fake: Sha1¶
Generate a random SHA-1 hash.
If raw_output
is False
(default), a hexadecimal string representation of the SHA-1 hash
will be returned. If True
, a bytes
object representation will be returned instead.
Aliases: sha1
Source: faker : faker.providers.misc.en_US.Provider.sha1
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Sha1(raw_output=False)}}
Outputs:
SomeObject(id=1, formula_field_example=02347357d13590815eb822d13e8366e27cf35e1b)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Sha1(raw_output=True)}}
Outputs:
SomeObject(id=1, formula_field_example=b'\xc6\xb6\x9e\xb0\xfa(\xe2\x08^\xeeG\x9b\xb8\x7f{\xdf\xce\xe2\xe3\xb4')
fake: Tsv¶
Generate random tab-separated values.
For more information on the different arguments of this method, please refer to
:meth:dsv() <faker.providers.misc.Provider.dsv>
which is used under the hood.
data_columns=('{{name}}', '{{address}}', '{{safe_color_name}}'), num_rows=10, include_row_ids=True
Aliases: tsv
Source: faker : faker.providers.misc.en_US.Provider.tsv
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Tsv(data_columns=('{{name}}', '{{address}}'), num_rows=10,
include_row_ids=False)}}
Outputs:
SomeObject(id=1, formula_field_example="Krystal Ramirez PhD" "Unit 6475 Box 9382
DPO AA 18817"
"Dr. Ruben Escobar" "PSC 4115, Box 7815
APO AA 41945"
"Dr. Max Hanna DVM" "USS Raymond
FPO AP 02341"
"Dr. Xavier Johnson" "Unit 5351 Box 3933
DPO AE 71671"
"Mrs. Bethany Vazquez DVM" "418 Meza Plains Apt. 989
Haleyland, PA 50950"
"Ms. Jade Spencer" "PSC 2094, Box 7112
APO AE 05565"
"Dr. Ronald Valdez" "PSC 3969, Box 4775
APO AE 43010"
"Dr. Tom Sawyer" "USNS Howell
FPO AE 96378"
"Candice Escobar" "PSC 5256, Box 0123
APO AE 75718"
"Mr. Corey Walter" "PSC 9916, Box 1510
APO AP 03336"
)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Tsv(header=('Name', 'Address', 'Favorite Color'),
data_columns=('{{name}}', '{{address}}', '{{safe_color_name}}'), num_rows=10,
include_row_ids=True)}}
Outputs:
SomeObject(id=1, formula_field_example="ID" "Name" "Address" "Favorite Color"
"1" "Mr. Corey Yates IV" "691 Cox Forges
Lake Tylerstad, NE 24135" "black"
"2" "Mrs. Sabrina Patterson DVM" "PSC 4579, Box 2302
APO AE 45368" "blue"
"3" "Carla Trevino" "Unit 2076 Box 9845
DPO AA 86696" "olive"
"4" "Steve Mccullough Jr." "Unit 1508 Box 4237
DPO AA 80472" "olive"
"5" "Ms. Valerie Vega" "Unit 6109 Box 3523
DPO AE 84046" "lime"
"6" "Tracie Donaldson DVM" "960 Hannah Circles Suite 278
Irwinside, PA 99523" "black"
"7" "Randall Dominguez" "USCGC Collins
FPO AA 25142" "blue"
"8" "Mr. Alex Christensen" "Unit 5030 Box 0891
DPO AE 16085" "silver"
"9" "Dr. Hunter Lam III" "1047 Ricky Dale Suite 124
North Calvinborough, TX 34536" "blue"
"10" "Miss Priscilla Krause" "765 Luke Lane Suite 022
Andreamouth, WY 48630" "yellow"
)
fake: Uuid4¶
Generate a random UUID4 object and cast it to another type if specified using a callable cast_to
.
By default, cast_to
is set to str
.
May be called with cast_to=None
to return a full-fledged UUID
.
Aliases: uuid4
Source: faker : faker.providers.misc.en_US.Provider.uuid4
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Uuid4}}
Outputs:
SomeObject(id=1, formula_field_example=eb1167b3-67a9-4378-bc65-c1e582e2e662)
Passport Fakers¶
fake: PassportDates¶
Generates a formatted date of birth, issue, and expiration dates. issue and expiration dates are conditioned to fall within U.S. standards of 5 and 10 year expirations
The birthday
argument is a datetime.date object representing a date of birth.
Sources:
-https://travel.state.gov/content/travel/en/passports/passport-help/faqs.html
Aliases: passport_dates, passportdates
Source: faker : faker.providers.passport.en_US.Provider.passport_dates
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportDates}}
Outputs:
SomeObject(id=1, formula_field_example=('16 Apr 2024', '16 Apr 2024', '16 Apr 2029'))
fake: PassportDob¶
Generate a datetime date of birth.
Aliases: passport_dob, passportdob
Source: faker : faker.providers.passport.en_US.Provider.passport_dob
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportDob}}
Outputs:
SomeObject(id=1, formula_field_example=1957-01-28)
fake: PassportFull¶
Generates a formatted sting with US Passport information
Aliases: passport_full, passportfull
Source: faker : faker.providers.passport.en_US.Provider.passport_full
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportFull}}
Outputs:
SomeObject(id=1, formula_field_example=Vincent
Johns
M
21 Dec 1919
21 Aug 2018
21 Aug 2028
R77840801
)
fake: PassportGender¶
Generates a string representing the gender displayed on a passport
Sources:
- https://williamsinstitute.law.ucla.edu/publications/x-gender-markers-passports/
Aliases: passport_gender, passportgender
Source: faker : faker.providers.passport.en_US.Provider.passport_gender
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportGender}}
Outputs:
SomeObject(id=1, formula_field_example=F)
fake: PassportNumber¶
Generate a passport number by replacing tokens to be alphanumeric
Aliases: passport_number, passportnumber
Source: faker : faker.providers.passport.en_US.Provider.passport_number
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportNumber}}
Outputs:
SomeObject(id=1, formula_field_example=J11578156)
fake: PassportOwner¶
Generate a given_name and surname for a passport owner
The gender
argument is the gender marker of a passport owner, which is a one character string
that is either male, female, or non-binary.
Aliases: passport_owner, passportowner
Source: faker : faker.providers.passport.en_US.Provider.passport_owner
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportOwner}}
Outputs:
SomeObject(id=1, formula_field_example=('Roberto', 'Barajas'))
Person Fakers¶
fake: LanguageName¶
Generate a random i18n language name (e.g. English).
Aliases: language_name, languagename
Source: faker : faker.providers.person.en_US.Provider.language_name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LanguageName}}
Outputs:
SomeObject(id=1, formula_field_example=Aymara)
fake: LastNameFemale¶
Aliases: last_name_female, lastnamefemale
Source: faker : faker.providers.person.en_US.Provider.last_name_female
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LastNameFemale}}
Outputs:
SomeObject(id=1, formula_field_example=Mcintosh)
fake: LastNameMale¶
Aliases: last_name_male, lastnamemale
Source: faker : faker.providers.person.en_US.Provider.last_name_male
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LastNameMale}}
Outputs:
SomeObject(id=1, formula_field_example=Mcintosh)
fake: LastNameNonbinary¶
Aliases: last_name_nonbinary, lastnamenonbinary
Source: faker : faker.providers.person.en_US.Provider.last_name_nonbinary
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LastNameNonbinary}}
Outputs:
SomeObject(id=1, formula_field_example=Mcintosh)
fake: Name¶
Example:: 'John Doe'
Aliases: name
Source: faker : faker.providers.person.en_US.Provider.name
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Name}}
Outputs:
SomeObject(id=1, formula_field_example=Ms. Melody Vasquez)
fake: NameFemale¶
Aliases: name_female, namefemale
Source: faker : faker.providers.person.en_US.Provider.name_female
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.NameFemale}}
Outputs:
SomeObject(id=1, formula_field_example=Miss Catherine Frost)
fake: NameMale¶
Aliases: name_male, namemale
Source: faker : faker.providers.person.en_US.Provider.name_male
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.NameMale}}
Outputs:
SomeObject(id=1, formula_field_example=Timothy Beltran IV)
fake: NameNonbinary¶
Aliases: name_nonbinary, namenonbinary
Source: faker : faker.providers.person.en_US.Provider.name_nonbinary
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.NameNonbinary}}
Outputs:
SomeObject(id=1, formula_field_example=Patricia Beltran IV)
fake: Prefix¶
Aliases: prefix
Source: faker : faker.providers.person.en_US.Provider.prefix
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Prefix}}
Outputs:
SomeObject(id=1, formula_field_example=Mr.)
fake: PrefixFemale¶
Aliases: prefix_female, prefixfemale
Source: faker : faker.providers.person.en_US.Provider.prefix_female
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PrefixFemale}}
Outputs:
SomeObject(id=1, formula_field_example=Mrs.)
fake: PrefixMale¶
Aliases: prefix_male, prefixmale
Source: faker : faker.providers.person.en_US.Provider.prefix_male
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PrefixMale}}
Outputs:
SomeObject(id=1, formula_field_example=Mr.)
fake: PrefixNonbinary¶
Aliases: prefix_nonbinary, prefixnonbinary
Source: faker : faker.providers.person.en_US.Provider.prefix_nonbinary
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PrefixNonbinary}}
Outputs:
SomeObject(id=1, formula_field_example=Mx.)
fake: Suffix¶
Aliases: suffix
Source: faker : faker.providers.person.en_US.Provider.suffix
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Suffix}}
Outputs:
SomeObject(id=1, formula_field_example=Jr.)
fake: SuffixFemale¶
Aliases: suffix_female, suffixfemale
Source: faker : faker.providers.person.en_US.Provider.suffix_female
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SuffixFemale}}
Outputs:
SomeObject(id=1, formula_field_example=MD)
fake: SuffixMale¶
Aliases: suffix_male, suffixmale
Source: faker : faker.providers.person.en_US.Provider.suffix_male
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SuffixMale}}
Outputs:
SomeObject(id=1, formula_field_example=Jr.)
fake: SuffixNonbinary¶
Aliases: suffix_nonbinary, suffixnonbinary
Source: faker : faker.providers.person.en_US.Provider.suffix_nonbinary
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SuffixNonbinary}}
Outputs:
SomeObject(id=1, formula_field_example=Jr.)
Phone_Number Fakers¶
fake: BasicPhoneNumber¶
Aliases: basic_phone_number, basicphonenumber
Source: faker : faker.providers.phone_number.en_US.Provider.basic_phone_number
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.BasicPhoneNumber}}
Outputs:
SomeObject(id=1, formula_field_example=5159781565)
fake: CountryCallingCode¶
Aliases: country_calling_code, countrycallingcode
Source: faker : faker.providers.phone_number.en_US.Provider.country_calling_code
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.CountryCallingCode}}
Outputs:
SomeObject(id=1, formula_field_example=+880)
fake: Msisdn¶
https://en.wikipedia.org/wiki/MSISDN
Aliases: msisdn
Source: faker : faker.providers.phone_number.en_US.Provider.msisdn
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Msisdn}}
Outputs:
SomeObject(id=1, formula_field_example=5659387784080)
Profile Fakers¶
fake: Profile¶
Generates a complete profile. If "fields" is not empty, only the fields in the list will be returned
Aliases: profile
Source: faker : faker.providers.profile.Provider.profile
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Profile}}
Outputs:
SomeObject(id=1, formula_field_example={'job': 'Energy manager', 'company': 'Martin Ltd', 'ssn': '278-15-3613', 'residence': 'USNS Haynes\nFPO AA 08652', 'current_location': (Decimal('-62.9933755'), Decimal('-101.424385')), 'blood_group': 'B-', 'website': ['http://www.walter.org/'], 'username': 'roybenjamin', 'name': 'Mrs. Kathleen Finley MD', 'sex': 'F', 'address': 'PSC 2173, Box 0086\nAPO AP 13804', 'mail': 'damon31@hotmail.com', 'birthdate': datetime.date(1943, 3, 19)})
fake: SimpleProfile¶
Generates a basic profile with personal informations
Aliases: simple_profile, simpleprofile
Source: faker : faker.providers.profile.Provider.simple_profile
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.SimpleProfile}}
Outputs:
SomeObject(id=1, formula_field_example={'username': 'philip51', 'name': 'Walter Drake', 'sex': 'M', 'address': 'PSC 9332, Box 8711\nAPO AA 67077', 'mail': 'tramos@hotmail.com', 'birthdate': datetime.date(1942, 1, 21)})
Providers Fakers¶
fake: Bothify¶
Generate a string with each placeholder in text
replaced according to the following rules:
- Number signs ('#') are replaced with a random digit (0 to 9).
- Question marks ('?') are replaced with a random character from
letters
.
By default, letters
contains all ASCII letters, uppercase and lowercase.
Under the hood, this method uses :meth:numerify() <faker.providers.BaseProvider.numerify>
and
and :meth:lexify() <faker.providers.BaseProvider.lexify>
to generate random values for number
signs and question marks respectively.
Aliases: bothify
Source: faker : faker.providers.user_agent.Provider.bothify
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Bothify(letters='ABCDE')}}
Outputs:
SomeObject(id=1, formula_field_example=75 EB)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: '${{fake.Bothify(text=''Product Number: ????-########'')}}'
Outputs:
SomeObject(id=1, formula_field_example=Product Number: afUz-38778408)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: '${{fake.Bothify(text=''Product Number: ????-########'',
letters=''ABCDE'')}}'
Outputs:
SomeObject(id=1, formula_field_example=Product Number: DAED-85839894)
fake: Hexify¶
Generate a string with each circumflex ('^') in text
replaced with a random hexadecimal character.
By default, upper
is set to False. If set to True
, output
will be formatted using uppercase hexadecimal characters.
Aliases: hexify
Source: faker : faker.providers.user_agent.Provider.hexify
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: '${{fake.Hexify(text=''MAC Address: ^^:^^:^^:^^:^^:^^'')}}'
Outputs:
SomeObject(id=1, formula_field_example=MAC Address: a6:fe:81:02:c0:fa)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: '${{fake.Hexify(text=''MAC Address: ^^:^^:^^:^^:^^:^^'',
upper=True)}}'
Outputs:
SomeObject(id=1, formula_field_example=MAC Address: 95:65:18:F2:24:41)
fake: LanguageCode¶
Generate a random i18n language code (e.g. en).
Aliases: language_code, languagecode
Source: faker : faker.providers.user_agent.Provider.language_code
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LanguageCode}}
Outputs:
SomeObject(id=1, formula_field_example=az)
fake: Lexify¶
Generate a string with each question mark ('?') in text
replaced with a random character from letters
.
By default, letters
contains all ASCII letters, uppercase and lowercase.
Aliases: lexify
Source: faker : faker.providers.user_agent.Provider.lexify
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: '${{fake.Lexify(text=''Random Identifier: ??????????'')}}'
Outputs:
SomeObject(id=1, formula_field_example=Random Identifier: NZqITZMjtg)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: '${{fake.Lexify(text=''Random Identifier: ??????????'',
letters=''ABCDE'')}}'
Outputs:
SomeObject(id=1, formula_field_example=Random Identifier: AEDCBCABEB)
fake: Locale¶
Generate a random underscored i18n locale code (e.g. en_US).
Aliases: locale
Source: faker : faker.providers.user_agent.Provider.locale
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Locale}}
Outputs:
SomeObject(id=1, formula_field_example=ro_RO)
fake: Numerify¶
Generate a string with each placeholder in text
replaced according
to the following rules:
- Number signs ('#') are replaced with a random digit (0 to 9).
- Percent signs ('%') are replaced with a random non-zero digit (1 to 9).
- Dollar signs ('$') are replaced with a random digit above two (2 to 9).
- Exclamation marks ('!') are replaced with a random digit or an empty string.
- At symbols ('@') are replaced with a random non-zero digit or an empty string.
Under the hood, this method uses :meth:random_digit() <faker.providers.BaseProvider.random_digit>
,
:meth:random_digit_not_null() <faker.providers.BaseProvider.random_digit_not_null>
,
:meth:random_digit_or_empty() <faker.providers.BaseProvider.random_digit_or_empty>
,
and :meth:random_digit_not_null_or_empty() <faker.providers.BaseProvider.random_digit_not_null_or_empty>
to generate the random values.
Aliases: numerify
Source: faker : faker.providers.user_agent.Provider.numerify
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Numerify(text='Intel Core i%-%%##K vs AMD Ryzen
% %%##X')}}
Outputs:
SomeObject(id=1, formula_field_example=Intel Core i8-9241K vs AMD Ryzen 6 7615X)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Numerify(text='!!! !!@ !@! !@@ @!! @!@ @@! @@@')}}
Outputs:
SomeObject(id=1, formula_field_example=12 6 22 4)
fake: RandomChoices¶
Generate a list of objects randomly sampled from elements
with replacement.
For information on the elements
and length
arguments, please refer to
:meth:random_elements() <faker.providers.BaseProvider.random_elements>
which
is used under the hood with the unique
argument explicitly set to False
.
("a", 0.45), ("b", 0.35), ("c", 0.15), ("d", 0.05), ])
("a", 0.45), ("b", 0.35), ("c", 0.15), ("d", 0.05), ]), length=20
Aliases: random_choices, randomchoices
Source: faker : faker.providers.user_agent.Provider.random_choices
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomChoices(elements=('a', 'b', 'c', 'd'))}}
Outputs:
SomeObject(id=1, formula_field_example=['d', 'b', 'b', 'c'])
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomChoices(elements=('a', 'b', 'c', 'd'), length=10)}}
Outputs:
SomeObject(id=1, formula_field_example=['b', 'd', 'b', 'b', 'c', 'd', 'c', 'b', 'd', 'c'])
fake: RandomDigit¶
Generate a random digit (0 to 9).
Aliases: random_digit, randomdigit
Source: faker : faker.providers.user_agent.Provider.random_digit
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomDigit}}
Outputs:
SomeObject(id=1, formula_field_example=0)
fake: RandomDigitAboveTwo¶
Generate a random digit above value two (2 to 9).
Aliases: random_digit_above_two, randomdigitabovetwo
Source: faker : faker.providers.user_agent.Provider.random_digit_above_two
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomDigitAboveTwo}}
Outputs:
SomeObject(id=1, formula_field_example=2)
fake: RandomDigitNotNull¶
Generate a random non-zero digit (1 to 9).
Aliases: random_digit_not_null, randomdigitnotnull
Source: faker : faker.providers.user_agent.Provider.random_digit_not_null
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomDigitNotNull}}
Outputs:
SomeObject(id=1, formula_field_example=1)
fake: RandomDigitNotNullOrEmpty¶
Generate a random non-zero digit (1 to 9) or an empty string.
This method will return an empty string 50% of the time, and each digit has a 1/18 chance of being generated.
Aliases: random_digit_not_null_or_empty, randomdigitnotnullorempty
Source: faker : faker.providers.user_agent.Provider.random_digit_not_null_or_empty
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomDigitNotNullOrEmpty}}
Outputs:
SomeObject(id=1, formula_field_example=9)
fake: RandomDigitOrEmpty¶
Generate a random digit (0 to 9) or an empty string.
This method will return an empty string 50% of the time, and each digit has a 1/20 chance of being generated.
Aliases: random_digit_or_empty, randomdigitorempty
Source: faker : faker.providers.user_agent.Provider.random_digit_or_empty
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomDigitOrEmpty}}
Outputs:
SomeObject(id=1, formula_field_example=8)
fake: RandomElement¶
Generate a randomly sampled object from elements
.
For information on the elements
argument, please refer to
:meth:random_elements() <faker.providers.BaseProvider.random_elements>
which
is used under the hood with the unique
argument set to False
and the
length
argument set to 1
.
:sample size=10: elements=OrderedDict([ ("a", 0.45), ("b", 0.35), ("c", 0.15), ("d", 0.05), ])
Aliases: random_element, randomelement
Source: faker : faker.providers.user_agent.Provider.random_element
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomElement(elements=('a', 'b', 'c', 'd'))}}
Outputs:
SomeObject(id=1, formula_field_example=d)
fake: RandomElements¶
Generate a list of randomly sampled objects from elements
.
Set unique
to False
for random sampling with replacement, and set unique
to
True
for random sampling without replacement.
If length
is set to None
or is omitted, length
will be set to a random
integer from 1 to the size of elements
.
The value of length
cannot be greater than the number of objects
in elements
if unique
is set to True
.
The value of elements
can be any sequence type (list
, tuple
, set
,
string
, etc) or an OrderedDict
type. If it is the latter, the keys will be
used as the objects for sampling, and the values will be used as weighted probabilities
if unique
is set to False
. For example:
.. code-block:: python
# Random sampling with replacement fake.random_elements( elements=OrderedDict([ ("variable_1", 0.5), # Generates "variable_1" 50% of the time ("variable_2", 0.2), # Generates "variable_2" 20% of the time ("variable_3", 0.2), # Generates "variable_3" 20% of the time ("variable_4": 0.1), # Generates "variable_4" 10% of the time ]), unique=False )
# Random sampling without replacement (defaults to uniform distribution) fake.random_elements( elements=OrderedDict([ ("variable_1", 0.5), ("variable_2", 0.2), ("variable_3", 0.2), ("variable_4": 0.1), ]), unique=True )
("a", 0.45), ("b", 0.35), ("c", 0.15), ("d", 0.05), ]), length=20, unique=False
("a", 0.45), ("b", 0.35), ("c", 0.15), ("d", 0.05), ]), unique=True
Aliases: random_elements, randomelements
Source: faker : faker.providers.user_agent.Provider.random_elements
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomElements(elements=('a', 'b', 'c', 'd'), unique=False)}}
Outputs:
SomeObject(id=1, formula_field_example=['d', 'b', 'b', 'c'])
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomElements(elements=('a', 'b', 'c', 'd'), unique=True)}}
Outputs:
SomeObject(id=1, formula_field_example=['c', 'b', 'd', 'a'])
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomElements(elements=('a', 'b', 'c', 'd'), length=10,
unique=False)}}
Outputs:
SomeObject(id=1, formula_field_example=['c', 'b', 'd', 'c', 'b', 'd', 'd', 'd', 'd', 'b'])
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomElements(elements=('a', 'b', 'c', 'd'), length=4,
unique=True)}}
Outputs:
SomeObject(id=1, formula_field_example=['a', 'c', 'b', 'd'])
fake: RandomInt¶
Generate a random integer between two integers min
and max
inclusive
while observing the provided step
value.
This method is functionally equivalent to randomly sampling an integer
from the sequence range(min, max + 1, step)
.
Aliases: random_int, randomint
Source: faker : faker.providers.user_agent.Provider.random_int
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomInt(min=0, max=15)}}
Outputs:
SomeObject(id=1, formula_field_example=1)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomInt(min=0, max=15, step=3)}}
Outputs:
SomeObject(id=1, formula_field_example=9)
fake: RandomLetter¶
Generate a random ASCII letter (a-z and A-Z).
Aliases: random_letter, randomletter
Source: faker : faker.providers.user_agent.Provider.random_letter
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomLetter}}
Outputs:
SomeObject(id=1, formula_field_example=A)
fake: RandomLetters¶
Generate a list of random ASCII letters (a-z and A-Z) of the specified length
.
Aliases: random_letters, randomletters
Source: faker : faker.providers.user_agent.Provider.random_letters
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomLetters(length=10)}}
Outputs:
SomeObject(id=1, formula_field_example=['q', 'L', 'U', 'J', 'y', 'f', 'w', 'F', 'V', 'Y'])
fake: RandomLowercaseLetter¶
Generate a random lowercase ASCII letter (a-z).
Aliases: random_lowercase_letter, randomlowercaseletter
Source: faker : faker.providers.user_agent.Provider.random_lowercase_letter
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomLowercaseLetter}}
Outputs:
SomeObject(id=1, formula_field_example=n)
fake: RandomNumber¶
Generate a random integer according to the following rules:
- If
digits
isNone
(default), its value will be set to a random integer from 1 to 9. - If
fix_len
isFalse
(default), all integers that do not exceed the number ofdigits
can be generated. - If
fix_len
isTrue
, only integers with the exact number ofdigits
can be generated.
Aliases: random_number, randomnumber
Source: faker : faker.providers.user_agent.Provider.random_number
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomNumber(fix_len=False)}}
Outputs:
SomeObject(id=1, formula_field_example=521760889)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomNumber(fix_len=True)}}
Outputs:
SomeObject(id=1, formula_field_example=9268)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomNumber(digits=3)}}
Outputs:
SomeObject(id=1, formula_field_example=143)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomNumber(digits=3, fix_len=False)}}
Outputs:
SomeObject(id=1, formula_field_example=633)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomNumber(digits=3, fix_len=True)}}
Outputs:
SomeObject(id=1, formula_field_example=645)
fake: RandomSample¶
Generate a list of objects randomly sampled from elements
without replacement.
For information on the elements
and length
arguments, please refer to
:meth:random_elements() <faker.providers.BaseProvider.random_elements>
which
is used under the hood with the unique
argument explicitly set to True
.
Aliases: random_sample, randomsample
Source: faker : faker.providers.user_agent.Provider.random_sample
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomSample(elements=('a', 'b', 'c', 'd', 'e',
'f'))}}
Outputs:
SomeObject(id=1, formula_field_example=['d', 'a', 'c', 'f'])
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomSample(elements=('a', 'b', 'c', 'd', 'e',
'f'), length=3)}}
Outputs:
SomeObject(id=1, formula_field_example=['d', 'f', 'c'])
fake: RandomUppercaseLetter¶
Generate a random uppercase ASCII letter (A-Z).
Aliases: random_uppercase_letter, randomuppercaseletter
Source: faker : faker.providers.user_agent.Provider.random_uppercase_letter
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomUppercaseLetter}}
Outputs:
SomeObject(id=1, formula_field_example=N)
fake: RandomizeNbElements¶
Generate a random integer near number
according to the following rules:
- If
le
isFalse
(default), allow generation up to 140% ofnumber
. IfTrue
, upper bound generation is capped at 100%. - If
ge
isFalse
(default), allow generation down to 60% ofnumber
. IfTrue
, lower bound generation is capped at 100%. - If a numerical value for
min
is provided, generated values less thanmin
will be clamped atmin
. - If a numerical value for
max
is provided, generated values greater thanmax
will be clamped atmax
. - If both
le
andge
areTrue
, the value ofnumber
will automatically be returned, regardless of the values supplied formin
andmax
.
Aliases: randomize_nb_elements, randomizenbelements
Source: faker : faker.providers.user_agent.Provider.randomize_nb_elements
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomizeNbElements(number=100)}}
Outputs:
SomeObject(id=1, formula_field_example=65)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomizeNbElements(number=100, ge=True)}}
Outputs:
SomeObject(id=1, formula_field_example=131)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomizeNbElements(number=100, ge=True, min=120)}}
Outputs:
SomeObject(id=1, formula_field_example=130)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomizeNbElements(number=100, le=True)}}
Outputs:
SomeObject(id=1, formula_field_example=73)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomizeNbElements(number=100, le=True, max=80)}}
Outputs:
SomeObject(id=1, formula_field_example=78)
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomizeNbElements(number=79, le=True, ge=True,
min=80)}}
Outputs:
SomeObject(id=1, formula_field_example=79)
Python Fakers¶
fake: Pybool¶
Generates a random boolean, optionally biased towards True
or False
.
:truth_probability: Probability of generating a True
value. Must be between 0
and 100
inclusive'.
Return:: Random boolean.
:raises ValueError: If invalid truth_probability
is provided.
Aliases: pybool
Source: faker : faker.providers.python.Provider.pybool
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pybool}}
Outputs:
SomeObject(id=1, formula_field_example=False)
fake: Pydecimal¶
Aliases: pydecimal
Source: faker : faker.providers.python.Provider.pydecimal
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pydecimal}}
Outputs:
SomeObject(id=1, formula_field_example=-54602810789.3423209471122018684833969477515917953304135256012309891013991615109032173)
fake: Pydict¶
Returns a dictionary.
:nb_elements: number of elements for dictionary :variable_nb_elements: is use variable number of elements for dictionary :value_types: type of dictionary values
Aliases: pydict
Source: faker : faker.providers.python.Provider.pydict
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pydict}}
Outputs:
SomeObject(id=1, formula_field_example={'labore': 'https://montgomery.com/explore/mainhome.jsp', 'sit': 'SLpRpfDzrPQggzbrJiiD', 'amet': 'gomezderrick@example.org', 'animi': 'dauAxzEJvtZnOwsdSKUx', 'fugit': 'garystokes@example.com', 'dolorem': 29194753368.2397, 'distinctio': 'ktChZZhvJTzVqzzIkFlr'})
fake: Pyfloat¶
Aliases: pyfloat
Source: faker : faker.providers.python.Provider.pyfloat
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pyfloat}}
Outputs:
SomeObject(id=1, formula_field_example=-61.8878635605209)
fake: Pyint¶
Aliases: pyint
Source: faker : faker.providers.python.Provider.pyint
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pyint}}
Outputs:
SomeObject(id=1, formula_field_example=663)
fake: Pyiterable¶
Aliases: pyiterable
Source: faker : faker.providers.python.Provider.pyiterable
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pyiterable}}
Outputs:
SomeObject(id=1, formula_field_example=[Decimal('-84331701240895247029677826997488.582197296687577389305550824926947118013204075227'), 8273, 8680, datetime.datetime(1971, 10, 29, 15, 27, 38, 946279), 'JPNZMVkBFQzPuESPIajA', 529902351.901653, -6.8763381174432])
fake: Pylist¶
Aliases: pylist
Source: faker : faker.providers.python.Provider.pylist
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pylist}}
Outputs:
SomeObject(id=1, formula_field_example=['http://www.conley.com/search/listindex.php', 'ZuJqlLaQBfgHToYfSueo', Decimal('28646114563843658778126442937056.4000348559097765823'), 9619, 38191497835621.5, 6016, 'rGciZpuCpymcjBdurvfV', Decimal('-6549903182054842898289740559728455724548119.045229611133060168847793615349263511087317643039213765'), datetime.datetime(2014, 11, 25, 2, 50, 50, 609132), 'ZZhvJTzVqzzIkFlrYUQb', 'TFitpKyPAVdgpNxSPTxt', 8680, datetime.datetime(1971, 10, 29, 15, 27, 38, 946279)])
fake: Pyobject¶
Generates a random object passing the type desired.
:object_type: the type of the object to generate.
Return:: the random object generated. :raises ValueError: if the object type passed is not supported
Aliases: pyobject
Source: faker : faker.providers.python.Provider.pyobject
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pyobject}}
Outputs:
SomeObject(id=1, formula_field_example=None)
fake: Pyset¶
Aliases: pyset
Source: faker : faker.providers.python.Provider.pyset
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pyset}}
Outputs:
SomeObject(id=1, formula_field_example={6016, 'http://www.conley.com/search/listindex.php', 'TFitpKyPAVdgpNxSPTxt', 38191497835621.5, datetime.datetime(2014, 11, 25, 2, 50, 51, 436118), 8680, Decimal('-6549903182054842898289740559728455724548119.045229611133060168847793615349263511087317643039213765'), datetime.datetime(1971, 10, 29, 15, 27, 38, 979897), 9619, 'ZZhvJTzVqzzIkFlrYUQb', Decimal('28646114563843658778126442937056.4000348559097765823'), 'ZuJqlLaQBfgHToYfSueo', 'rGciZpuCpymcjBdurvfV'})
fake: Pystr¶
Generates a random string of upper and lowercase letters.
Param: min_chars: minimum length of the random part.
Param: max_chars: maximum length of the random part.
Param: prefix: an optional prefix to prepend to the random string.
Param: suffix: an optional suffix to append to the random string.
Return:: Random of random length between min and max characters.
Aliases: pystr
Source: faker : faker.providers.python.Provider.pystr
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pystr}}
Outputs:
SomeObject(id=1, formula_field_example=azTmqTjDmYPxeqAWfCKC)
fake: PystrFormat¶
Aliases: pystr_format, pystrformat
Source: faker : faker.providers.python.Provider.pystr_format
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.PystrFormat}}
Outputs:
SomeObject(id=1, formula_field_example=Z4-2198268i)
fake: Pystruct¶
Aliases: pystruct
Source: faker : faker.providers.python.Provider.pystruct
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pystruct}}
Outputs:
SomeObject(id=1, formula_field_example=(['nKiDpZjZnuBHqLzgFnLt', 4371, Decimal('5617725339352095215450335896990450732051664979589704428956354.1167259839399794126132244527581160035635691517'), Decimal('-0.9781001266923810066426'), 'oSMpzpWSCJePsnrUfZyG', 'http://www.walters-cohen.org/posts/blogauthor.htm', 7477, 3075, 'https://www.owen.org/explore/posts/appterms.php', 5.33768337330191], {'temporibus': 7286, 'consectetur': 'http://goodwin-hutchinson.com/search/categories/wp-contentindex.jsp', 'ut': 'lVypwMSQgYyXiWkToRiS', 'reiciendis': 'http://carrillo.biz/exploreindex.php', 'dignissimos': datetime.datetime(1989, 2, 28, 10, 17, 48, 980147), 'doloremque': 'cVpkImDNIqGGbxGtiVaS', 'dolor': 'https://zimmerman.com/search/postsfaq.htm', 'at': datetime.datetime(1982, 7, 24, 9, 16, 53, 604131), 'iusto': -14136.6071626619}, {'consequuntur': {0: datetime.datetime(1971, 4, 8, 7, 22, 38, 637485), 1: ['eileensantos@example.net', 'cdurham@example.org', 9102], 2: {0: 'XoQbJuBCBCMUEPNFkwli', 1: 'https://www.boyle-chaney.com/search/tagterms.html', 2: [Decimal('-620161498196260518936359354009769011542758819214490827329000080666415416926528496774368842.689142822153007719802792941452750'), 1691]}}, 'hic': {1: Decimal('-7590785068499467713791198109810999495444600850299342787233158893240837156903632513912.34127554753272537218997521524511655450342282731841061677220121691419913462874526'), 2: [798112357130.87, 'HQNJxURrwPpQhjlmgNws', 'ggmCISEHzAIopGGjkCRq'], 3: {1: 'fxZDDMtvFrZZhLRYzheS', 2: 'NfqqkdcljOXZXGZUkLFl', 3: ['UMvOdHWUqopUrvrnTxBu', 6612]}}, 'in': {2: 'https://graves-nichols.com/categoriesauthor.html', 3: [datetime.datetime(1984, 12, 27, 17, 15, 23, 326486), Decimal('6044755521806765438160745456414229045702766921234191236482295824722379940189458.716474060712454927709526042921687826528592113137306545947804763708965395422431562449260'), 'sampsonkenneth@example.com'], 4: {2: 1283, 3: 'JmdqxDFfiUNEcXOlddHE', 4: ['zIBDZetCPTGIUPEavdYQ', 1645]}}, 'veniam': {3: 'IGAWQEJvAGRkxjkbgNrp', 4: ['jLoXPfDPVitlNgGTJscG', 'lulLChibfGHBPCnNtclx', 'https://bush.com/searchfaq.htm'], 5: {3: -4929620.7802481, 4: 367.211676038078, 5: [3810, 'YkJgZIYsuTIBJnKAMUfY']}}, 'consectetur': {4: datetime.datetime(1977, 1, 15, 9, 46, 14, 756138), 5: [Decimal('-40745171219024654983113964433806670597356723104394351033778112764559599828556043897601864437026299.1694809066853321189245783629925205218'), 9935, 'fMDWMyFVzrGkGvArZVnO'], 6: {4: 'PxgIwKZrxrqmsssXtaYE', 5: 73161242.1993433, 6: [396, 2349]}}, 'natus': {5: 8788, 6: [8145, 'http://www.snyder.com/exploremain.htm', 'http://waller.net/tags/categoryterms.asp'], 7: {5: 'gppuBcDmuCpgqKnKnxVQ', 6: 1249, 7: [5585, 'QRZrECDIWaqyAVzmSAOn']}}, 'recusandae': {6: -4.99867530923159, 7: ['CxneWZCOsSstrYTcAqoG', 1230, 324], 8: {6: Decimal('477406728948857499627079274850925836633217956.07235310676905007432716804120046894157954530837806508318308523'), 7: 'https://lambert.com/wp-content/searchindex.php', 8: ['nathan60@example.org', 'freemanrita@example.com']}}, 'assumenda': {7: 9423, 8: [27.9224885884663, 'FWAWqEGeinnjvfhSjxeP', -2.28107154740977], 9: {7: 'EZwPKNtbvVQecuGkaKlF', 8: Decimal('-3548170133182117559702741292304172278579945018719500824429909070904380917795.518972963240757583490'), 9: [Decimal('9959517988327016343756760191792976.963039624983269757920966542474693732'), Decimal('-7718.8461442234225399201249442')]}}, 'tempore': {8: 'gvIETTCUPhausbQAYRQu', 9: ['fCkHucUVHkvKgkeWNhmI', 'lSwSaBvOXfNsTSZAzlcV', 'nHOfrGYfTpDfyVlmcDyC'], 10: {8: 'wmGfjpxkHnyPIFRvwugF', 9: Decimal('919637158096508818537562445322.404736349505060980006947508616405005190819803996411212833794630887132671'), 10: ['lNgwIvFjbZIizDhTuyxM', 5440]}}, 'placeat': {9: datetime.datetime(1993, 8, 1, 0, 1, 17, 543814), 10: [-41.562959945877, 'RpkmXilPTmBsSEyJZHQQ', -27987694980922.0], 11: {9: 'http://www.brewer.org/tag/listprivacy.php', 10: 'http://www.rice.com/wp-contentfaq.asp', 11: [2289, datetime.datetime(1985, 11, 5, 20, 22, 22, 444485)]}}}))
fake: Pytuple¶
Aliases: pytuple
Source: faker : faker.providers.python.Provider.pytuple
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Pytuple}}
Outputs:
SomeObject(id=1, formula_field_example=('http://www.conley.com/search/listindex.php', 'ZuJqlLaQBfgHToYfSueo', Decimal('28646114563843658778126442937056.4000348559097765823'), 9619, 38191497835621.5, 6016, 'rGciZpuCpymcjBdurvfV', Decimal('-6549903182054842898289740559728455724548119.045229611133060168847793615349263511087317643039213765'), datetime.datetime(2014, 11, 25, 2, 50, 51, 436118), 'ZZhvJTzVqzzIkFlrYUQb', 'TFitpKyPAVdgpNxSPTxt', 8680, datetime.datetime(1971, 10, 29, 15, 27, 38, 979897)))
Sbn Fakers¶
fake: Sbn9¶
Aliases: sbn9
Source: faker : faker.providers.sbn.Provider.sbn9
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Sbn9}}
Outputs:
SomeObject(id=1, formula_field_example=19-489241-2)
Ssn Fakers¶
fake: Ein¶
Generate a random United States Employer Identification Number (EIN).
An United States An Employer Identification Number (EIN) is also known as a Federal Tax Identification Number, and is used to identify a business entity. EINs follow a format of a two-digit prefix followed by a hyphen and a seven-digit sequence: ##-######
https://www.irs.gov/businesses/small-businesses-self-employed/employer-id-numbers
Aliases: ein
Source: faker : faker.providers.ssn.en_US.Provider.ein
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ein}}
Outputs:
SomeObject(id=1, formula_field_example=77-8152513)
fake: InvalidSsn¶
Generate a random invalid United States Social Security Identification Number (SSN).
Invalid SSNs have the following characteristics: Cannot begin with the number 9 Cannot begin with 666 in positions 1 - 3 Cannot begin with 000 in positions 1 - 3 Cannot contain 00 in positions 4 - 5 Cannot contain 0000 in positions 6 - 9
https://www.ssa.gov/kc/SSAFactSheet--IssuingSSNs.pdf
Additionally, return an invalid SSN that is NOT a valid ITIN by excluding certain ITIN related "group" values
Aliases: invalid_ssn, invalidssn
Source: faker : faker.providers.ssn.en_US.Provider.invalid_ssn
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.InvalidSsn}}
Outputs:
SomeObject(id=1, formula_field_example=497-00-4969)
fake: Itin¶
Generate a random United States Individual Taxpayer Identification Number (ITIN).
An United States Individual Taxpayer Identification Number (ITIN) is a tax processing number issued by the Internal Revenue Service. It is a nine-digit number that always begins with the number 9 and has a range of 70-88 in the fourth and fifth digit. Effective April 12, 2011, the range was extended to include 900-70-0000 through 999-88-9999, 900-90-0000 through 999-92-9999 and 900-94-0000 through 999-99-9999. https://www.irs.gov/individuals/international-taxpayers/general-itin-information
Aliases: itin
Source: faker : faker.providers.ssn.en_US.Provider.itin
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Itin}}
Outputs:
SomeObject(id=1, formula_field_example=951-85-4969)
fake: Ssn¶
Generate a random United States Taxpayer Identification Number of the specified type.
If no type is specified, a US SSN is returned.
Aliases: ssn
Source: faker : faker.providers.ssn.en_US.Provider.ssn
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Ssn}}
Outputs:
SomeObject(id=1, formula_field_example=498-52-4970)
User_Agent Fakers¶
fake: AndroidPlatformToken¶
Generate an Android platform token used in user agent strings.
Aliases: android_platform_token, androidplatformtoken
Source: faker : faker.providers.user_agent.Provider.android_platform_token
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.AndroidPlatformToken}}
Outputs:
SomeObject(id=1, formula_field_example=Android 5.0.2)
fake: Chrome¶
Generate a Chrome web browser user agent string.
Aliases: chrome
Source: faker : faker.providers.user_agent.Provider.chrome
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Chrome}}
Outputs:
SomeObject(id=1, formula_field_example=Mozilla/5.0 (iPad; CPU iPad OS 10_3_4 like Mac OS X) AppleWebKit/536.1 (KHTML, like Gecko) CriOS/26.0.877.0 Mobile/13Z933 Safari/536.1)
fake: Firefox¶
Generate a Mozilla Firefox web browser user agent string.
Aliases: firefox
Source: faker : faker.providers.user_agent.Provider.firefox
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Firefox}}
Outputs:
SomeObject(id=1, formula_field_example=Mozilla/5.0 (Windows 95; brx-IN; rv:1.9.2.20) Gecko/4543-03-16 09:03:06.006958 Firefox/3.8)
fake: InternetExplorer¶
Generate an IE web browser user agent string.
Aliases: internet_explorer, internetexplorer
Source: faker : faker.providers.user_agent.Provider.internet_explorer
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.InternetExplorer}}
Outputs:
SomeObject(id=1, formula_field_example=Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 5.1; Trident/4.0))
fake: IosPlatformToken¶
Generate an iOS platform token used in user agent strings.
Aliases: ios_platform_token, iosplatformtoken
Source: faker : faker.providers.user_agent.Provider.ios_platform_token
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.IosPlatformToken}}
Outputs:
SomeObject(id=1, formula_field_example=iPad; CPU iPad OS 9_3_6 like Mac OS X)
fake: LinuxPlatformToken¶
Generate a Linux platform token used in user agent strings.
Aliases: linux_platform_token, linuxplatformtoken
Source: faker : faker.providers.user_agent.Provider.linux_platform_token
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LinuxPlatformToken}}
Outputs:
SomeObject(id=1, formula_field_example=X11; Linux i686)
fake: LinuxProcessor¶
Generate a Linux processor token used in user agent strings.
Aliases: linux_processor, linuxprocessor
Source: faker : faker.providers.user_agent.Provider.linux_processor
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.LinuxProcessor}}
Outputs:
SomeObject(id=1, formula_field_example=i686)
fake: MacPlatformToken¶
Generate a MacOS platform token used in user agent strings.
Aliases: mac_platform_token, macplatformtoken
Source: faker : faker.providers.user_agent.Provider.mac_platform_token
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MacPlatformToken}}
Outputs:
SomeObject(id=1, formula_field_example=Macintosh; U; Intel Mac OS X 10_12_5)
fake: MacProcessor¶
Generate a MacOS processor token used in user agent strings.
Aliases: mac_processor, macprocessor
Source: faker : faker.providers.user_agent.Provider.mac_processor
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.MacProcessor}}
Outputs:
SomeObject(id=1, formula_field_example=Intel)
fake: Opera¶
Generate an Opera web browser user agent string.
Aliases: opera
Source: faker : faker.providers.user_agent.Provider.opera
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Opera}}
Outputs:
SomeObject(id=1, formula_field_example=Opera/8.49.(Windows NT 10.0; ce-RU) Presto/2.9.189 Version/12.00)
fake: Safari¶
Generate a Safari web browser user agent string.
Aliases: safari
Source: faker : faker.providers.user_agent.Provider.safari
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.Safari}}
Outputs:
SomeObject(id=1, formula_field_example=Mozilla/5.0 (Macintosh; PPC Mac OS X 10_10_1 rv:3.0; the-NP) AppleWebKit/531.6.6 (KHTML, like Gecko) Version/5.0.1 Safari/531.6.6)
fake: UserAgent¶
Generate a random web browser user agent string.
Aliases: user_agent, useragent
Source: faker : faker.providers.user_agent.Provider.user_agent
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.UserAgent}}
Outputs:
SomeObject(id=1, formula_field_example=Mozilla/5.0 (iPod; U; CPU iPhone OS 3_2 like Mac OS X; ht-HT) AppleWebKit/532.19.2 (KHTML, like Gecko) Version/4.0.5 Mobile/8B116 Safari/6532.19.2)
fake: WindowsPlatformToken¶
Generate a Windows platform token used in user agent strings.
Aliases: windows_platform_token, windowsplatformtoken
Source: faker : faker.providers.user_agent.Provider.windows_platform_token
Recipe:
- var: snowfakery_locale
value: it_CH
- object: SomeObject
fields:
formula_field_example: ${{fake.WindowsPlatformToken}}
Outputs:
SomeObject(id=1, formula_field_example=Windows NT 5.01)