Fake data

Overview

Fake data comes in a few different flavours. Let's start with the most common pattern:

# examples/salesforce/simple_account.recipe.yml
- object: Account
  fields:
    Name:
      fake: Company
    Description:
      fake: CatchPhrase
    BillingStreet:
      fake: StreetAddress
    BillingCity:
      fake: City
    BillingState:
      fake: State
    BillingPostalCode:
      fake: PostalCode
    BillingCountry:
      fake: CurrentCountry
    Phone:
      fake: PhoneNumber

So the first obvious question is where you find these names. The answer is you can scroll down on this page to see a long list with descriptions.

The description above might generate output like this:

Account(id=1, Name=Nelson-Deleon, Description=Secured bandwidth-monitored moratorium, BillingStreet=2187 Kerry Way, BillingCity=Rangelland, BillingState=Colorado, BillingPostalCode=08388, BillingCountry=United States, Phone=001-738-530-9719)

It doesn't matter if you use upper or lower case for fake names.

Formulas

Sometimes you might want to combine the fake data with other data in a single field. You can use formula syntaax for this.

# examples/faker_in_formula.recipe.yml
- object: Account
  fields:
    Name: ${fake.State} State University

Some complex faker definitions can also use parameters. The documentation says what parameters are allowed. The docs for fake: sentence define nb_words and variable_nb_words, for example.

# examples/parameters.recipe.yml
- object: Example
  fields:
    gibberish_words: ${fake.Sentence(nb_words=10, variable_nb_words=False)}
Block fakers with parameters

If you'd rather not use the formula syntax (${ blah }) there is also a nested syntax for that:

# examples/parameters_block.recipe.yml
- object: Example
  fields:
    gibberish_words:
      fake.Sentence:
        nb_words: 10
        variable_nb_words: False
Localization

Our fake data can be localized to many languages. We have detailed docs about how to use fake data in each of the other languages.

The default locale is en_US: United Statesian Engish.

Let's say that you want to generate fake data for France instead of the United States.

You do so by setting the special snowfakery_locale "variable" like this.

# examples/salesforce/simple_account_french.recipe.yml

- var: snowfakery_locale
  value: fr_FR
- object: Account
  fields:
    Name:
      fake: Company
    Description:
      fake: CatchPhrase
    BillingStreet:
      fake: StreetAddress
    BillingCity:
      fake: City
    BillingState:
      fake: State
    BillingPostalCode:
      fake: PostalCode
    BillingCountry:
      fake: CurrentCountry
    Phone:
      fake: PhoneNumber

This will translate the State to the appropriate administrative unit in France. CurrentCountry will be France, not United States. The Catch Phrase will be in French and so forth.

For example:

Account(id=1, Name=Parent Auger S.A.S., Description=Le confort de rouler de manière sûre, BillingStreet=54, rue de Bailly, BillingCity=Charrier, BillingState=Île-de-France, BillingPostalCode=72902, BillingCountry=France, Phone=08 05 11 90 19)

We can do many countries. For example, Japanese (ja_JP locale):

Account(id=1, Name=有限会社山下電気, Description=Inverse 24hour pricing structure, BillingStreet=040 佐々木 Street, BillingCity=横浜市金沢区, BillingState=福岡県, BillingPostalCode=181-5538, BillingCountry=Japan, Phone=070-4156-5072)

We can even pick the locale randomly:

# examples/salesforce/simple_account_random.recipe.yml
- var: snowfakery_locale
  value:
    random_choice:
      - ja_JP # Japanese
      - en_CA # Canadian English
      - fr_FR # French from France
      - fr_CA # Canadian French
      - de_DE # German from Germany
- object: Account
  fields:
    Name:
      fake: Company
    Description:
      fake: CatchPhrase
    BillingStreet:
      fake: StreetAddress
    BillingCity:
      fake: City
    BillingState:
      fake: State
    BillingPostalCode:
      fake: PostalCode
    BillingCountry:
      fake: CurrentCountry
    Phone:
      fake: PhoneNumber
Fake Dates and Numbers

The main Snowfakery documentation describes how to fake dates and numbers.

Datetimes are in UTC timezone by default:

# examples/simple_datetime.recipe.yml
- object: Contact
  fields:
    FirstName:
      fake: FirstName
    LastName:
      fake: LastName
    EmailBouncedDate:
      fake: DateTime

Which might generate:

Contact(id=1, FirstName=Shawn, LastName=Cole, EmailBouncedDate=1984-06-07T10:41:20+00:00)

Or you can use this more elaborate syntax to control the time-zone, start-date and end-date:

# examples/datetime_with_params.recipe.yml
- object: Contact
  fields:
    FirstName:
      fake: FirstName
    LastName:
      fake: LastName
    EmailBouncedDate:
      fake.datetime:
        start_date: -10y
        end_date: now
        timezone:
          relativedelta:
            hours: +8

Which generates data like:

Contact(id=1, FirstName=Selena, LastName=Sampson, EmailBouncedDate=2012-10-09T21:56:17+08:00)

If you need a Datetime with no timezone, pass False as the timezone.

Custom Faker Providers

You can also include Faker extension libraries ("Providers") after you’ve added them to your Python install:

 - plugin: faker_microservice.Provider
 - object: OBJ
    fields:
    service_name:
        fake:
            microservice

You would install that provider like this:

$ pip install faker_microservice

Here are some Python Faker providers:

https://faker.readthedocs.io/en/master/communityproviders.html

And you could make your own providers as well. Aaron Crosman has written a tutorial about that process.

Index of Fake Datatypes

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:

- 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=Juan, LastName=Russell, Email=JRussell@example.net)
Contact(id=2, FirstName=Tyrone Sam, LastName=Lorraine Senior, Email=dukealexa@example.net)

fake: Postalcode

Return whatever counts as a postalcode for a particular locale

Aliases: postalcode

Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.postalcode

Recipe:

- object: Account
  fields:
    Name:
      fake: Company
    BillingPostalCode:
      fake: postalcode
- object: Account
  fields:
    Name: ${{fake.Company}} Holdings
    BillingPostalCode: ${{fake.Postalcode}}

Outputs:

Account(id=1, Name=Dominguez-Potts, BillingPostalCode=75855)
Account(id=2, Name=Carey-Davis Holdings, BillingPostalCode=97170)

fake: State

Return a state, province or other appropriate administrative unit

Aliases: state

Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.state

Recipe:

- object: Account
  fields:
    Name:
      fake: Company
    BillingState:
      fake: State
- object: Account
  fields:
    Name: ${{fake.Company}} Holdings
    BillingState: ${{fake.State}}

Outputs:

Account(id=1, Name=Buck LLC, BillingState=Georgia)
Account(id=2, Name=Espinoza and Sons Holdings, BillingState=Utah)

Address Fakers

fake: City

Example:: 'Sashabury'

Aliases: city

Source: faker : faker.providers.address.en_US.Provider.city

Recipe:

- object: Account
  fields:
    Name:
      fake: Company
    BillingCity:
      fake: City
- object: Account
  fields:
    Name: ${{fake.Company}} Holdings
    BillingCity: ${{fake.City}}

Outputs:

Account(id=1, Name=Walton-Rogers, BillingCity=North Angelica)
Account(id=2, Name=Durham Ltd Holdings, BillingCity=New Logan)

fake: Country

Aliases: country

Source: faker : faker.providers.address.en_US.Provider.country

Recipe:

- object: Account
  fields:
    Name:
      fake: Company
    BillingCountry:
      fake: Country
- object: Account
  fields:
    Name: ${{fake.Company}} Holdings
    BillingCountry: ${{fake.Country}}

Outputs:

Account(id=1, Name=Fields, Acosta and Cantrell, BillingCountry=Equatorial Guinea)
Account(id=2, Name=Mccormick, Yoder and Delacruz Holdings, BillingCountry=Lesotho)

fake: CurrentCountry

Aliases: current_country, currentcountry

Source: faker : faker.providers.address.en_US.Provider.current_country

Recipe:

- object: Account
  fields:
    Name:
      fake: Company
    BillingCountry:
      fake: CurrentCountry
- object: Account
  fields:
    Name: ${{fake.Company}} Holdings
    BillingCountry: ${{fake.CurrentCountry}}

Outputs:

Account(id=1, Name=Rivera LLC, BillingCountry=United States)
Account(id=2, Name=Lowery, Briggs and Gonzales 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:

- object: Account
  fields:
    Name:
      fake: Company
    BillingStreet:
      fake: StreetAddress
- object: Account
  fields:
    Name: ${{fake.Company}} Holdings
    BillingStreet: ${{fake.StreetAddress}}

Outputs:

Account(id=1, Name=Watkins-Davies, BillingStreet=3680 Sheppard Walk)
Account(id=2, Name=Lopez, Farley and Pham Holdings, BillingStreet=85060 Roberta Ridge)

Company Fakers

fake: CatchPhrase

Example:: 'Robust full-range hub'

Aliases: catch_phrase, catchphrase

Source: faker : faker.providers.company.en_US.Provider.catch_phrase

Recipe:

- 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=Garner LLC, Description=Re-engineered 6thgeneration encryption)
Account(id=2, Name=Howe, Bray and Wolfe Holdings, Description=Our Motto: Realigned scalable archive)

fake: Company

Example:: 'Acme Ltd'

Aliases: company

Source: faker : faker.providers.company.en_US.Provider.company

Recipe:

- object: Account
  fields:
    Name:
      fake: Company
- object: Account
  fields:
    Name: ${{fake.Company}} Holdings

Outputs:

Account(id=1, Name=Walters LLC)
Account(id=2, Name=Cantrell, Carrillo and Nicholson 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Time}}

Outputs:

SomeObject(id=1, formula_field_example=08:43:22)

fake: Year

Aliases: year

Source: faker : faker.providers.date_time.en_US.Provider.year

Recipe:

- object: Student
  fields:
    GraduationYear:
      fake: year
- object: Student
  fields:
    GraduationYear: ${{year}}

Outputs:

Student(id=1, GraduationYear=1987)
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.en_US.Provider.paragraph

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Paragraph(nb_sentences=5)}}

Outputs:

SomeObject(id=1, formula_field_example=Attorney quickly candidate change although bag record. Raise study modern miss dog Democrat quickly. Often late produce you true soldier. Food break onto friend.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Paragraph(nb_sentences=5, variable_nb_sentences=False)}}

Outputs:

SomeObject(id=1, formula_field_example=Score from animal exactly drive well good. Pull opportunity throughout take car. Hold increase practice ability court. Civil development large report purpose themselves. I reduce industry.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Paragraph(nb_sentences=5, ext_word_list=['abc',
      'def', 'ghi', 'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=Def def abc ghi. Jkl ghi abc abc def jkl abc. Abc jkl ghi abc ghi jkl.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Paragraph(nb_sentences=5, variable_nb_sentences=False,
      ext_word_list=['abc', 'def', 'ghi', 'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=Jkl def abc abc jkl jkl. Ghi abc ghi abc def ghi abc. Jkl def abc def def jkl jkl. Ghi jkl ghi abc. Def abc abc ghi.)

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.en_US.Provider.sentence

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Sentence(nb_words=10)}}

Outputs:

SomeObject(id=1, formula_field_example=Line beyond its particularly tree whom local tend employee source.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Sentence(nb_words=10, variable_nb_words=False)}}

Outputs:

SomeObject(id=1, formula_field_example=Meet usually board necessary religious natural sport music white owner.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Sentence(nb_words=10, ext_word_list=['abc', 'def',
      'ghi', 'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=Def abc jkl def abc abc jkl abc jkl def abc ghi abc.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Sentence(nb_words=10, variable_nb_words=True, ext_word_list=['abc',
      'def', 'ghi', 'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=Jkl jkl jkl jkl ghi def ghi.)

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.en_US.Provider.text

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Text(max_nb_chars=20)}}

Outputs:

SomeObject(id=1, formula_field_example=Much mention.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Text(max_nb_chars=80)}}

Outputs:

SomeObject(id=1, formula_field_example=Partner stock four. Region as true develop sound central.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Text(max_nb_chars=160)}}

Outputs:

SomeObject(id=1, formula_field_example=Per structure attorney author feeling job. Mean always beyond write. Employee toward like total now.
Small citizen class morning. Others kind company likely.)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Text(ext_word_list=['abc', 'def', 'ghi', 'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=Ghi jkl abc ghi ghi abc. Ghi def jkl ghi def.
Def ghi abc def def abc ghi. Jkl ghi abc abc def jkl abc. Abc jkl ghi abc ghi jkl.
Def abc ghi abc jkl ghi. Abc ghi abc def. Abc jkl def abc.)

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.en_US.Provider.word

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Word}}

Outputs:

SomeObject(id=1, formula_field_example=son)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Word(ext_word_list=['abc', 'def', 'ghi', 'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=jkl)

Person Fakers

fake: FirstName

Aliases: first_name, firstname

Source: faker : faker.providers.person.en_US.Provider.first_name

Recipe:

- 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=Danielle, LastName=Hendrix)
Contact(id=2, FirstName=Vernon Sam, LastName=Bright-Jones)

fake: FirstNameFemale

Aliases: first_name_female, firstnamefemale

Source: faker : faker.providers.person.en_US.Provider.first_name_female

Recipe:

- 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=Dorothy, LastName=Burnett)
Contact(id=2, FirstName=Catherine Beth, LastName=Hopkins-Jones)

fake: FirstNameMale

Aliases: first_name_male, firstnamemale

Source: faker : faker.providers.person.en_US.Provider.first_name_male

Recipe:

- 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=Glen, LastName=Krause)
Contact(id=2, FirstName=Ruben Beth, LastName=Escobar-Jones)

fake: FirstNameNonbinary

Aliases: first_name_nonbinary, firstnamenonbinary

Source: faker : faker.providers.person.en_US.Provider.first_name_nonbinary

Recipe:

- 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=Edgar, LastName=Moon)
Contact(id=2, FirstName=Darin Mary-John, LastName=Daugherty-Jones)

fake: LastName

Aliases: last_name, lastname

Source: faker : faker.providers.person.en_US.Provider.last_name

Recipe:

- 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=Betty, LastName=Wise)
Contact(id=2, FirstName=Abigail Sam, LastName=Savannah Senior)

Phone_Number Fakers

fake: PhoneNumber

Aliases: phone_number, phonenumber

Source: faker : faker.providers.phone_number.en_US.Provider.phone_number

Recipe:

- 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=Lowe PLC, Phone=185-839-8947x1965)
Account(id=2, Name=Oliver, Estrada and Spencer Holdings, Phone=209.471.1220 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateTime}}

Outputs:

SomeObject(id=1, formula_field_example=2016-02-26 10:02:36+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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateTimeBetween}}

Outputs:

SomeObject(id=1, formula_field_example=2015-08-13 18:13:40+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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateTimeBetweenDates}}

Outputs:

SomeObject(id=1, formula_field_example=2016-05-10 11:51:42+00:00)

fake: FutureDatetime

Aliases: future_datetime, futuredatetime

Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.future_datetime

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FutureDatetime}}

Outputs:

SomeObject(id=1, formula_field_example=2022-06-06 01:37:25+00:00)

fake: Iso8601

Aliases: iso8601

Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.iso8601

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Iso8601}}

Outputs:

SomeObject(id=1, formula_field_example=2016-03-28T10:14:27+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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.UserName}}

Outputs:

SomeObject(id=1, formula_field_example=Cesar_Vaughan_efbfc19e-e8f6-4f32-a25b-59fd92e8e269@desktop-60.boyle.com)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Alias}}

Outputs:

SomeObject(id=1, formula_field_example=Darin)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.RealisticMaybeRealEmail}}

Outputs:

SomeObject(id=1, formula_field_example=bakersamantha@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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.SecondaryAddress}}

Outputs:

SomeObject(id=1, formula_field_example=Suite 938)

fake: StateAbbr

Return:s: A random state or territory abbreviation.

Param: include_territories: If True, territories will be included. If False, only states will be returned.

Aliases: state_abbr, stateabbr

Source: faker : faker.providers.address.en_US.Provider.state_abbr

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.StateAbbr}}

Outputs:

SomeObject(id=1, formula_field_example=KS)

fake: StreetName

Example:: 'Crist Parks'

Aliases: street_name, streetname

Source: faker : faker.providers.address.en_US.Provider.street_name

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.LicensePlate}}

Outputs:

SomeObject(id=1, formula_field_example=194-EJEY)

Bank Fakers

fake: Aba

Generate an ABA routing transit number.

Aliases: aba

Source: faker : faker.providers.bank.en_GB.Provider.aba

Recipe:

- var: snowfakery_locale
  value: en_US
- 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.en_GB.Provider.bank_country

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.BankCountry}}

Outputs:

SomeObject(id=1, formula_field_example=GB)

fake: Bban

Generate a Basic Bank Account Number (BBAN).

Aliases: bban

Source: faker : faker.providers.bank.en_GB.Provider.bban

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Bban}}

Outputs:

SomeObject(id=1, formula_field_example=RPOQ40801609753513)

fake: Iban

Generate an International Bank Account Number (IBAN).

Aliases: iban

Source: faker : faker.providers.bank.en_GB.Provider.iban

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Iban}}

Outputs:

SomeObject(id=1, formula_field_example=GB51RPOQ40801609753513)

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.en_GB.Provider.swift

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift}}

Outputs:

SomeObject(id=1, formula_field_example=JDXCGBV4)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift(length=8)}}

Outputs:

SomeObject(id=1, formula_field_example=ZRACGBZA)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift(length=8, use_dataset=True)}}

Outputs:

SomeObject(id=1, formula_field_example=OCCKGB65)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift(length=11)}}

Outputs:

SomeObject(id=1, formula_field_example=SHJFGBMLCQ4)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift(length=11, primary=True)}}

Outputs:

SomeObject(id=1, formula_field_example=IQZHGBN0XXX)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift(length=11, use_dataset=True)}}

Outputs:

SomeObject(id=1, formula_field_example=LZFKGB1DGJO)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift(length=11, primary=True, use_dataset=True)}}

Outputs:

SomeObject(id=1, formula_field_example=CLDBGBBMXXX)

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.en_GB.Provider.swift11

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift11}}

Outputs:

SomeObject(id=1, formula_field_example=TZIRGBJTGEV)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift11(use_dataset=True)}}

Outputs:

SomeObject(id=1, formula_field_example=TPKHGBUEMOP)

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.en_GB.Provider.swift8

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift8}}

Outputs:

SomeObject(id=1, formula_field_example=SGQEGBSI)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Swift8(use_dataset=True)}}

Outputs:

SomeObject(id=1, formula_field_example=XCVKGB49)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean(length=13)}}

Outputs:

SomeObject(id=1, formula_field_example=1578156593879)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean(length=8)}}

Outputs:

SomeObject(id=1, formula_field_example=13933289)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean(prefixes=('00', ))}}

Outputs:

SomeObject(id=1, formula_field_example=0015871484187)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean13}}

Outputs:

SomeObject(id=1, formula_field_example=1578156593879)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean13(leading_zero=False)}}

Outputs:

SomeObject(id=1, formula_field_example=5418583989479)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean13(leading_zero=True)}}

Outputs:

SomeObject(id=1, formula_field_example=0694775159171)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean13(prefixes=('00', ))}}

Outputs:

SomeObject(id=1, formula_field_example=0004135256011)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean8}}

Outputs:

SomeObject(id=1, formula_field_example=42194897)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Ean8(prefixes=('00', ))}}

Outputs:

SomeObject(id=1, formula_field_example=00115780)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.LocalizedEan}}

Outputs:

SomeObject(id=1, formula_field_example=1381565938779)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.LocalizedEan(length=13)}}

Outputs:

SomeObject(id=1, formula_field_example=0948418583985)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.UpcA}}

Outputs:

SomeObject(id=1, formula_field_example=156593877847)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.UpcE}}

Outputs:

SomeObject(id=1, formula_field_example=04219484)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.UpcE(base='123456')}}

Outputs:

SomeObject(id=1, formula_field_example=11234562)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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 to 360, 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Color(hue='red')}}

Outputs:

SomeObject(id=1, formula_field_example=#ef6466)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Color(luminosity='light')}}

Outputs:

SomeObject(id=1, formula_field_example=#f9e38b)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: ColorName

Generate a color name.

Aliases: color_name, colorname

Source: faker : faker.providers.color.en_US.Provider.color_name

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.ColorName}}

Outputs:

SomeObject(id=1, formula_field_example=BlueViolet)

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.CreditCardExpire}}

Outputs:

SomeObject(id=1, formula_field_example=01/23)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.CreditCardFull}}

Outputs:

SomeObject(id=1, formula_field_example=Diners Club / Carte Blanche
Andrea Dean
30513933287118 10/27
CVC: 871
)

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.CurrencySymbol}}

Outputs:

SomeObject(id=1, formula_field_example=$)

fake: Pricetag

Aliases: pricetag

Source: faker : faker.providers.currency.en_US.Provider.pricetag

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.AmPm}}

Outputs:

SomeObject(id=1, formula_field_example=AM)

fake: Century

Example:: 'XVII'

Aliases: century

Source: faker : faker.providers.date_time.en_US.Provider.century

Recipe:

- var: snowfakery_locale
  value: en_US
- 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

Example:: '2008-11-27'

Aliases: date

Source: faker : faker.providers.date_time.en_US.Provider.date

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Date}}

Outputs:

SomeObject(id=1, formula_field_example=1998-08-15)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateBetween}}

Outputs:

SomeObject(id=1, formula_field_example=2018-02-22)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateBetweenDates}}

Outputs:

SomeObject(id=1, formula_field_example=2022-05-11)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateObject}}

Outputs:

SomeObject(id=1, formula_field_example=1998-08-15)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateOfBirth}}

Outputs:

SomeObject(id=1, formula_field_example=2009-07-07)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateThisCentury}}

Outputs:

SomeObject(id=1, formula_field_example=2001-05-18)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateThisDecade}}

Outputs:

SomeObject(id=1, formula_field_example=2020-03-03)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateThisMonth}}

Outputs:

SomeObject(id=1, formula_field_example=2022-05-06)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DateThisYear}}

Outputs:

SomeObject(id=1, formula_field_example=2022-01-08)

fake: DayOfMonth

Aliases: day_of_month, dayofmonth

Source: faker : faker.providers.date_time.en_US.Provider.day_of_month

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.DayOfMonth}}

Outputs:

SomeObject(id=1, formula_field_example=15)

fake: DayOfWeek

Aliases: day_of_week, dayofweek

Source: faker : faker.providers.date_time.en_US.Provider.day_of_week

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FutureDate}}

Outputs:

SomeObject(id=1, formula_field_example=2022-05-13)

fake: Month

Aliases: month

Source: faker : faker.providers.date_time.en_US.Provider.month

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Month}}

Outputs:

SomeObject(id=1, formula_field_example=08)

fake: MonthName

Aliases: month_name, monthname

Source: faker : faker.providers.date_time.en_US.Provider.month_name

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.MonthName}}

Outputs:

SomeObject(id=1, formula_field_example=August)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.PastDate}}

Outputs:

SomeObject(id=1, formula_field_example=2022-04-12)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.PastDatetime}}

Outputs:

SomeObject(id=1, formula_field_example=2022-04-13 16:51:43)

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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.TimeObject}}

Outputs:

SomeObject(id=1, formula_field_example=08:43:22)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.TimeSeries}}

Outputs:

SomeObject(id=1, formula_field_example=<generator object Provider.time_series at 0x7fba78cff760>)

fake: Timezone

Aliases: timezone

Source: faker : faker.providers.date_time.en_US.Provider.timezone

Recipe:

- var: snowfakery_locale
  value: en_US
- 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.

Example:: 1061306726

Aliases: unix_time, unixtime

Source: faker : faker.providers.date_time.en_US.Provider.unix_time

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.UnixTime}}

Outputs:

SomeObject(id=1, formula_field_example=903170602)

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Slug}}

Outputs:

SomeObject(id=1, formula_field_example=much-mention)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FileExtension}}

Outputs:

SomeObject(id=1, formula_field_example=webm)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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|.

Aliases: file_name, filename

Source: faker : faker.providers.file.Provider.file_name

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FileName(category='audio')}}

Outputs:

SomeObject(id=1, formula_field_example=much.mp3)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FileName(extension='abcdef')}}

Outputs:

SomeObject(id=1, formula_field_example=why.abcdef)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FileName(category='audio', extension='abcdef')}}

Outputs:

SomeObject(id=1, formula_field_example=floor.abcdef)

fake: FilePath

Generate an absolute 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.

Aliases: file_path, filepath

Source: faker : faker.providers.file.Provider.file_path

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FilePath(depth=3)}}

Outputs:

SomeObject(id=1, formula_field_example=/someone/challenge/father/chair.png)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FilePath(depth=5, category='video')}}

Outputs:

SomeObject(id=1, formula_field_example=/four/leader/health/blood/opportunity/marriage.mov)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.FilePath(depth=5, category='video', extension='abcdef')}}

Outputs:

SomeObject(id=1, formula_field_example=/serve/better/address/whole/official/why.abcdef)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.MimeType}}

Outputs:

SomeObject(id=1, formula_field_example=video/x-ms-wmv)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.UnixDevice}}

Outputs:

SomeObject(id=1, formula_field_example=/dev/vdq)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.UnixPartition}}

Outputs:

SomeObject(id=1, formula_field_example=/dev/vdm4)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.LocationOnLand}}

Outputs:

SomeObject(id=1, formula_field_example=('46.65581', '32.6178', 'Kherson', 'UA', 'Europe/Kiev'))

fake: Longitude

Aliases: longitude

Source: faker : faker.providers.geo.en_US.Provider.longitude

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.HttpMethod}}

Outputs:

SomeObject(id=1, formula_field_example=GET)

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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.ImageUrl}}

Outputs:

SomeObject(id=1, formula_field_example=https://placekitten.com/621/976)

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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

Aliases: mac_address, macaddress

Source: faker : faker.providers.internet.en_US.Provider.mac_address

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.MacAddress}}

Outputs:

SomeObject(id=1, formula_field_example=47:30:80:4b:9e:32)

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Tld}}

Outputs:

SomeObject(id=1, formula_field_example=com)

fake: Uri

Aliases: uri

Source: faker : faker.providers.internet.en_US.Provider.uri

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Uri}}

Outputs:

SomeObject(id=1, formula_field_example=http://moon.com/categories/category/homepage.htm)

fake: UriExtension

Aliases: uri_extension, uriextension

Source: faker : faker.providers.internet.en_US.Provider.uri_extension

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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.en_US.Provider.paragraphs

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Paragraphs(nb=5)}}

Outputs:

SomeObject(id=1, formula_field_example=['Security stock ball organization recognize civil. Pm her then nothing increase.', 'Industry product another knowledge else citizen month. Traditional page a although for study anyone. Could yourself plan base rise would.', 'First degree response able state more. Couple part cup few. Beyond take however ball.', 'Son break either president stage population boy. Everything affect American race.', 'Water voice travel among see red. Republican total policy head Mrs debate onto. Catch even front.'])

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Paragraphs(nb=5, ext_word_list=['abc', 'def', 'ghi',
      'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=['Def ghi abc abc. Def def ghi def def abc abc abc. Ghi def jkl def abc ghi def.', 'Abc abc def abc def ghi. Jkl ghi def jkl. Abc abc ghi abc.', 'Def ghi def def.', 'Def def jkl def jkl. Abc abc jkl jkl abc ghi. Abc def abc abc jkl. Ghi abc def def jkl.', 'Jkl abc def ghi jkl def jkl def. Jkl ghi jkl ghi jkl abc ghi.'])

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.en_US.Provider.sentences

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Sentences}}

Outputs:

SomeObject(id=1, formula_field_example=['Partner stock four.', 'Region as true develop sound central.', 'Language ball floor meet usually board necessary.'])

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Sentences(nb=5)}}

Outputs:

SomeObject(id=1, formula_field_example=['Hospital have wonder already.', 'Create wife responsibility.', 'Decision song view age international big employee.', 'Author feeling job article level.', 'Beyond write current grow rule stuff truth college.'])

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Sentences(nb=5, ext_word_list=['abc', 'def', 'ghi',
      'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=['Jkl abc ghi jkl def.', 'Abc jkl ghi abc ghi.', 'Jkl jkl ghi def ghi abc ghi.', 'Ghi def abc def abc jkl def.', 'Ghi ghi jkl jkl abc.'])

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.en_US.Provider.texts

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Texts(nb_texts=5)}}

Outputs:

SomeObject(id=1, formula_field_example=['Place full buy radio perform small camera treatment. True their race special million. Although hot he couple ground.', 'Between similar safe air. Issue indicate market ten foot education good. Grow ahead girl act.\nAudience throw debate daughter purpose voice. Security fall ready usually.', 'Player contain year bill ok choose today. Source firm drug senior.\nInformation animal car after back available. Federal indicate unit opportunity fear great.', 'Painting child reflect up control instead company. Future model green place beat sense far.', 'Three report know second government the pull. Other along society figure future. Teacher three seven attention team executive care.'])

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Texts(nb_texts=5, max_nb_chars=50)}}

Outputs:

SomeObject(id=1, formula_field_example=['Partner stand next though house where.', 'Blue tonight particular smile represent since.', 'Eat expect save process score middle.', 'Grow push region produce develop story drive.', 'Foreign one agent candidate how wish member.'])

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Texts(nb_texts=5, max_nb_chars=50, ext_word_list=['abc',
      'def', 'ghi', 'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=['Abc abc abc def ghi. Ghi jkl abc jkl.', 'Ghi ghi abc abc def abc def. Def abc abc ghi jkl.', 'Def ghi ghi. Def def abc abc. Abc ghi abc.', 'Def def abc def jkl ghi def.', 'Jkl def def abc abc jkl ghi. Abc abc jkl abc.'])

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.

.. 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.en_US.Provider.words

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Words}}

Outputs:

SomeObject(id=1, formula_field_example=['six', 'field', 'live'])

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Words(nb=5)}}

Outputs:

SomeObject(id=1, formula_field_example=['total', 'financial', 'role', 'together', 'range'])

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Words(nb=5, ext_word_list=['abc', 'def', 'ghi',
      'jkl'])}}

Outputs:

SomeObject(id=1, formula_field_example=['def', 'abc', 'def', 'ghi', 'jkl'])

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Words(nb=4, ext_word_list=['abc', 'def', 'ghi',
      'jkl'], unique=True)}}

Outputs:

SomeObject(id=1, formula_field_example=['jkl', 'def', 'ghi', 'abc'])

Misc Fakers

fake: Binary

Generate a random binary blob of length bytes.

Aliases: binary

Source: faker : faker.providers.misc.en_US.Provider.binary

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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, MS 42056"
"Dr. Drew Castro III","1122 David Squares Suite 848
Port Martin, TX 77807"
"Regina Delgado DVM","Unit 5159 Box 1795
DPO AE 32356"
"Hayden Bryant","PSC 5256, Box 0123
APO AE 75718"
"Mr. Corey Walter","PSC 9916, Box 1510
APO AP 03336"
"Mr. Corey Yates IV","691 Cox Forges
Lake Tylerstad, HI 08501"
)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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","Mrs. Sabrina Patterson DVM","PSC 4579, Box 2302
APO AE 45368","blue"
"2","Carla Trevino","Unit 2076 Box 9845
DPO AA 86696","olive"
"3","Steve Mccullough Jr.","Unit 1508 Box 4237
DPO AA 80472","olive"
"4","Ms. Valerie Vega","Unit 6109 Box 3523
DPO AE 84046","lime"
"5","Tracie Donaldson DVM","960 Hannah Circles Suite 278
Irwinside, WV 00510","white"
"6","Randall Dominguez","USCGC Collins
FPO AA 25142","blue"
"7","Mr. Alex Christensen","Unit 5030 Box 0891
DPO AE 16085","silver"
"8","Dr. Hunter Lam III","1047 Ricky Dale Suite 124
North Calvinborough, KS 73685","purple"
"9","Mrs. Toni Shields","Unit 7658 Box 2369
DPO AA 01667","green"
"10","Hayden Miles MD","USS Thornton
FPO AP 05175","black"
)

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: en_US
- 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, MS 42056"
Dr. Drew Castro III,"1122 David Squares Suite 848
Port Martin, TX 77807"
Regina Delgado DVM,"Unit 5159 Box 1795
DPO AE 32356"
Hayden Bryant,"PSC 5256, Box 0123
APO AE 75718"
Mr. Corey Walter,"PSC 9916, Box 1510
APO AP 03336"
Mr. Corey Yates IV,"691 Cox Forges
Lake Tylerstad, HI 08501"
)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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    Mrs. Sabrina Patterson DVM  "PSC 4579, Box 2302
APO AE 45368"
2   Carla Trevino   "Unit 2076 Box 9845
DPO AA 86696"
3   Cheyenne Skinner    "150 Tucker Garden Suite 594
Rachaelberg, ME 51359"
4   Stacey Hughes MD    "PSC 5233, Box 7696
APO AE 53226"
5   Summer Velez MD "PSC 7142, Box 7878
APO AP 99523"
6   Arthur Roman    "USNV Moses
FPO AA 07035"
7   Darlene Conley MD   "PSC 0665, Box 0300
APO AP 69752"
8   Mr. Collin Shields  "PSC 4421, Box 7610
APO AA 59873"
9   Dr. Dakota Wilkerson    "USS Rasmussen
FPO AE 36992"
10  Barry Ramirez   "PSC 4855, Box 9097
APO AP 84930"
)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Dsv(data_columns=('{{name}}', '{{address}}'), num_rows=5,
      delimiter='$')}}

Outputs:

SomeObject(id=1, formula_field_example="Dr. Kathryn Rasmussen DDS"$"PSC 6940, Box 2245
APO AA 48630"
"Dr. William Green"$"29456 Tom Crescent Suite 304
Port Lauren, CA 40172"
"Joanna Craig DVM"$"775 Harrison Neck
Lake Katrinachester, ME 44420"
"Derek Brennan DDS"$"33060 Cindy Point
Heidifort, OR 94139"
"Dr. Cameron Luna IV"$"USNS Hammond
FPO AE 47492"
)

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: en_US
- 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

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: en_US
- 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: en_US
- 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: en_US
- 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: 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Md5(raw_output=False)}}

Outputs:

SomeObject(id=1, formula_field_example=3e92bfaaa510a799067f34c18e175ab3)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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, MS 42056"
"Dr. Drew Castro III"|"1122 David Squares Suite 848
Port Martin, TX 77807"
"Regina Delgado DVM"|"Unit 5159 Box 1795
DPO AE 32356"
"Hayden Bryant"|"PSC 5256, Box 0123
APO AE 75718"
"Mr. Corey Walter"|"PSC 9916, Box 1510
APO AP 03336"
"Mr. Corey Yates IV"|"691 Cox Forges
Lake Tylerstad, HI 08501"
)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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"|"Mrs. Sabrina Patterson DVM"|"PSC 4579, Box 2302
APO AE 45368"|"blue"
"2"|"Carla Trevino"|"Unit 2076 Box 9845
DPO AA 86696"|"olive"
"3"|"Steve Mccullough Jr."|"Unit 1508 Box 4237
DPO AA 80472"|"olive"
"4"|"Ms. Valerie Vega"|"Unit 6109 Box 3523
DPO AE 84046"|"lime"
"5"|"Tracie Donaldson DVM"|"960 Hannah Circles Suite 278
Irwinside, WV 00510"|"white"
"6"|"Randall Dominguez"|"USCGC Collins
FPO AA 25142"|"blue"
"7"|"Mr. Alex Christensen"|"Unit 5030 Box 0891
DPO AE 16085"|"silver"
"8"|"Dr. Hunter Lam III"|"1047 Ricky Dale Suite 124
North Calvinborough, KS 73685"|"purple"
"9"|"Mrs. Toni Shields"|"Unit 7658 Box 2369
DPO AA 01667"|"green"
"10"|"Hayden Miles MD"|"USS Thornton
FPO AP 05175"|"black"
)

fake: Sha1

Generate a random SHA1 hash.

If raw_output is False (default), a hexadecimal string representation of the SHA1 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Sha1(raw_output=False)}}

Outputs:

SomeObject(id=1, formula_field_example=02347357d13590815eb822d13e8366e27cf35e1b)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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, MS 42056"
"Dr. Drew Castro III"   "1122 David Squares Suite 848
Port Martin, TX 77807"
"Regina Delgado DVM"    "Unit 5159 Box 1795
DPO AE 32356"
"Hayden Bryant" "PSC 5256, Box 0123
APO AE 75718"
"Mr. Corey Walter"  "PSC 9916, Box 1510
APO AP 03336"
"Mr. Corey Yates IV"    "691 Cox Forges
Lake Tylerstad, HI 08501"
)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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" "Mrs. Sabrina Patterson DVM"    "PSC 4579, Box 2302
APO AE 45368"   "blue"
"2" "Carla Trevino" "Unit 2076 Box 9845
DPO AA 86696"   "olive"
"3" "Steve Mccullough Jr."  "Unit 1508 Box 4237
DPO AA 80472"   "olive"
"4" "Ms. Valerie Vega"  "Unit 6109 Box 3523
DPO AE 84046"   "lime"
"5" "Tracie Donaldson DVM"  "960 Hannah Circles Suite 278
Irwinside, WV 00510"    "white"
"6" "Randall Dominguez" "USCGC Collins
FPO AA 25142"   "blue"
"7" "Mr. Alex Christensen"  "Unit 5030 Box 0891
DPO AE 16085"   "silver"
"8" "Dr. Hunter Lam III"    "1047 Ricky Dale Suite 124
North Calvinborough, KS 73685"  "purple"
"9" "Mrs. Toni Shields" "Unit 7658 Box 2369
DPO AA 01667"   "green"
"10"    "Hayden Miles MD"   "USS Thornton
FPO AP 05175"   "black"
)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Uuid4}}

Outputs:

SomeObject(id=1, formula_field_example=eb1167b3-67a9-4378-bc65-c1e582e2e662)

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Prefix}}

Outputs:

SomeObject(id=1, formula_field_example=Dr.)

fake: PrefixFemale

Aliases: prefix_female, prefixfemale

Source: faker : faker.providers.person.en_US.Provider.prefix_female

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Suffix}}

Outputs:

SomeObject(id=1, formula_field_example=PhD)

fake: SuffixFemale

Aliases: suffix_female, suffixfemale

Source: faker : faker.providers.person.en_US.Provider.suffix_female

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.SuffixNonbinary}}

Outputs:

SomeObject(id=1, formula_field_example=Jr.)

Phone_Number Fakers

fake: CountryCallingCode

Aliases: country_calling_code, countrycallingcode

Source: faker : faker.providers.phone_number.en_US.Provider.country_calling_code

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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(1947, 5, 1)})

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: en_US
- 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(1945, 12, 22)})

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Bothify(letters='ABCDE')}}

Outputs:

SomeObject(id=1, formula_field_example=75 EB)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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).
  • 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.RandomDigit}}

Outputs:

SomeObject(id=1, formula_field_example=0)

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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 is None (default), its value will be set to a random integer from 1 to 9.
  • If fix_len is False (default), all integers that do not exceed the number of digits can be generated.
  • If fix_len is True, only integers with the exact number of digits can be generated.

Aliases: random_number, randomnumber

Source: faker : faker.providers.user_agent.Provider.random_number

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.RandomNumber(fix_len=False)}}

Outputs:

SomeObject(id=1, formula_field_example=521760889)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.RandomNumber(fix_len=True)}}

Outputs:

SomeObject(id=1, formula_field_example=9268)

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.RandomNumber(digits=3)}}

Outputs:

SomeObject(id=1, formula_field_example=143)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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 is False (default), allow generation up to 140% of number. If True, upper bound generation is capped at 100%.
  • If ge is False (default), allow generation down to 60% of number. If True, lower bound generation is capped at 100%.
  • If a numerical value for min is provided, generated values less than min will be clamped at min.
  • If a numerical value for max is provided, generated values greater than max will be clamped at max.
  • If both le and ge are True, the value of number will automatically be returned, regardless of the values supplied for min and max.

Aliases: randomize_nb_elements, randomizenbelements

Source: faker : faker.providers.user_agent.Provider.randomize_nb_elements

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.RandomizeNbElements(number=100)}}

Outputs:

SomeObject(id=1, formula_field_example=65)

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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

Aliases: pybool

Source: faker : faker.providers.python.Provider.pybool

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Pydecimal}}

Outputs:

SomeObject(id=1, formula_field_example=2.0665030089131933e+91)

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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Pydict}}

Outputs:

SomeObject(id=1, formula_field_example={'capital': 'jimmybrennan@example.net', 'measure': 1424, 'business': 'QklufCpVOLlelZEijfQS', 'scene': 'UxJgukcXlhktChZZhvJT', 'modern': Decimal('-738930555082492694711801320407522758688091891634896769930024894.174466602234500762791256097670172009925185'), 'last': 'tOzTFyGrgJGPgVPVTJQA', 'always': 'butjsGXUcnbBDTlOUGAB', 'five': datetime.datetime(1990, 10, 11, 13, 27, 22), 'government': 'hUvefdviXPwvzSqnsgJr', 'simple': 'aYQdUkkJWgatbFSjfrXg'})

fake: Pyfloat

Aliases: pyfloat

Source: faker : faker.providers.python.Provider.pyfloat

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Pyiterable}}

Outputs:

SomeObject(id=1, formula_field_example=['YJFjFkpJjyVGbVPgnHQH', 'ToacJDXWVcMKILUHtBkE', 'horteObohEsZgfLWqSLp', 4902, 1780, 'DzrPQggzbrJiiDPZeQkl'])

fake: Pylist

Aliases: pylist

Source: faker : faker.providers.python.Provider.pylist

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Pylist}}

Outputs:

SomeObject(id=1, formula_field_example=['ToacJDXWVcMKILUHtBkE', 'horteObohEsZgfLWqSLp', 4902, 1780, 'DzrPQggzbrJiiDPZeQkl', 128, 'uAxzEJvtZnOwsdSKUxJg', 4202, 'HZPGfxsRfFzDHwBJURZH', 'CWaKMqqBTFitpKyPAVdg'])

fake: Pyset

Aliases: pyset

Source: faker : faker.providers.python.Provider.pyset

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Pyset}}

Outputs:

SomeObject(id=1, formula_field_example={128, 'horteObohEsZgfLWqSLp', 'DzrPQggzbrJiiDPZeQkl', 4902, 'uAxzEJvtZnOwsdSKUxJg', 4202, 'HZPGfxsRfFzDHwBJURZH', 'CWaKMqqBTFitpKyPAVdg', 1780, 'ToacJDXWVcMKILUHtBkE'})

fake: Pystr

Generates a random string of upper and lowercase letters.

Return:: Random of random length between min and max characters.

Aliases: pystr

Source: faker : faker.providers.python.Provider.pystr

Recipe:

- var: snowfakery_locale
  value: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Pystruct}}

Outputs:

SomeObject(id=1, formula_field_example=([4592, 'https://www.ferrell-sandoval.com/category/faq/', 'skrmRjtBniXUbBcwfPkp', 'http://zamora.com/', 254741648.616761, 'bFIwqhXnKFPyWkjNxMRv', 'XfNsTSZAzlcVfwfbrfoZ', datetime.datetime(1997, 3, 18, 5, 37, 20), 3522, 5766], {'government': -6733332.90012816, 'actually': Decimal('52859211313730654594780476370896539542243156244926012.6119381357891229990743807100932738499125809548394'), 'evidence': -4929620.7802481, 'compare': 'cVpkImDNIqGGbxGtiVaS', 'hope': 306, 'position': 'rbowen@example.com', 'store': 'HkvKgkeWNhmIYlSwSaBv', 'seem': 'IaueSbJyAntwxzRGSABG', 'benefit': 'AKogkpkpcwJaifvTnusi', 'wait': 'OzsnDEZBIjaDLJUXPzjQ'}, {'treat': {0: 'lVypwMSQgYyXiWkToRiS', 1: ['emarshall@example.org', 3009, 'RcbMeMeWhDHtezrUklFx'], 2: {0: 1683593411808.95, 1: 'WgWnPqxKCNudrUPWErzz', 2: ['tLrieoxPGihDDJxTduYy', 'vbVQgQrFzxFVvbSXPivN']}}, 'those': {1: 'sLRFQamwyQjDBHaceuFM', 2: ['youngcalvin@example.com', 4636, 'RbqvkAsmbzYcRrLDlkpq'], 3: {1: 23.4850800857031, 2: 'XPfDPVitlNgGTJscGlAz', 3: ['http://www.byrd.com/', 'gYZGjvaPhALIovWdmnrf']}}, 'thing': {2: 'UfYJshgMPNjUmVVEmykw', 3: [1692, 'yGAdNuzQqhcJdEdfupfW', 'http://www.knapp-todd.net/homepage.htm'], 4: {2: 'iHXBhsAwhFTYjIbhAFmM', 3: datetime.datetime(1977, 1, 27, 2, 45, 37), 4: ['nshort@example.net', Decimal('-913064853954172017454705535556306984690815.621')]}}, 'involve': {3: Decimal('-958579803233121098199677609858329484698.079936484159484771945165015918390004718073484436977450999415126745493287747112804555065247088454'), 4: ['http://landry.org/search.php', 'https://osborne.com/homepage.htm', 'TcxtSRqJxnKyKMDnhawI'], 5: {3: 'http://farrell-thornton.com/homepage.htm', 4: 'MmBaQqBTLfmQCqPmzzjn', 5: ['sJSMGlaSNXhYrDbPWXih', datetime.datetime(1982, 9, 15, 0, 55, 30)]}}, 'other': {4: 'tOrZJtdjXDPlBFWAWqEG', 5: ['GsyxusqnPrOttTshYkEZ', 9611, 'NtbvVQecuGkaKlFzXFZW'], 6: {4: 'qiRgGiTlgaVPqSAlDbKo', 5: 254, 6: [-96055.2871504, 'http://ritter.net/wp-content/category/']}}, 'wide': {5: datetime.datetime(1989, 11, 26, 7, 24, 51), 6: [1699, 5193962071.17089, 'sTEifZnojoXtvrEBnfCC'], 7: {5: 'bLFPUElwXeZnNrLZcgQQ', 6: 5486, 7: [datetime.datetime(2010, 4, 27, 1, 17, 11), 'http://www.massey.com/categories/main/list/home/']}}, 'American': {6: 'TpDfyVlmcDyCmTlQrLfx', 7: ['ydavidson@example.com', 'PIFRvwugFzPFrSopTYll', 'http://miranda.com/faq.asp'], 8: {6: 'McXprbCfoMPcsPNgJTTB', 7: 'RNbEvofgimzFnkBzdluW', 8: [Decimal('3126764938086279204697796583148.3543864465531443136825367348561977121844066309206656604799010298'), 'iSrhpNzHoGmaLwpBtPYH']}}, 'evidence': {7: 4542, 8: ['MdXZUUXFRjxbswjLjiMV', 'pXEcbNItnQLoBZYdwfMZ', 'rlnssAMBUdIIWDKxdfxG'], 9: {7: 3024, 8: 9197, 9: ['rohYDCqPjIIWRxLAhCLW', datetime.datetime(1984, 1, 8, 15, 43, 2)]}}, 'race': {8: 'lutzchristy@example.com', 9: [541269079.750005, 'DDOOkijmemuGbFKUIDpt', 'http://guzman-melton.org/index.html'], 10: {8: 7554, 9: 'qMOdIwkkQJvyiZBdvTqM', 10: ['DYrGLJviYBRwOaYdpyCW', 'https://www.mccormick-baldwin.info/']}}, 'main': {9: 94154211.549681, 10: ['mOHctFgWjFdnhNYUlHVI', 'PzhdTEUHXuOOzPfhtqBI', 'SJTGkApmjdoTABfXgYjc'], 11: {9: datetime.datetime(1972, 2, 11, 6, 39, 11), 10: 'https://www.nguyen.com/main.php', 11: ['GQHKoyYfmoOFLMUCtVnt', 'vWPoUhrkwBdjGReXAOds']}}}))

fake: Pytuple

Aliases: pytuple

Source: faker : faker.providers.python.Provider.pytuple

Recipe:

- var: snowfakery_locale
  value: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Pytuple}}

Outputs:

SomeObject(id=1, formula_field_example=('ToacJDXWVcMKILUHtBkE', 'horteObohEsZgfLWqSLp', 4902, 1780, 'DzrPQggzbrJiiDPZeQkl', 128, 'uAxzEJvtZnOwsdSKUxJg', 4202, 'HZPGfxsRfFzDHwBJURZH', 'CWaKMqqBTFitpKyPAVdg'))

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.Firefox}}

Outputs:

SomeObject(id=1, formula_field_example=Mozilla/5.0 (Windows NT 10.0; de-BE; rv:1.9.0.20) Gecko/2015-11-23 10:33:37 Firefox/11.0)

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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- 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: en_US
- object: SomeObject
  fields:
    formula_field_example: ${{fake.WindowsPlatformToken}}

Outputs:

SomeObject(id=1, formula_field_example=Windows NT 5.01)