Fake Data: Japanese as spoken in Japan (ja_JP)¶
The basic concepts of fake data are described in the main tutorial.
Our fake data can be localized to many languages. We have detailed docs about the other languages.
Current Locale: ja_JP (Japan)
- Fake Data: Japanese as spoken in Japan (ja_JP)
- Commonly Used
- Rarely Used
- Salesforce Fakers
- Address Fakers
- Automotive Fakers
- Bank Fakers
- Barcode Fakers
- Color Fakers
- Company Fakers
- Credit_Card Fakers
- Currency Fakers
- Date_Time Fakers
- fake: AmPm
- fake: Century
- fake: Date
- fake: DateBetween
- fake: DateBetweenDates
- fake: DateObject
- fake: DateOfBirth
- fake: DateThisCentury
- fake: DateThisDecade
- fake: DateThisMonth
- fake: DateThisYear
- fake: DayOfMonth
- fake: FutureDate
- fake: Month
- fake: PastDate
- fake: PastDatetime
- fake: Pytimezone
- fake: TimeDelta
- fake: TimeObject
- fake: TimeSeries
- fake: Timezone
- fake: UnixTime
- Decorators.Py Fakers
- Emoji Fakers
- File Fakers
- Geo Fakers
- Internet Fakers
- fake: Dga
- fake: HttpMethod
- fake: HttpStatusCode
- fake: IanaId
- fake: ImageUrl
- fake: Ipv4
- fake: Ipv4NetworkClass
- fake: Ipv4Private
- fake: Ipv4Public
- fake: Ipv6
- fake: MacAddress
- fake: NicHandle
- fake: NicHandles
- fake: PortNumber
- fake: RipeId
- fake: Tld
- fake: Uri
- fake: UriExtension
- fake: UriPage
- fake: UriPath
- fake: Url
- Isbn Fakers
- Ja_Jp Fakers
- fake: AdministrativeUnit
- fake: Ban
- fake: BuildingName
- fake: Chome
- fake: CompanyCategory
- fake: CompanyPrefix
- fake: DayOfWeek
- fake: FirstKanaName
- fake: FirstKanaNameFemale
- fake: FirstKanaNameMale
- fake: FirstNameFemalePair
- fake: FirstNameMalePair
- fake: FirstNamePair
- fake: FirstRomanizedName
- fake: FirstRomanizedNameFemale
- fake: FirstRomanizedNameMale
- fake: Gou
- fake: Jan
- fake: Jan13
- fake: Jan8
- fake: KanaName
- fake: KanaNameFemale
- fake: KanaNameMale
- fake: LastKanaName
- fake: LastNamePair
- fake: LastRomanizedName
- fake: MonthName
- fake: Postcode
- fake: Prefecture
- fake: RomanizedName
- fake: RomanizedNameFemale
- fake: RomanizedNameMale
- fake: Town
- fake: TraditionalMonthName
- fake: Zipcode
- Job Fakers
- Lorem Fakers
- Misc Fakers
- Passport Fakers
- Person Fakers
- Phone_Number Fakers
- Profile Fakers
- Providers Fakers
- fake: Bothify
- fake: Hexify
- fake: LanguageCode
- fake: Lexify
- fake: Locale
- fake: Numerify
- fake: RandomChoices
- fake: RandomDigit
- fake: RandomDigitAboveTwo
- fake: RandomDigitNotNull
- fake: RandomDigitNotNullOrEmpty
- fake: RandomDigitOrEmpty
- fake: RandomElement
- fake: RandomElements
- fake: RandomInt
- fake: RandomLetter
- fake: RandomLetters
- fake: RandomLowercaseLetter
- fake: RandomNumber
- fake: RandomSample
- fake: RandomUppercaseLetter
- fake: RandomizeNbElements
- Python Fakers
- Sbn Fakers
- Ssn Fakers
- User_Agent Fakers
Commonly Used¶
Salesforce Fakers¶
fake: Email¶
Email address using one of the "example" domains
Aliases: email
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.email
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=淳, LastName=岡本, Email=sakamotonaoto@example.net)
Contact(id=2, FirstName=幹 Sam, LastName=直子 Senior, Email=manabuyamamoto@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:
- var: snowfakery_locale
value: ja_JP
- object: Account
fields:
Name:
fake: Company
BillingPostalCode:
fake: postalcode
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingPostalCode: ${{fake.Postalcode}}
Outputs:
Account(id=1, Name=前田情報有限会社, BillingPostalCode=063-8989)
Account(id=2, Name=株式会社藤原電気 Holdings, BillingPostalCode=727-0018)
fake: State¶
Return a state, province or other appropriate administrative unit
Aliases: state
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.state
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: Account
fields:
Name:
fake: Company
BillingState:
fake: State
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingState: ${{fake.State}}
Outputs:
Account(id=1, Name=合同会社前田農林, BillingState=山形県)
Account(id=2, Name=岡田ガス株式会社 Holdings, BillingState=長野県)
Address Fakers¶
fake: Country¶
Aliases: country
Source: faker : faker.providers.address.ja_JP.Provider.country
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: Account
fields:
Name:
fake: Company
BillingCountry:
fake: Country
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingCountry: ${{fake.Country}}
Outputs:
Account(id=1, Name=渡辺通信有限会社, BillingCountry=ジブラルタル)
Account(id=2, Name=有限会社山田建設 Holdings, BillingCountry=スウェーデン)
fake: CurrentCountry¶
Aliases: current_country, currentcountry
Source: faker : faker.providers.address.ja_JP.Provider.current_country
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: Account
fields:
Name:
fake: Company
BillingCountry:
fake: CurrentCountry
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingCountry: ${{fake.CurrentCountry}}
Outputs:
Account(id=1, Name=株式会社高橋農林, BillingCountry=Japan)
Account(id=2, Name=三浦情報有限会社 Holdings, BillingCountry=Japan)
fake: StreetAddress¶
Example:: '791 Crist Parks'
Aliases: street_address, streetaddress
Source: faker : faker.providers.address.ja_JP.Provider.street_address
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: Account
fields:
Name:
fake: Company
BillingStreet:
fake: StreetAddress
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingStreet: ${{fake.StreetAddress}}
Outputs:
Account(id=1, Name=中島水産株式会社, BillingStreet=098 鈴木 Street)
Account(id=2, Name=合同会社石井農林 Holdings, BillingStreet=510 佐々木 Street)
Company Fakers¶
fake: CatchPhrase¶
Example:: 'Robust full-range hub'
Aliases: catch_phrase, catchphrase
Source: faker : faker.providers.company.ja_JP.Provider.catch_phrase
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=森電気株式会社, Description=Centralized motivating Local Area Network)
Account(id=2, Name=合同会社山本銀行 Holdings, Description=Our Motto: Object-based dedicated firmware)
fake: Company¶
Example:: 'Acme Ltd'
Aliases: company
Source: faker : faker.providers.company.ja_JP.Provider.company
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: Account
fields:
Name:
fake: Company
- object: Account
fields:
Name: ${{fake.Company}} Holdings
Outputs:
Account(id=1, Name=合同会社吉田鉱業)
Account(id=2, Name=長谷川食品株式会社 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.ja_JP.Provider.time
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Time}}
Outputs:
SomeObject(id=1, formula_field_example=22:07:02)
fake: Year¶
Aliases: year
Source: faker : faker.providers.date_time.ja_JP.Provider.year
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: Student
fields:
GraduationYear:
fake: year
- object: Student
fields:
GraduationYear: ${{year}}
Outputs:
Student(id=1, GraduationYear=1997)
Student(id=2, GraduationYear=)
Ja_Jp Fakers¶
fake: City¶
Example:: '台東区'
Aliases: city
Source: faker : faker.providers.address.ja_JP.Provider.city
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: Account
fields:
Name:
fake: Company
BillingCity:
fake: City
- object: Account
fields:
Name: ${{fake.Company}} Holdings
BillingCity: ${{fake.City}}
Outputs:
Account(id=1, Name=合同会社木村情報, BillingCity=西多摩郡奥多摩町)
Account(id=2, Name=有限会社山本銀行 Holdings, BillingCity=八街市)
fake: FirstName¶
Example:: '明美'
Aliases: first_name, firstname
Source: faker : faker.providers.person.ja_JP.Provider.first_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=修平, LastName=森)
Contact(id=2, FirstName=亮介 Sam, LastName=山崎-Jones)
fake: FirstNameFemale¶
Example:: '明美'
Aliases: first_name_female, firstnamefemale
Source: faker : faker.providers.person.ja_JP.Provider.first_name_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=幹, LastName=前田)
Contact(id=2, FirstName=桃子 Beth, LastName=木村-Jones)
fake: FirstNameMale¶
Example:: '晃'
Aliases: first_name_male, firstnamemale
Source: faker : faker.providers.person.ja_JP.Provider.first_name_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=治, LastName=藤原)
Contact(id=2, FirstName=洋介 Beth, LastName=山下-Jones)
fake: LastName¶
Example:: '佐藤'
Aliases: last_name, lastname
Source: faker : faker.providers.person.ja_JP.Provider.last_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=七夏, LastName=小川)
Contact(id=2, FirstName=稔 Sam, LastName=直樹 Senior)
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.ja_JP.Provider.paragraph
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Paragraph(nb_sentences=5)}}
Outputs:
SomeObject(id=1, formula_field_example=必要目的パンパーセント仕上げ電池デフォルト。保持する符号クルークルーダイヤモンド雪目的。革新ピックヒール鉱山はトレーナー。再現するトリビュートコーナーダッシュ。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Paragraph(nb_sentences=5, variable_nb_sentences=False)}}
Outputs:
SomeObject(id=1, formula_field_example=偏差ダッシュ移動動物普通の持ってるコンペ。部隊溝残るカラムパン。反射協力クールコミュニティボトル。バスケット画面ピックキャビン部隊試してみる。スマッシュデフォルト管理する。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=Defdefabcghi。Jklghiabcabcdefjklabc。Abcjklghiabcghijkl。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=Jkldefabcabcjkljkl。Ghiabcghiabcdefghiabc。Jkldefabcdefdefjkljkl。Ghijklghiabc。Defabcabcghi。)
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.ja_JP.Provider.sentence
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Sentence(nb_words=10)}}
Outputs:
SomeObject(id=1, formula_field_example=見出し暖かい腐った尿特徴君はタワー敵衝突連続。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Sentence(nb_words=10, variable_nb_words=False)}}
Outputs:
SomeObject(id=1, formula_field_example=転倒〜ささやき欠乏犯罪者分割高い緩む君は戦略的。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=Defabcjkldefabcabcjklabcjkldefabcghiabc。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=Jkljkljkljklghidefghi。)
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.ja_JP.Provider.text
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Text(max_nb_chars=20)}}
Outputs:
SomeObject(id=1, formula_field_example=日曜日溝バスケット合計バスケット屋根裏。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Text(max_nb_chars=80)}}
Outputs:
SomeObject(id=1, formula_field_example=リンク持っていました緩むブランチ。保証金学生カラムリンク溝今日革新。ログ奨励しますデフォルト自体オークション再現するトリビュート。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Text(max_nb_chars=160)}}
Outputs:
SomeObject(id=1, formula_field_example=今日ない特徴叔父軸デフォルト。副舗装奨励します癌カレッジリフトコーナー。トス主婦ダッシュ。
擁する尊敬する叔父バスケット。教会コピー欠乏コミュニケーションタワー普通の移動フェミニスト。シュガー本質的な証言する憲法ささやき電話ホイール。)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Text(ext_word_list=['abc', 'def', 'ghi', 'jkl'])}}
Outputs:
SomeObject(id=1, formula_field_example=Defghidefdef。
Defdefjkldefjkl。Abcabcjkljklabcghi。Abcdefabcabcjkl。Ghiabcdefdefjkl。
Jklabcdefghijkldefjkldef。Jklghijklghijklabcghi。
Abcabcdefjkljklghi。Abcabcjklabcabcabcabc。Defabcabcghijklghijkl。)
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.ja_JP.Provider.word
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Word}}
Outputs:
SomeObject(id=1, formula_field_example=メニュー)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: FirstNameNonbinary¶
Aliases: first_name_nonbinary, firstnamenonbinary
Source: faker : faker.providers.person.ja_JP.Provider.first_name_nonbinary
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=陽一, LastName=清水)
Contact(id=2, FirstName=明美 Mary-John, LastName=森-Jones)
Phone_Number Fakers¶
fake: PhoneNumber¶
Aliases: phone_number, phonenumber
Source: faker : faker.providers.phone_number.ja_JP.Provider.phone_number
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=田中保険合同会社, Phone=070-1609-7535)
Account(id=2, Name=株式会社石井建設 Holdings, Phone=080-2871-1587 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateTime}}
Outputs:
SomeObject(id=1, formula_field_example=2015-06-28 16:53:49.368717+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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateTimeBetween}}
Outputs:
SomeObject(id=1, formula_field_example=2010-07-02 18:21:27.508708+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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateTimeBetweenDates}}
Outputs:
SomeObject(id=1, formula_field_example=2011-12-03 09:46:09.898379+00:00)
fake: FutureDatetime¶
Aliases: future_datetime, futuredatetime
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.future_datetime
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FutureDatetime}}
Outputs:
SomeObject(id=1, formula_field_example=2024-04-28 12:23:37.385460+00:00)
fake: Iso8601¶
Aliases: iso8601
Source: snowfakery : snowfakery.fakedata.fake_data_generator.FakeNames.iso8601
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Iso8601}}
Outputs:
SomeObject(id=1, formula_field_example=1980-04-13T14:58:54.589274+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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.UserName}}
Outputs:
SomeObject(id=1, formula_field_example=涼平_小川_b341facd-ff0a-40f1-a425-799aa905d750@web-39.ishikawa.org)
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Alias}}
Outputs:
SomeObject(id=1, formula_field_example=健一)
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RealisticMaybeRealEmail}}
Outputs:
SomeObject(id=1, formula_field_example=shota35@example.org)
Address Fakers¶
fake: Address¶
Example:: '791 Crist Parks, Sashabury, IL 86039-9874'
Aliases: address
Source: faker : faker.providers.address.ja_JP.Provider.address
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Address}}
Outputs:
SomeObject(id=1, formula_field_example=鹿児島県横浜市中区横林20丁目4番3号 パーク上野公園565)
fake: BuildingNumber¶
Example:: '791'
Aliases: building_number, buildingnumber
Source: faker : faker.providers.address.ja_JP.Provider.building_number
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.BuildingNumber}}
Outputs:
SomeObject(id=1, formula_field_example=938)
fake: CitySuffix¶
Example:: 'town'
Aliases: city_suffix, citysuffix
Source: faker : faker.providers.address.ja_JP.Provider.city_suffix
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.CitySuffix}}
Outputs:
SomeObject(id=1, formula_field_example=Ville)
fake: CountryCode¶
Aliases: country_code, countrycode
Source: faker : faker.providers.address.ja_JP.Provider.country_code
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.current_country_code
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.CurrentCountryCode}}
Outputs:
SomeObject(id=1, formula_field_example=JP)
fake: StreetName¶
Example:: 'Crist Parks'
Aliases: street_name, streetname
Source: faker : faker.providers.address.ja_JP.Provider.street_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.StreetName}}
Outputs:
SomeObject(id=1, formula_field_example=清水 Street)
fake: StreetSuffix¶
Example:: 'Avenue'
Aliases: street_suffix, streetsuffix
Source: faker : faker.providers.address.ja_JP.Provider.street_suffix
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.StreetSuffix}}
Outputs:
SomeObject(id=1, formula_field_example=Street)
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LicensePlate}}
Outputs:
SomeObject(id=1, formula_field_example=194-EJEY)
fake: Vin¶
Generate vin number.
Aliases: vin
Source: faker : faker.providers.automotive.en_US.Provider.vin
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Vin}}
Outputs:
SomeObject(id=1, formula_field_example=16S1YMFL25CEF0V66)
Bank Fakers¶
fake: Aba¶
Generate an ABA routing transit number.
Aliases: aba
Source: faker : faker.providers.bank.en_GB.Provider.aba
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift}}
Outputs:
SomeObject(id=1, formula_field_example=JDXCGBV4)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift(length=8)}}
Outputs:
SomeObject(id=1, formula_field_example=ZRACGBZA)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift(length=11)}}
Outputs:
SomeObject(id=1, formula_field_example=SHJFGBMLCQ4)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift11}}
Outputs:
SomeObject(id=1, formula_field_example=TZIRGBJTGEV)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Swift8}}
Outputs:
SomeObject(id=1, formula_field_example=SGQEGBSI)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.ean
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean(length=13)}}
Outputs:
SomeObject(id=1, formula_field_example=1578156593879)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean(length=8)}}
Outputs:
SomeObject(id=1, formula_field_example=13933289)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean(prefixes=('00', ))}}
Outputs:
SomeObject(id=1, formula_field_example=0015871484187)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.
This method uses |ean| under the hood with the length
argument
explicitly set to 13
.
If a value for prefixes
is specified, the result will begin with one
of the sequences in prefixes
.
.. note:: Codes starting with a leading zero are treated specially in some barcode readers. For more information on compatibility with UPC-A codes, see |EnUsBarcodeProvider.ean13|.
Aliases: ean13
Source: faker : faker.providers.barcode.ja_JP.Provider.ean13
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean13}}
Outputs:
SomeObject(id=1, formula_field_example=1578156593879)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean13(prefixes=('00', ))}}
Outputs:
SomeObject(id=1, formula_field_example=0040801609750)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean13(prefixes=('45', '49'))}}
Outputs:
SomeObject(id=1, formula_field_example=4939332871155)
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.ja_JP.Provider.ean8
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean8}}
Outputs:
SomeObject(id=1, formula_field_example=42194897)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ean8(prefixes=('00', ))}}
Outputs:
SomeObject(id=1, formula_field_example=00115780)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.localized_ean
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan}}
Outputs:
SomeObject(id=1, formula_field_example=4556593877841)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan(length=13)}}
Outputs:
SomeObject(id=1, formula_field_example=4958398947192)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan(length=8)}}
Outputs:
SomeObject(id=1, formula_field_example=45684838)
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.ja_JP.Provider.localized_ean13
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan13}}
Outputs:
SomeObject(id=1, formula_field_example=4556593877841)
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.ja_JP.Provider.localized_ean8
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LocalizedEan8}}
Outputs:
SomeObject(id=1, formula_field_example=45489242)
Color Fakers¶
fake: Color¶
Generate a color in a human-friendly way.
Under the hood, this method first creates a color represented in the HSV
color model and then converts it to the desired color_format
. The
argument hue
controls the H value according to the following
rules:
- If the value is a number from
0
to360
, it will serve as the H value of the generated color. - If the value is a tuple/list of 2 numbers from 0 to 360, the color's H value will be randomly selected from that range.
- If the value is a valid string, the color's H value will be randomly
selected from the H range corresponding to the supplied string. Valid
values are
'monochrome'
,'red'
,'orange'
,'yellow'
,'green'
,'blue'
,'purple'
, and'pink'
.
The argument luminosity
influences both S and V values and is
partially affected by hue
as well. The finer details of this
relationship are somewhat involved, so please refer to the source code
instead if you wish to dig deeper. To keep the interface simple, this
argument either can be omitted or can accept the following string
values:'bright'
, 'dark'
, 'light'
, or 'random'
.
The argument color_format
controls in which color model the color is
represented. Valid values are 'hsv'
, 'hsl'
, 'rgb'
, or
'hex'
(default).
Aliases: color
Source: faker : faker.providers.color.en_US.Provider.color
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(hue='red')}}
Outputs:
SomeObject(id=1, formula_field_example=#ef6466)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(luminosity='light')}}
Outputs:
SomeObject(id=1, formula_field_example=#f9e38b)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Color(hue=(300, 20), luminosity='random', color_format='hsl')}}
Outputs:
SomeObject(id=1, formula_field_example=hsl(67, 85, 27))
fake: ColorHsl¶
Generate a HSL color tuple in a human-friendly way.
Aliases: color_hsl, colorhsl
Source: faker : faker.providers.color.en_US.Provider.color_hsl
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorHsl}}
Outputs:
SomeObject(id=1, formula_field_example=(207, 76, 65))
fake: ColorHsv¶
Generate a HSV color tuple in a human-friendly way.
Aliases: color_hsv, colorhsv
Source: faker : faker.providers.color.en_US.Provider.color_hsv
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorHsv}}
Outputs:
SomeObject(id=1, formula_field_example=(207, 58, 92))
fake: ColorName¶
Generate a color name.
Aliases: color_name, colorname
Source: faker : faker.providers.color.en_US.Provider.color_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorName}}
Outputs:
SomeObject(id=1, formula_field_example=BlueViolet)
fake: ColorRgb¶
Generate a RGB color tuple of integers in a human-friendly way.
Aliases: color_rgb, colorrgb
Source: faker : faker.providers.color.en_US.Provider.color_rgb
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorRgb}}
Outputs:
SomeObject(id=1, formula_field_example=(98, 173, 234))
fake: ColorRgbFloat¶
Generate a RGB color tuple of floats in a human-friendly way.
Aliases: color_rgb_float, colorrgbfloat
Source: faker : faker.providers.color.en_US.Provider.color_rgb_float
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.ColorRgbFloat}}
Outputs:
SomeObject(id=1, formula_field_example=(0.3864000000000001, 0.6798800000000002, 0.92))
fake: HexColor¶
Generate a color formatted as a hex triplet.
Aliases: hex_color, hexcolor
Source: faker : faker.providers.color.en_US.Provider.hex_color
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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.ja_JP.Provider.bs
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.company_suffix
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.CreditCardExpire}}
Outputs:
SomeObject(id=1, formula_field_example=07/28)
fake: CreditCardFull¶
Generate a set of credit card details.
Aliases: credit_card_full, creditcardfull
Source: faker : faker.providers.credit_card.en_US.Provider.credit_card_full
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.CreditCardFull}}
Outputs:
SomeObject(id=1, formula_field_example=Diners Club / Carte Blanche
加奈 木村
30080160975351 04/31
CVC: 139
)
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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.CurrencySymbol}}
Outputs:
SomeObject(id=1, formula_field_example=KM)
fake: Pricetag¶
Aliases: pricetag
Source: faker : faker.providers.currency.en_US.Provider.pricetag
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.am_pm
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.AmPm}}
Outputs:
SomeObject(id=1, formula_field_example=PM)
fake: Century¶
Example:: 'XVII'
Aliases: century
Source: faker : faker.providers.date_time.ja_JP.Provider.century
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Century}}
Outputs:
SomeObject(id=1, formula_field_example=II)
fake: Date¶
Get a date string between January 1, 1970 and now.
Param: pattern: Format of the date (year-month-day by default)
Example:: '2008-11-27'
Return:: Date
Aliases: date
Source: faker : faker.providers.date_time.ja_JP.Provider.date
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Date}}
Outputs:
SomeObject(id=1, formula_field_example=1992-10-31)
fake: DateBetween¶
Get a Date object based on a random date between two given dates. Accepts date strings that can be recognized by strtotime().
Param: start_date: Defaults to 30 years ago
Param: end_date: Defaults to "today"
Example:: Date('1999-02-02')
Return:: Date
Aliases: date_between, datebetween
Source: faker : faker.providers.date_time.ja_JP.Provider.date_between
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateBetween}}
Outputs:
SomeObject(id=1, formula_field_example=2006-11-27)
fake: DateBetweenDates¶
Takes two Date objects and returns a random date between the two given dates. Accepts Date or datetime objects
Param: date_start: Date
Param: date_end: Date
Return:: Date
Aliases: date_between_dates, datebetweendates
Source: faker : faker.providers.date_time.ja_JP.Provider.date_between_dates
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateBetweenDates}}
Outputs:
SomeObject(id=1, formula_field_example=2024-04-16)
fake: DateObject¶
Get a date object between January 1, 1970 and now
Example:: datetime.date(2016, 9, 20)
Aliases: date_object, dateobject
Source: faker : faker.providers.date_time.ja_JP.Provider.date_object
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateObject}}
Outputs:
SomeObject(id=1, formula_field_example=1992-10-31)
fake: DateOfBirth¶
Generate a random date of birth represented as a Date object, constrained by optional miminimum_age and maximum_age parameters.
Param: tzinfo: Defaults to None.
Param: minimum_age: Defaults to 0.
Param: maximum_age: Defaults to 115.
Example:: Date('1979-02-02')
Return:: Date
Aliases: date_of_birth, dateofbirth
Source: faker : faker.providers.date_time.ja_JP.Provider.date_of_birth
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateOfBirth}}
Outputs:
SomeObject(id=1, formula_field_example=1957-01-28)
fake: DateThisCentury¶
Gets a Date object for the current century.
Param: before_today: include days in current century before today
Param: after_today: include days in current century after today
Example:: Date('2012-04-04')
Return:: Date
Aliases: date_this_century, datethiscentury
Source: faker : faker.providers.date_time.ja_JP.Provider.date_this_century
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateThisCentury}}
Outputs:
SomeObject(id=1, formula_field_example=2010-03-20)
fake: DateThisDecade¶
Gets a Date object for the decade year.
Param: before_today: include days in current decade before today
Param: after_today: include days in current decade after today
Example:: Date('2012-04-04')
Return:: Date
Aliases: date_this_decade, datethisdecade
Source: faker : faker.providers.date_time.ja_JP.Provider.date_this_decade
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateThisDecade}}
Outputs:
SomeObject(id=1, formula_field_example=2021-10-21)
fake: DateThisMonth¶
Gets a Date object for the current month.
Param: before_today: include days in current month before today
Param: after_today: include days in current month after today
Example:: dtdate('2012-04-04')
Return:: dtdate
Aliases: date_this_month, datethismonth
Source: faker : faker.providers.date_time.ja_JP.Provider.date_this_month
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateThisMonth}}
Outputs:
SomeObject(id=1, formula_field_example=2024-04-07)
fake: DateThisYear¶
Gets a Date object for the current year.
Param: before_today: include days in current year before today
Param: after_today: include days in current year after today
Example:: Date('2012-04-04')
Return:: Date
Aliases: date_this_year, datethisyear
Source: faker : faker.providers.date_time.ja_JP.Provider.date_this_year
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DateThisYear}}
Outputs:
SomeObject(id=1, formula_field_example=2024-02-14)
fake: DayOfMonth¶
Aliases: day_of_month, dayofmonth
Source: faker : faker.providers.date_time.ja_JP.Provider.day_of_month
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DayOfMonth}}
Outputs:
SomeObject(id=1, formula_field_example=31)
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.ja_JP.Provider.future_date
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FutureDate}}
Outputs:
SomeObject(id=1, formula_field_example=2024-04-29)
fake: Month¶
Aliases: month
Source: faker : faker.providers.date_time.ja_JP.Provider.month
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Month}}
Outputs:
SomeObject(id=1, formula_field_example=10)
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.ja_JP.Provider.past_date
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PastDate}}
Outputs:
SomeObject(id=1, formula_field_example=2024-03-29)
fake: PastDatetime¶
Get a datetime object based on a random date between a given date and 1 second ago. Accepts date strings that can be recognized by strtotime().
Param: start_date: Defaults to "-30d"
Param: tzinfo: timezone, instance of datetime.tzinfo subclass
Example:: datetime('1999-02-02 11:42:52')
Return:: datetime
Aliases: past_datetime, pastdatetime
Source: faker : faker.providers.date_time.ja_JP.Provider.past_datetime
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PastDatetime}}
Outputs:
SomeObject(id=1, formula_field_example=2024-03-30 14:04:36.116942)
fake: Pytimezone¶
Generate a random timezone (see faker.timezone
for any args)
and return as a python object usable as a tzinfo
to datetime
or other fakers.
Example:: faker.pytimezone()
Return:: dateutil.tz.tz.tzfile
Aliases: pytimezone
Source: faker : faker.providers.date_time.ja_JP.Provider.pytimezone
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.time_delta
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.time_object
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.TimeObject}}
Outputs:
SomeObject(id=1, formula_field_example=22:07:03.884625)
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.ja_JP.Provider.time_series
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.TimeSeries}}
Outputs:
SomeObject(id=1, formula_field_example=<generator object Provider.time_series at 0x7f6f9422b990>)
fake: Timezone¶
Aliases: timezone
Source: faker : faker.providers.date_time.ja_JP.Provider.timezone
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Timezone}}
Outputs:
SomeObject(id=1, formula_field_example=Europe/Stockholm)
fake: UnixTime¶
Get a timestamp between January 1, 1970 and now, unless passed explicit start_datetime or end_datetime values.
On Windows, the decimal part is always 0.
Example:: 1061306726.6
Aliases: unix_time, unixtime
Source: faker : faker.providers.date_time.ja_JP.Provider.unix_time
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.UnixTime}}
Outputs:
SomeObject(id=1, formula_field_example=720569223.8846254)
Decorators.Py Fakers¶
fake: AsciiCompanyEmail¶
Aliases: ascii_company_email, asciicompanyemail
Source: faker : faker.providers.internet.ja_JP.Provider.ascii_company_email
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.AsciiCompanyEmail}}
Outputs:
SomeObject(id=1, formula_field_example=chiyo38@kobayashi.org)
fake: AsciiEmail¶
Aliases: ascii_email, asciiemail
Source: faker : faker.providers.internet.ja_JP.Provider.ascii_email
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.AsciiEmail}}
Outputs:
SomeObject(id=1, formula_field_example=hiroshikobayashi@okamoto.com)
fake: AsciiFreeEmail¶
Aliases: ascii_free_email, asciifreeemail
Source: faker : faker.providers.internet.ja_JP.Provider.ascii_free_email
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.AsciiFreeEmail}}
Outputs:
SomeObject(id=1, formula_field_example=lmori@gmail.com)
fake: AsciiSafeEmail¶
Aliases: ascii_safe_email, asciisafeemail
Source: faker : faker.providers.internet.ja_JP.Provider.ascii_safe_email
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.AsciiSafeEmail}}
Outputs:
SomeObject(id=1, formula_field_example=lmori@example.org)
fake: CompanyEmail¶
Aliases: company_email, companyemail
Source: faker : faker.providers.internet.ja_JP.Provider.company_email
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.CompanyEmail}}
Outputs:
SomeObject(id=1, formula_field_example=chiyo38@kobayashi.org)
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.ja_JP.Provider.domain_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DomainName}}
Outputs:
SomeObject(id=1, formula_field_example=okada.jp)
fake: DomainWord¶
Aliases: domain_word, domainword
Source: faker : faker.providers.internet.ja_JP.Provider.domain_word
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DomainWord}}
Outputs:
SomeObject(id=1, formula_field_example=ishikawa)
fake: FreeEmail¶
Aliases: free_email, freeemail
Source: faker : faker.providers.internet.ja_JP.Provider.free_email
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FreeEmail}}
Outputs:
SomeObject(id=1, formula_field_example=lmori@gmail.com)
fake: FreeEmailDomain¶
Aliases: free_email_domain, freeemaildomain
Source: faker : faker.providers.internet.ja_JP.Provider.free_email_domain
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.hostname
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Hostname}}
Outputs:
SomeObject(id=1, formula_field_example=desktop-93.okada.com)
fake: SafeDomainName¶
Aliases: safe_domain_name, safedomainname
Source: faker : faker.providers.internet.ja_JP.Provider.safe_domain_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.safe_email
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.SafeEmail}}
Outputs:
SomeObject(id=1, formula_field_example=lmori@example.org)
fake: Slug¶
Django algorithm
Aliases: slug
Source: faker : faker.providers.internet.ja_JP.Provider.slug
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Slug}}
Outputs:
SomeObject(id=1, formula_field_example=)
Emoji Fakers¶
fake: Emoji¶
Example:: '😉'
Aliases: emoji
Source: faker : faker.providers.emoji.Provider.emoji
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Emoji}}
Outputs:
SomeObject(id=1, formula_field_example=⏮️)
File Fakers¶
fake: FileExtension¶
Generate a file extension under the specified category
.
If category
is None
, a random category will be used. The list of
valid categories include: 'audio'
, 'image'
, 'office'
,
'text'
, and 'video'
.
Aliases: file_extension, fileextension
Source: faker : faker.providers.file.Provider.file_extension
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FileExtension}}
Outputs:
SomeObject(id=1, formula_field_example=webm)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FileExtension(category='image')}}
Outputs:
SomeObject(id=1, formula_field_example=jpg)
fake: FileName¶
Generate a random file name with extension.
If extension
is None
, a random extension will be created
under the hood using |file_extension| with the specified
category
. If a value for extension
is provided, the
value will be used instead, and category
will be ignored.
The actual name part itself is generated using |word|. If
extension is an empty string then no extension will be added,
and file_name will be the same as |word|.
Aliases: file_name, filename
Source: faker : faker.providers.file.Provider.file_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FileName(category='audio')}}
Outputs:
SomeObject(id=1, formula_field_example=脊椎.mp3)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FileName(extension='abcdef')}}
Outputs:
SomeObject(id=1, formula_field_example=は.abcdef)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FileName(category='audio', extension='abcdef')}}
Outputs:
SomeObject(id=1, formula_field_example=電話.abcdef)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FileName(extension='')}}
Outputs:
SomeObject(id=1, formula_field_example=日曜日)
fake: FilePath¶
Generate an pathname to a file.
This method uses |file_name| under the hood to generate the file
name itself, and depth
controls the depth of the directory
path, and |word| is used under the hood to generate the
different directory names.
If absolute
is True
(default), the generated path starts
with /
and is absolute. Otherwise, the generated path is
relative.
If used, extension
can be either a string, forcing that
extension, a sequence of strings (one will be picked at random),
or an empty sequence (the path will have no extension). Default
behaviour is the same as |file_name|
if file_system
is set (default="linux"), the generated path uses
specified file system path standard, the list of valid file systems include:
'windows'
, 'linux'
.
Aliases: file_path, filepath
Source: faker : faker.providers.file.Provider.file_path
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(depth=3)}}
Outputs:
SomeObject(id=1, formula_field_example=/器官/屋根裏/バスケット/合計.avi)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(depth=5, category='video')}}
Outputs:
SomeObject(id=1, formula_field_example=/普通の/販売/副/ニュース/転倒/協力.mp4)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(depth=5, category='video', extension='abcdef')}}
Outputs:
SomeObject(id=1, formula_field_example=/花嫁/ハンマー/は/君は/ダニ/建築.abcdef)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(extension=[])}}
Outputs:
SomeObject(id=1, formula_field_example=/副/コミュニティ)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(extension='')}}
Outputs:
SomeObject(id=1, formula_field_example=/チーズ/カラム)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FilePath(extension=["a", "bc", "def"])}}
Outputs:
SomeObject(id=1, formula_field_example=/画面/主人.def)
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.MimeType}}
Outputs:
SomeObject(id=1, formula_field_example=video/x-ms-wmv)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.UnixDevice}}
Outputs:
SomeObject(id=1, formula_field_example=/dev/vdq)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.UnixPartition}}
Outputs:
SomeObject(id=1, formula_field_example=/dev/vdm4)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LocationOnLand}}
Outputs:
SomeObject(id=1, formula_field_example=('-7.60361', '37.00438', 'Kidodi', 'TZ', 'Africa/Dar_es_Salaam'))
fake: Longitude¶
Aliases: longitude
Source: faker : faker.providers.geo.en_US.Provider.longitude
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.dga
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Dga}}
Outputs:
SomeObject(id=1, formula_field_example=iiulfpgbvqcdaehnqkbxmaqgkykorlxnwy.net)
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.ja_JP.Provider.http_method
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.HttpMethod}}
Outputs:
SomeObject(id=1, formula_field_example=GET)
fake: HttpStatusCode¶
Returns random HTTP status code https://www.rfc-editor.org/rfc/rfc9110#name-status-codes
Param: include_unassigned: Whether to include status codes which have not yet been assigned or are unused
Return:: a random three digit status code :rtype: int
Example:: 404
Aliases: http_status_code, httpstatuscode
Source: faker : faker.providers.internet.ja_JP.Provider.http_status_code
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.HttpStatusCode}}
Outputs:
SomeObject(id=1, formula_field_example=488)
fake: IanaId¶
Returns IANA Registrar ID https://www.iana.org/assignments/registrar-ids/registrar-ids.xhtml
:rtype: str
Aliases: iana_id, ianaid
Source: faker : faker.providers.internet.ja_JP.Provider.iana_id
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.image_url
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.ImageUrl}}
Outputs:
SomeObject(id=1, formula_field_example=https://dummyimage.com/621x976)
fake: Ipv4¶
Returns a random IPv4 address or network with a valid CIDR.
Param: network: Network address
Param: address_class: IPv4 address class (a, b, or c)
Param: private: Public or private
Return:s: IPv4
Aliases: ipv4
Source: faker : faker.providers.internet.ja_JP.Provider.ipv4
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.ipv4_network_class
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.ipv4_private
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.ipv4_public
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.ipv6
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ipv6}}
Outputs:
SomeObject(id=1, formula_field_example=eb11:67b3:67a9:c378:7c65:c1e6:82e2:e662)
fake: MacAddress¶
Returns a random MAC address.
Param: multicast: Multicast address
Return:s: MAC Address
Aliases: mac_address, macaddress
Source: faker : faker.providers.internet.ja_JP.Provider.mac_address
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.MacAddress}}
Outputs:
SomeObject(id=1, formula_field_example=18:47:30:80:4b:9e)
fake: NicHandle¶
Returns NIC Handle ID https://www.apnic.net/manage-ip/using-whois/guide/person/
:rtype: str
Aliases: nic_handle, nichandle
Source: faker : faker.providers.internet.ja_JP.Provider.nic_handle
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.nic_handles
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.port_number
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.ripe_id
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.tld
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Tld}}
Outputs:
SomeObject(id=1, formula_field_example=com)
fake: Uri¶
Param: schemes: a list of strings to use as schemes, one will chosen randomly. If None, it will generate http and https uris. Passing an empty list will result in schemeless uri generation like "://domain.com/index.html".
Param: deep: an integer specifying how many path components the URI should have..
Return:: a random url string.
Aliases: uri
Source: faker : faker.providers.internet.ja_JP.Provider.uri
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Uri}}
Outputs:
SomeObject(id=1, formula_field_example=http://goto.com/explorehome.php)
fake: UriExtension¶
Aliases: uri_extension, uriextension
Source: faker : faker.providers.internet.ja_JP.Provider.uri_extension
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.uri_page
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.uri_path
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.url
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Url}}
Outputs:
SomeObject(id=1, formula_field_example=https://www.okada.com/)
Isbn Fakers¶
fake: Isbn10¶
Aliases: isbn10
Source: faker : faker.providers.isbn.Provider.isbn10
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Isbn13}}
Outputs:
SomeObject(id=1, formula_field_example=978-0-15-781565-8)
Ja_Jp Fakers¶
fake: AdministrativeUnit¶
Example:: '東京都'
Aliases: administrative_unit, administrativeunit
Source: faker : faker.providers.address.ja_JP.Provider.administrative_unit
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.AdministrativeUnit}}
Outputs:
SomeObject(id=1, formula_field_example=岩手県)
fake: Ban¶
Example:: '3番'
Aliases: ban
Source: faker : faker.providers.address.ja_JP.Provider.ban
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Ban}}
Outputs:
SomeObject(id=1, formula_field_example=14番)
fake: BuildingName¶
Example:: 'コーポ芝浦'
Aliases: building_name, buildingname
Source: faker : faker.providers.address.ja_JP.Provider.building_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.BuildingName}}
Outputs:
SomeObject(id=1, formula_field_example=パレス)
fake: Chome¶
Example:: '1丁目'
Aliases: chome
Source: faker : faker.providers.address.ja_JP.Provider.chome
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Chome}}
Outputs:
SomeObject(id=1, formula_field_example=3丁目)
fake: CompanyCategory¶
Aliases: company_category, companycategory
Source: faker : faker.providers.company.ja_JP.Provider.company_category
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.CompanyCategory}}
Outputs:
SomeObject(id=1, formula_field_example=電気)
fake: CompanyPrefix¶
Aliases: company_prefix, companyprefix
Source: faker : faker.providers.company.ja_JP.Provider.company_prefix
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.CompanyPrefix}}
Outputs:
SomeObject(id=1, formula_field_example=株式会社)
fake: DayOfWeek¶
Aliases: day_of_week, dayofweek
Source: faker : faker.providers.date_time.ja_JP.Provider.day_of_week
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.DayOfWeek}}
Outputs:
SomeObject(id=1, formula_field_example=土曜日)
fake: FirstKanaName¶
Example:: 'アケミ'
Aliases: first_kana_name, firstkananame
Source: faker : faker.providers.person.ja_JP.Provider.first_kana_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstKanaName}}
Outputs:
SomeObject(id=1, formula_field_example=ヨウスケ)
fake: FirstKanaNameFemale¶
Example:: 'アケミ'
Aliases: first_kana_name_female, firstkananamefemale
Source: faker : faker.providers.person.ja_JP.Provider.first_kana_name_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstKanaNameFemale}}
Outputs:
SomeObject(id=1, formula_field_example=アスカ)
fake: FirstKanaNameMale¶
Example:: 'アキラ'
Aliases: first_kana_name_male, firstkananamemale
Source: faker : faker.providers.person.ja_JP.Provider.first_kana_name_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstKanaNameMale}}
Outputs:
SomeObject(id=1, formula_field_example=ヤスヒロ)
fake: FirstNameFemalePair¶
Example:: ('明美', 'アケミ', 'Akemi')
Aliases: first_name_female_pair, firstnamefemalepair
Source: faker : faker.providers.person.ja_JP.Provider.first_name_female_pair
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstNameFemalePair}}
Outputs:
SomeObject(id=1, formula_field_example=('あすか', 'アスカ', 'Asuka'))
fake: FirstNameMalePair¶
Example:: ('晃', 'アキラ', 'Akira')
Aliases: first_name_male_pair, firstnamemalepair
Source: faker : faker.providers.person.ja_JP.Provider.first_name_male_pair
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstNameMalePair}}
Outputs:
SomeObject(id=1, formula_field_example=('康弘', 'ヤスヒロ', 'Yasuhiro'))
fake: FirstNamePair¶
Example:: ('明美', 'アケミ', 'Akemi')
Aliases: first_name_pair, firstnamepair
Source: faker : faker.providers.person.ja_JP.Provider.first_name_pair
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstNamePair}}
Outputs:
SomeObject(id=1, formula_field_example=('洋介', 'ヨウスケ', 'Yosuke'))
fake: FirstRomanizedName¶
Example:: 'Akemi'
Aliases: first_romanized_name, firstromanizedname
Source: faker : faker.providers.person.ja_JP.Provider.first_romanized_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstRomanizedName}}
Outputs:
SomeObject(id=1, formula_field_example=Yosuke)
fake: FirstRomanizedNameFemale¶
Example:: 'Akemi'
Aliases: first_romanized_name_female, firstromanizednamefemale
Source: faker : faker.providers.person.ja_JP.Provider.first_romanized_name_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstRomanizedNameFemale}}
Outputs:
SomeObject(id=1, formula_field_example=Asuka)
fake: FirstRomanizedNameMale¶
Example:: 'Akira'
Aliases: first_romanized_name_male, firstromanizednamemale
Source: faker : faker.providers.person.ja_JP.Provider.first_romanized_name_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.FirstRomanizedNameMale}}
Outputs:
SomeObject(id=1, formula_field_example=Yasuhiro)
fake: Gou¶
Example:: '10号'
Aliases: gou
Source: faker : faker.providers.address.ja_JP.Provider.gou
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Gou}}
Outputs:
SomeObject(id=1, formula_field_example=2号)
fake: Jan¶
Generate a JAN barcode of the specified length
.
This method is an alias for |JaJpProvider.localized_ean|.
Aliases: jan
Source: faker : faker.providers.barcode.ja_JP.Provider.jan
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Jan}}
Outputs:
SomeObject(id=1, formula_field_example=4556593877841)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Jan(length=8)}}
Outputs:
SomeObject(id=1, formula_field_example=45115875)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Jan(length=13)}}
Outputs:
SomeObject(id=1, formula_field_example=4512201868489)
fake: Jan13¶
Generate a 13 digit JAN barcode.
This method is an alias for |JaJpProvider.localized_ean13|.
Aliases: jan13
Source: faker : faker.providers.barcode.ja_JP.Provider.jan13
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Jan13}}
Outputs:
SomeObject(id=1, formula_field_example=4556593877841)
fake: Jan8¶
Generate a 8 digit JAN barcode.
This method is an alias for |JaJpProvider.localized_ean8|.
Aliases: jan8
Source: faker : faker.providers.barcode.ja_JP.Provider.jan8
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Jan8}}
Outputs:
SomeObject(id=1, formula_field_example=45489242)
fake: KanaName¶
Example:: 'サトウ アケミ'
Aliases: kana_name, kananame
Source: faker : faker.providers.person.ja_JP.Provider.kana_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.KanaName}}
Outputs:
SomeObject(id=1, formula_field_example=ヤマシタ ナナミ)
fake: KanaNameFemale¶
Example:: 'サトウ アケミ'
Aliases: kana_name_female, kananamefemale
Source: faker : faker.providers.person.ja_JP.Provider.kana_name_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.KanaNameFemale}}
Outputs:
SomeObject(id=1, formula_field_example=ヤマシタ ナナミ)
fake: KanaNameMale¶
Example:: 'サトウ アキラ'
Aliases: kana_name_male, kananamemale
Source: faker : faker.providers.person.ja_JP.Provider.kana_name_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.KanaNameMale}}
Outputs:
SomeObject(id=1, formula_field_example=ヤマシタ レイ)
fake: LastKanaName¶
Example:: 'サトウ'
Aliases: last_kana_name, lastkananame
Source: faker : faker.providers.person.ja_JP.Provider.last_kana_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LastKanaName}}
Outputs:
SomeObject(id=1, formula_field_example=イシカワ)
fake: LastNamePair¶
Example:: ('佐藤', 'サトウ', 'Sato')
Aliases: last_name_pair, lastnamepair
Source: faker : faker.providers.person.ja_JP.Provider.last_name_pair
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LastNamePair}}
Outputs:
SomeObject(id=1, formula_field_example=('石川', 'イシカワ', 'Ishikawa'))
fake: LastRomanizedName¶
Example:: 'Sato'
Aliases: last_romanized_name, lastromanizedname
Source: faker : faker.providers.person.ja_JP.Provider.last_romanized_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LastRomanizedName}}
Outputs:
SomeObject(id=1, formula_field_example=Ishikawa)
fake: MonthName¶
Aliases: month_name, monthname
Source: faker : faker.providers.date_time.ja_JP.Provider.month_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.MonthName}}
Outputs:
SomeObject(id=1, formula_field_example=十月)
fake: Postcode¶
Example:: '101-1212'
Aliases: postcode
Source: faker : faker.providers.address.ja_JP.Provider.postcode
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Postcode}}
Outputs:
SomeObject(id=1, formula_field_example=041-4242)
fake: Prefecture¶
Example:: '東京都'
Aliases: prefecture
Source: faker : faker.providers.address.ja_JP.Provider.administrative_unit
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Prefecture}}
Outputs:
SomeObject(id=1, formula_field_example=岩手県)
fake: RomanizedName¶
Example:: 'Akemi Sato'
Aliases: romanized_name, romanizedname
Source: faker : faker.providers.person.ja_JP.Provider.romanized_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RomanizedName}}
Outputs:
SomeObject(id=1, formula_field_example=Nanami Goto)
fake: RomanizedNameFemale¶
Example:: 'Akemi Sato'
Aliases: romanized_name_female, romanizednamefemale
Source: faker : faker.providers.person.ja_JP.Provider.romanized_name_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RomanizedNameFemale}}
Outputs:
SomeObject(id=1, formula_field_example=Nanami Goto)
fake: RomanizedNameMale¶
Example:: 'Akira Sato'
Aliases: romanized_name_male, romanizednamemale
Source: faker : faker.providers.person.ja_JP.Provider.romanized_name_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RomanizedNameMale}}
Outputs:
SomeObject(id=1, formula_field_example=Takuma Shimizu)
fake: Town¶
Example:: '浅草'
Aliases: town
Source: faker : faker.providers.address.ja_JP.Provider.town
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Town}}
Outputs:
SomeObject(id=1, formula_field_example=長畑)
fake: TraditionalMonthName¶
Aliases: traditional_month_name, traditionalmonthname
Source: faker : faker.providers.date_time.ja_JP.Provider.traditional_month_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.TraditionalMonthName}}
Outputs:
SomeObject(id=1, formula_field_example=神無月)
fake: Zipcode¶
Aliases: zipcode
Source: faker : faker.providers.address.ja_JP.Provider.zipcode
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Zipcode}}
Outputs:
SomeObject(id=1, formula_field_example=041-4242)
Job Fakers¶
fake: Job¶
Aliases: job
Source: faker : faker.providers.job.ja_JP.Provider.job
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Job}}
Outputs:
SomeObject(id=1, formula_field_example=配管工)
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.ja_JP.Provider.paragraphs
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Paragraphs(nb=5)}}
Outputs:
SomeObject(id=1, formula_field_example=['販売ダニ電池脊椎ノートバスケット。サンプルトーン試してみる中央協力。', '管理する敵対的な移動ハードウェアプラスチック教授追放する。インチ戦略的コミュニティ仕上げ再現する符号移動。怒り鉱山厳しいソース職人あなた自身。', '供給バス改善コミュニティ行進追放する。怒り尿狐本質的な。スキーム装置コピー電池。', 'サワートリビュートプラスチッククロス高い指名トリビュート。保証金錯覚仕上げ保持する。', '今日ない特徴叔父軸デフォルト。副舗装奨励します癌カレッジリフトコーナー。トス主婦ダッシュ。'])
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Paragraphs(nb=5, ext_word_list=['abc', 'def', 'ghi',
'jkl'])}}
Outputs:
SomeObject(id=1, formula_field_example=['Defghiabcabc。Defdefghidefdefabcabcabc。Ghidefjkldefabcghidef。', 'Abcabcdefabcdefghi。Jklghidefjkl。Abcabcghiabc。', 'Defghidefdef。', 'Defdefjkldefjkl。Abcabcjkljklabcghi。Abcdefabcabcjkl。Ghiabcdefdefjkl。', 'Jklabcdefghijkldefjkldef。Jklghijklghijklabcghi。'])
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.ja_JP.Provider.sentences
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Sentences}}
Outputs:
SomeObject(id=1, formula_field_example=['血まみれのダニ合計。', '犯罪者数字は画面サワー織る。', 'ピック電池スペル転倒〜ささやき欠乏。'])
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Sentences(nb=5)}}
Outputs:
SomeObject(id=1, formula_field_example=['ブランチ癌それコーラス。', 'ボトル彼改善。', 'バスサワーない錯覚編組暖かいプラスチック。', '必要憲法腐った数字建築。', '暖かいあなた自身狐オークション花嫁符号持つフレーム。'])
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Sentences(nb=5, ext_word_list=['abc', 'def', 'ghi',
'jkl'])}}
Outputs:
SomeObject(id=1, formula_field_example=['Jklabcghijkldef。', 'Abcjklghiabcghi。', 'Jkljklghidefghiabcghi。', 'Ghidefabcdefabcjkldef。', 'Ghighijkljklabc。'])
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.ja_JP.Provider.texts
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Texts(nb_texts=5)}}
Outputs:
SomeObject(id=1, formula_field_example=['同行指名トリビュート。オークション部隊犯罪者ヒール画面証言する普通の。探査再現する癌ホイールブレーキトス陶器。\nニュースサンプル学生大統領拡張明らかにする。索引リフトは助けて。ダイヤモンドパンダイヤモンド反射尿。\n不自然な持つ血まみれのバーゲン脊椎ログ探査午前。クールヒール助けて持ってるホイール呼ぶバケツ。\n戦略的犯罪者賞賛するハンマー。今リフト供給販売ヘアヒット。', '彼文言残る雪腐ったオークション。クールシュガーハンマー式。\n残る月連続それ犯罪者品質。\n式ブランチコミュニティトス。符号デフォルト電池ダイヤモンドダニ明らかにする今日。偏差符号電話改善。\n暖かいアクセルペダルキャビン血まみれの仕上げ擁する倫理トーン。〜コーラス野球コミュニケーション拡張ダイヤモンドコンペ倫理。ダッシュサワー今陶器月教会。', '障害反射証言するヘアトリビュートそれ連続。コーナー改善保持するコンペは。\nバケツ賞賛するコーナー差別する教授知覚。アクセルペダルスペルハンマーブラケットあなた自身。\n中央見落とす擁する葉。\n販売怒り欠乏文言持ってる。追放する数字奨励します革新。厳しい分割反射腐った呼ぶ葉ベルベット。\nカレッジ通行料金あなた自身怒りハンマー。バナー軸教授ヒール。', '埋め込むダイヤモンド副敵。午前創傷持っていましたあった。ない日曜日屋根裏立派な尿野球。\n葉ヘア品質反射立派なアクセルペダルブランチ。\n人形ダニジャムキャビン再現するバーゲン見出しクルー。\n狭いシェービングコミュニティ怒り。\n見出し呼ぶバナー午前バーゲンブランチジャム。式織るパーセント敵運。\n残る特徴犯罪者副。シュガー障害行進。', '尿学生クルーキャビン特徴索引虐待。分割賞賛する知覚高い。\n編組コンペピック証言する。細かいバナーサンプル索引持っていましたフェミニストジャム。\nボトル協力数字呼ぶブランチ差別する虐待キャビン。持つ持っていました式見落とす戦略的尊敬する。部隊狭い連続協力リニア。\n今日テントスキームバーゲン錯覚。血まみれのクロス葉感謝する通行料金トースト。'])
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Texts(nb_texts=5, max_nb_chars=50)}}
Outputs:
SomeObject(id=1, formula_field_example=['尊敬する評議会転倒欠乏コピー評議会マリン。教授カラム証言する織る必要テント。', '学生トス敵行進索引電話。コーラススマッシュデフォルト。', '不自然な自体保証金隠すコンペ。持っていましたストレージ本質的な文言倫理君はヒット。', '動物血まみれの証言する同行コンペトースト。クロス癌はジャーナルオークション。', '知覚意図発生する午前。マリン保持する彼女人形人形〜鉱山。'])
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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=['Jkldefabcjkldef。Abcdefabcjkldef。Jklabcghiabcjkl。', 'Jklabcdefdef。Defdefjkl。Jklabcdefdefdefdefabcghi。', 'Defghighiabc。Ghighighidefghidefabc。', 'Defjkldefdefjkl。Defjkldefdefdefdefabc。', 'Abcjklghiabc。Abcabcjkljkl。Defabcdefabcabcjkljkl。'])
fake: Words¶
Generate a tuple of words.
The nb
argument controls the number of words in the resulting list,
and if ext_word_list
is provided, words from that list will be used
instead of those from the locale provider's built-in word list.
If unique
is True
, this method will return a list containing
unique words. Under the hood, |random_sample| will be used for sampling
without replacement. If unique
is False
, |random_choices| is
used instead, and the list returned may contain duplicates.
part_of_speech
is a parameter that defines to what part of speech
the returned word belongs. If ext_word_list
is not None
, then
part_of_speech
is ignored. If the value of part_of_speech
does
not correspond to an existent part of speech according to the set locale,
then an exception is raised.
.. warning::
Depending on the length of a locale provider's built-in word list or
on the length of ext_word_list
if provided, a large nb
can
exhaust said lists if unique
is True
, raising an exception.
Aliases: words
Source: faker : faker.providers.lorem.ja_JP.Provider.words
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Words}}
Outputs:
SomeObject(id=1, formula_field_example=['ハンマー', '本質的な', 'タワー'])
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Words(nb=5)}}
Outputs:
SomeObject(id=1, formula_field_example=['舗装', '探査', 'シュガー', 'リンク', '保持する'])
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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.
If this faker instance has been seeded, performance will be signficiantly reduced, to conform to the seeding.
Aliases: binary
Source: faker : faker.providers.misc.en_US.Provider.binary
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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="岡本 舞","石川県川崎市宮前区橋場32丁目13番10号"
"森 裕美子","岡山県いすみ市脚折町9丁目25番4号"
"村上 陽子","長野県富里市蟇沼22丁目16番18号"
"森 翼","福岡県武蔵村山市権現堂36丁目16番15号 東上野クレスト801"
"三浦 里佳","福岡県武蔵野市日比谷公園16丁目24番11号"
"佐々木 零","新潟県長生郡睦沢町湯本塩原35丁目15番3号 ハイツ西神田148"
"三浦 加奈","静岡県横浜市南区竜泉14丁目26番20号 コート鶴ヶ丘196"
"石井 千代","千葉県香取郡多古町柿木沢新田3丁目20番9号 上野桜木ハイツ220"
"太田 零","大分県渋谷区松が谷18丁目17番8号 アーバン高田馬場775"
"山崎 学","島根県国立市日比谷公園13丁目8番1号"
)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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","中村 千代","埼玉県文京区津久戸町4丁目4番5号 神明内パレス013","silver"
"2","山下 治","茨城県君津市土沢13丁目6番4号 雷門アーバン086","silver"
"3","木村 治","秋田県多摩市皇居外苑23丁目14番6号","black"
"4","高橋 陽子","宮崎県渋谷区木立17丁目12番16号","aqua"
"5","太田 稔","宮城県横浜市鶴見区氏家11丁目11番17号","olive"
"6","斉藤 零","熊本県印旛郡栄町東和町31丁目22番14号 橋場クレスト642","blue"
"7","藤田 裕太","静岡県神津島村中鉢石町35丁目9番5号","navy"
"8","森 陽子","大分県江東区油井20丁目13番14号 方京パレス523","navy"
"9","橋本 裕美子","岩手県中野区高田馬場3丁目6番15号 東三島クレスト787","white"
"10","高橋 直樹","長野県横浜市金沢区入谷4丁目26番14号 鍛冶ケ沢コート206","gray"
)
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Dsv(dialect='excel', data_columns=('{{name}}',
'{{address}}'))}}
Outputs:
SomeObject(id=1, formula_field_example=岡本 舞,石川県川崎市宮前区橋場32丁目13番10号
森 裕美子,岡山県いすみ市脚折町9丁目25番4号
村上 陽子,長野県富里市蟇沼22丁目16番18号
森 翼,福岡県武蔵村山市権現堂36丁目16番15号 東上野クレスト801
三浦 里佳,福岡県武蔵野市日比谷公園16丁目24番11号
佐々木 零,新潟県長生郡睦沢町湯本塩原35丁目15番3号 ハイツ西神田148
三浦 加奈,静岡県横浜市南区竜泉14丁目26番20号 コート鶴ヶ丘196
石井 千代,千葉県香取郡多古町柿木沢新田3丁目20番9号 上野桜木ハイツ220
太田 零,大分県渋谷区松が谷18丁目17番8号 アーバン高田馬場775
山崎 学,島根県国立市日比谷公園13丁目8番1号
)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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 中村 千代 埼玉県文京区津久戸町4丁目4番5号 神明内パレス013
2 山下 治 茨城県君津市土沢13丁目6番4号 雷門アーバン086
3 木村 治 秋田県多摩市皇居外苑23丁目14番6号
4 岡田 智也 高知県富里市白金13丁目9番12号
5 石井 さゆり 大分県山武郡九十九里町西川11丁目6番11号 コート花島972
6 後藤 稔 香川県横浜市旭区橋場20丁目21番12号 芝大門クレスト807
7 阿部 裕太 山口県夷隅郡大多喜町湯宮16丁目25番16号
8 坂本 七夏 愛知県国立市油井20丁目13番14号 ハイツ丹勢523
9 青木 智也 鹿児島県横浜市緑区大京町3丁目13番19号 高田馬場パレス714
10 前田 直人 徳島県狛江市丹勢3丁目16番11号 猿楽町シャルム638
)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Dsv(data_columns=('{{name}}', '{{address}}'), num_rows=5,
delimiter='$')}}
Outputs:
SomeObject(id=1, formula_field_example="藤原 京助"$"京都府川崎市高津区大京町21丁目1番7号"
"三浦 康弘"$"大分県昭島市南赤田13丁目4番20号"
"清水 淳"$"千葉県富里市上野桜木26丁目21番3号 パレス五味ヶ谷142"
"中村 くみ子"$"青森県富津市長畑14丁目22番9号 外神田パーク977"
"池田 結衣"$"神奈川県大田区羽折町1丁目5番5号"
)
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: ja_JP
- 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= 岡本 舞 52
岡田 幹 75)
fake: Json¶
Generate random JSON structure values.
Using a dictionary or list of records that is passed as data_columns
,
define the structure that is used to build JSON structures. For complex
data structures it is recommended to use the dictionary format.
Data Column Dictionary format: {'key name': 'definition'}
The definition can be 'provider', 'provider:argument_group', tokenized 'string {{ provider:argument_group }}' that is passed to the python provider method pystr_format() for generation, or a fixed '@word'. Using Lists, Tuples, and Dicts as a definition for structure.
Example: fake.set_arguments('top_half', {'min_value': 50, 'max_value': 100}) fake.json(data_columns={'Name': 'name', 'Score': 'pyint:top_half'})
Data Column List format: [('key name', 'definition', {'arguments'})]
With the list format the definition can be a list of records, to create a list within the structure data. For literal entries within the list, set the 'field_name' to None.
Param: data_columns: specification for the data structure :type data_columns: dict
Param: num_rows: number of rows the returned :type num_rows: int
Param: indent: number of spaces to indent the fields :type indent: int
Param: cls: optional json encoder to use for non-standard objects such as datetimes :type cls: json.JSONEncoder
Return:: Serialized JSON data :rtype: str
'Details': {'Name': 'name', 'Address': 'address'}}, num_rows=2
num_rows=1
{'min_value': 50, 'max_value': 100})], num_rows=1
Aliases: json
Source: faker : faker.providers.misc.en_US.Provider.json
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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": "\u9ad8\u6a4b \u76f4\u5b50", "Address": "\u5cf6\u6839\u770c\u4e2d\u91ce\u533a\u7687\u5c45\u5916\u82d131\u4e01\u76ee12\u756a19\u53f7 \u30a2\u30fc\u30d0\u30f3\u65e5\u672c\u5824421"}}, {"Spec": "1.0.1", "ID": 4104, "Details": {"Name": "\u6e05\u6c34 \u548c\u4e5f", "Address": "\u79cb\u7530\u770c\u6a2a\u6d5c\u5e02\u6cc9\u533a\u4e00\u30c4\u6a4b31\u4e01\u76ee18\u756a4\u53f7 \u30d1\u30fc\u30af\u6238\u585a\u753a938"}}])
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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": ["\u524d\u7530 \u6843\u5b50", "\u7530\u4e2d \u7d50\u8863", "\u6e21\u8fba \u88d5\u592a"]})
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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": "\u4e09\u6d66 \u91cc\u4f73", "Points": 50})
fake: JsonBytes¶
Generate random JSON structure and return as bytes.
For more information on the different arguments of this method, refer to
:meth:json() <faker.providers.misc.Provider.json>
which is used under the hood.
Aliases: json_bytes, jsonbytes
Source: faker : faker.providers.misc.en_US.Provider.json_bytes
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.JsonBytes}}
Outputs:
SomeObject(id=1, formula_field_example=b'[{"name": "\\u85e4\\u539f \\u4eac\\u52a9", "residency": "\\u4eac\\u90fd\\u5e9c\\u5ddd\\u5d0e\\u5e02\\u9ad8\\u6d25\\u533a\\u5927\\u4eac\\u753a21\\u4e01\\u76ee1\\u756a7\\u53f7"}, {"name": "\\u4e09\\u6d66 \\u5eb7\\u5f18", "residency": "\\u5927\\u5206\\u770c\\u662d\\u5cf6\\u5e02\\u5357\\u8d64\\u753013\\u4e01\\u76ee4\\u756a20\\u53f7"}, {"name": "\\u6e05\\u6c34 \\u6df3", "residency": "\\u5343\\u8449\\u770c\\u5bcc\\u91cc\\u5e02\\u4e0a\\u91ce\\u685c\\u672826\\u4e01\\u76ee21\\u756a3\\u53f7 \\u30d1\\u30ec\\u30b9\\u4e94\\u5473\\u30f6\\u8c37142"}, {"name": "\\u4e2d\\u6751 \\u304f\\u307f\\u5b50", "residency": "\\u9752\\u68ee\\u770c\\u5bcc\\u6d25\\u5e02\\u9577\\u755114\\u4e01\\u76ee22\\u756a9\\u53f7 \\u5916\\u795e\\u7530\\u30d1\\u30fc\\u30af977"}, {"name": "\\u6c60\\u7530 \\u7d50\\u8863", "residency": "\\u795e\\u5948\\u5ddd\\u770c\\u5927\\u7530\\u533a\\u7fbd\\u6298\\u753a1\\u4e01\\u76ee5\\u756a5\\u53f7"}, {"name": "\\u963f\\u90e8 \\u82b1\\u5b50", "residency": "\\u9e7f\\u5150\\u5cf6\\u770c\\u767d\\u4e95\\u5e02\\u5e73\\u6cb3\\u753a40\\u4e01\\u76ee2\\u756a2\\u53f7 \\u4e0a\\u5e83\\u8c37\\u30b3\\u30fc\\u30dd945"}, {"name": "\\u8fd1\\u85e4 \\u304f\\u307f\\u5b50", "residency": "\\u8328\\u57ce\\u770c\\u516b\\u738b\\u5b50\\u5e02\\u4e2d\\u5ddd\\u5d0e4\\u4e01\\u76ee10\\u756a6\\u53f7 \\u6771\\u4e0a\\u91ce\\u30cf\\u30a4\\u30c4654"}, {"name": "\\u5c71\\u672c \\u52a0\\u5948", "residency": "\\u9ce5\\u53d6\\u770c\\u6c5f\\u6238\\u5ddd\\u533a\\u5e73\\u6cb3\\u753a22\\u4e01\\u76ee4\\u756a16\\u53f7 \\u30cf\\u30a4\\u30c4\\u9ce5\\u8d8a045"}, {"name": "\\u5409\\u7530 \\u5145", "residency": "\\u6ecb\\u8cc0\\u770c\\u6a2a\\u6d5c\\u5e02\\u4e2d\\u533a\\u524d\\u5f25\\u516d5\\u4e01\\u76ee26\\u756a3\\u53f7 \\u30a2\\u30fc\\u30d0\\u30f3\\u795e\\u660e\\u5185601"}, {"name": "\\u8fd1\\u85e4 \\u6843\\u5b50", "residency": "\\u5948\\u826f\\u770c\\u6a2a\\u6d5c\\u5e02\\u90fd\\u7b51\\u533a\\u5343\\u675f38\\u4e01\\u76ee23\\u756a7\\u53f7 \\u7baa\\u7b25\\u753a\\u30cf\\u30a4\\u30c4349"}]')
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Md5(raw_output=False)}}
Outputs:
SomeObject(id=1, formula_field_example=3e92bfaaa510a799067f34c18e175ab3)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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="岡本 舞"|"石川県川崎市宮前区橋場32丁目13番10号"
"森 裕美子"|"岡山県いすみ市脚折町9丁目25番4号"
"村上 陽子"|"長野県富里市蟇沼22丁目16番18号"
"森 翼"|"福岡県武蔵村山市権現堂36丁目16番15号 東上野クレスト801"
"三浦 里佳"|"福岡県武蔵野市日比谷公園16丁目24番11号"
"佐々木 零"|"新潟県長生郡睦沢町湯本塩原35丁目15番3号 ハイツ西神田148"
"三浦 加奈"|"静岡県横浜市南区竜泉14丁目26番20号 コート鶴ヶ丘196"
"石井 千代"|"千葉県香取郡多古町柿木沢新田3丁目20番9号 上野桜木ハイツ220"
"太田 零"|"大分県渋谷区松が谷18丁目17番8号 アーバン高田馬場775"
"山崎 学"|"島根県国立市日比谷公園13丁目8番1号"
)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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"|"中村 千代"|"埼玉県文京区津久戸町4丁目4番5号 神明内パレス013"|"silver"
"2"|"山下 治"|"茨城県君津市土沢13丁目6番4号 雷門アーバン086"|"silver"
"3"|"木村 治"|"秋田県多摩市皇居外苑23丁目14番6号"|"black"
"4"|"高橋 陽子"|"宮崎県渋谷区木立17丁目12番16号"|"aqua"
"5"|"太田 稔"|"宮城県横浜市鶴見区氏家11丁目11番17号"|"olive"
"6"|"斉藤 零"|"熊本県印旛郡栄町東和町31丁目22番14号 橋場クレスト642"|"blue"
"7"|"藤田 裕太"|"静岡県神津島村中鉢石町35丁目9番5号"|"navy"
"8"|"森 陽子"|"大分県江東区油井20丁目13番14号 方京パレス523"|"navy"
"9"|"橋本 裕美子"|"岩手県中野区高田馬場3丁目6番15号 東三島クレスト787"|"white"
"10"|"高橋 直樹"|"長野県横浜市金沢区入谷4丁目26番14号 鍛冶ケ沢コート206"|"gray"
)
fake: Sha1¶
Generate a random SHA-1 hash.
If raw_output
is False
(default), a hexadecimal string representation of the SHA-1 hash
will be returned. If True
, a bytes
object representation will be returned instead.
Aliases: sha1
Source: faker : faker.providers.misc.en_US.Provider.sha1
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Sha1(raw_output=False)}}
Outputs:
SomeObject(id=1, formula_field_example=02347357d13590815eb822d13e8366e27cf35e1b)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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="岡本 舞" "石川県川崎市宮前区橋場32丁目13番10号"
"森 裕美子" "岡山県いすみ市脚折町9丁目25番4号"
"村上 陽子" "長野県富里市蟇沼22丁目16番18号"
"森 翼" "福岡県武蔵村山市権現堂36丁目16番15号 東上野クレスト801"
"三浦 里佳" "福岡県武蔵野市日比谷公園16丁目24番11号"
"佐々木 零" "新潟県長生郡睦沢町湯本塩原35丁目15番3号 ハイツ西神田148"
"三浦 加奈" "静岡県横浜市南区竜泉14丁目26番20号 コート鶴ヶ丘196"
"石井 千代" "千葉県香取郡多古町柿木沢新田3丁目20番9号 上野桜木ハイツ220"
"太田 零" "大分県渋谷区松が谷18丁目17番8号 アーバン高田馬場775"
"山崎 学" "島根県国立市日比谷公園13丁目8番1号"
)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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" "中村 千代" "埼玉県文京区津久戸町4丁目4番5号 神明内パレス013" "silver"
"2" "山下 治" "茨城県君津市土沢13丁目6番4号 雷門アーバン086" "silver"
"3" "木村 治" "秋田県多摩市皇居外苑23丁目14番6号" "black"
"4" "高橋 陽子" "宮崎県渋谷区木立17丁目12番16号" "aqua"
"5" "太田 稔" "宮城県横浜市鶴見区氏家11丁目11番17号" "olive"
"6" "斉藤 零" "熊本県印旛郡栄町東和町31丁目22番14号 橋場クレスト642" "blue"
"7" "藤田 裕太" "静岡県神津島村中鉢石町35丁目9番5号" "navy"
"8" "森 陽子" "大分県江東区油井20丁目13番14号 方京パレス523" "navy"
"9" "橋本 裕美子" "岩手県中野区高田馬場3丁目6番15号 東三島クレスト787" "white"
"10" "高橋 直樹" "長野県横浜市金沢区入谷4丁目26番14号 鍛冶ケ沢コート206" "gray"
)
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Uuid4}}
Outputs:
SomeObject(id=1, formula_field_example=eb1167b3-67a9-4378-bc65-c1e582e2e662)
Passport Fakers¶
fake: PassportDates¶
Generates a formatted date of birth, issue, and expiration dates. issue and expiration dates are conditioned to fall within U.S. standards of 5 and 10 year expirations
The birthday
argument is a datetime.date object representing a date of birth.
Sources:
-https://travel.state.gov/content/travel/en/passports/passport-help/faqs.html
Aliases: passport_dates, passportdates
Source: faker : faker.providers.passport.en_US.Provider.passport_dates
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportDates}}
Outputs:
SomeObject(id=1, formula_field_example=('16 Apr 2024', '16 Apr 2024', '16 Apr 2029'))
fake: PassportDob¶
Generate a datetime date of birth.
Aliases: passport_dob, passportdob
Source: faker : faker.providers.passport.en_US.Provider.passport_dob
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportDob}}
Outputs:
SomeObject(id=1, formula_field_example=1957-01-28)
fake: PassportFull¶
Generates a formatted sting with US Passport information
Aliases: passport_full, passportfull
Source: faker : faker.providers.passport.en_US.Provider.passport_full
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportFull}}
Outputs:
SomeObject(id=1, formula_field_example=陽子
青木
F
21 Dec 1919
21 Aug 2018
21 Aug 2028
R77840801
)
fake: PassportGender¶
Generates a string representing the gender displayed on a passport
Sources:
- https://williamsinstitute.law.ucla.edu/publications/x-gender-markers-passports/
Aliases: passport_gender, passportgender
Source: faker : faker.providers.passport.en_US.Provider.passport_gender
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportGender}}
Outputs:
SomeObject(id=1, formula_field_example=F)
fake: PassportNumber¶
Generate a passport number by replacing tokens to be alphanumeric
Aliases: passport_number, passportnumber
Source: faker : faker.providers.passport.en_US.Provider.passport_number
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportNumber}}
Outputs:
SomeObject(id=1, formula_field_example=J11578156)
fake: PassportOwner¶
Generate a given_name and surname for a passport owner
The gender
argument is the gender marker of a passport owner, which is a one character string
that is either male, female, or non-binary.
Aliases: passport_owner, passportowner
Source: faker : faker.providers.passport.en_US.Provider.passport_owner
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PassportOwner}}
Outputs:
SomeObject(id=1, formula_field_example=('直人', '岡田'))
Person Fakers¶
fake: LanguageName¶
Generate a random i18n language name (e.g. English).
Aliases: language_name, languagename
Source: faker : faker.providers.person.ja_JP.Provider.language_name
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.last_name_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LastNameFemale}}
Outputs:
SomeObject(id=1, formula_field_example=石川)
fake: LastNameMale¶
Aliases: last_name_male, lastnamemale
Source: faker : faker.providers.person.ja_JP.Provider.last_name_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LastNameMale}}
Outputs:
SomeObject(id=1, formula_field_example=石川)
fake: LastNameNonbinary¶
Aliases: last_name_nonbinary, lastnamenonbinary
Source: faker : faker.providers.person.ja_JP.Provider.last_name_nonbinary
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.LastNameNonbinary}}
Outputs:
SomeObject(id=1, formula_field_example=石川)
fake: Name¶
Example:: 'John Doe'
Aliases: name
Source: faker : faker.providers.person.ja_JP.Provider.name
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Name}}
Outputs:
SomeObject(id=1, formula_field_example=山下 七夏)
fake: NameFemale¶
Aliases: name_female, namefemale
Source: faker : faker.providers.person.ja_JP.Provider.name_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.NameFemale}}
Outputs:
SomeObject(id=1, formula_field_example=山下 七夏)
fake: NameMale¶
Aliases: name_male, namemale
Source: faker : faker.providers.person.ja_JP.Provider.name_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.NameMale}}
Outputs:
SomeObject(id=1, formula_field_example=山下 零)
fake: NameNonbinary¶
Aliases: name_nonbinary, namenonbinary
Source: faker : faker.providers.person.ja_JP.Provider.name_nonbinary
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.NameNonbinary}}
Outputs:
SomeObject(id=1, formula_field_example=山下 七夏)
fake: Prefix¶
Aliases: prefix
Source: faker : faker.providers.person.ja_JP.Provider.prefix
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Prefix}}
Outputs:
SomeObject(id=1, formula_field_example=)
fake: PrefixFemale¶
Aliases: prefix_female, prefixfemale
Source: faker : faker.providers.person.ja_JP.Provider.prefix_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PrefixFemale}}
Outputs:
SomeObject(id=1, formula_field_example=)
fake: PrefixMale¶
Aliases: prefix_male, prefixmale
Source: faker : faker.providers.person.ja_JP.Provider.prefix_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PrefixMale}}
Outputs:
SomeObject(id=1, formula_field_example=)
fake: PrefixNonbinary¶
Aliases: prefix_nonbinary, prefixnonbinary
Source: faker : faker.providers.person.ja_JP.Provider.prefix_nonbinary
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.PrefixNonbinary}}
Outputs:
SomeObject(id=1, formula_field_example=)
fake: Suffix¶
Aliases: suffix
Source: faker : faker.providers.person.ja_JP.Provider.suffix
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Suffix}}
Outputs:
SomeObject(id=1, formula_field_example=)
fake: SuffixFemale¶
Aliases: suffix_female, suffixfemale
Source: faker : faker.providers.person.ja_JP.Provider.suffix_female
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.SuffixFemale}}
Outputs:
SomeObject(id=1, formula_field_example=)
fake: SuffixMale¶
Aliases: suffix_male, suffixmale
Source: faker : faker.providers.person.ja_JP.Provider.suffix_male
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.SuffixMale}}
Outputs:
SomeObject(id=1, formula_field_example=)
fake: SuffixNonbinary¶
Aliases: suffix_nonbinary, suffixnonbinary
Source: faker : faker.providers.person.ja_JP.Provider.suffix_nonbinary
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.SuffixNonbinary}}
Outputs:
SomeObject(id=1, formula_field_example=)
Phone_Number Fakers¶
fake: CountryCallingCode¶
Aliases: country_calling_code, countrycallingcode
Source: faker : faker.providers.phone_number.ja_JP.Provider.country_calling_code
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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.ja_JP.Provider.msisdn
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Profile}}
Outputs:
SomeObject(id=1, formula_field_example={'job': '調理師', 'company': '有限会社吉田印刷', 'ssn': '437-08-1649', 'residence': '宮崎県山武郡横芝光町中鉢石町37丁目21番18号', 'current_location': (Decimal('71.6439095'), Decimal('-140.273217')), 'blood_group': 'A+', 'website': ['http://www.yamashita.com/'], 'username': 'sasakitaro', 'name': '高橋 学', 'sex': 'M', 'address': '茨城県八王子市幸手4丁目22番1号 コート箪笥町413', 'mail': 'fujiimanabu@yahoo.com', 'birthdate': datetime.date(1958, 11, 15)})
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.SimpleProfile}}
Outputs:
SomeObject(id=1, formula_field_example={'username': 'kaori71', 'name': '渡辺 香織', 'sex': 'F', 'address': '徳島県安房郡鋸南町箭坪36丁目11番18号 権現堂コート719', 'mail': 'kyamazaki@gmail.com', 'birthdate': datetime.date(1941, 12, 19)})
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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Bothify(letters='ABCDE')}}
Outputs:
SomeObject(id=1, formula_field_example=75 EB)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Locale}}
Outputs:
SomeObject(id=1, formula_field_example=ro_RO)
fake: Numerify¶
Generate a string with each placeholder in text
replaced according
to the following rules:
- Number signs ('#') are replaced with a random digit (0 to 9).
- Percent signs ('%') are replaced with a random non-zero digit (1 to 9).
- Dollar signs ('$') are replaced with a random digit above two (2 to 9).
- Exclamation marks ('!') are replaced with a random digit or an empty string.
- At symbols ('@') are replaced with a random non-zero digit or an empty string.
Under the hood, this method uses :meth:random_digit() <faker.providers.BaseProvider.random_digit>
,
:meth:random_digit_not_null() <faker.providers.BaseProvider.random_digit_not_null>
,
:meth:random_digit_or_empty() <faker.providers.BaseProvider.random_digit_or_empty>
,
and :meth:random_digit_not_null_or_empty() <faker.providers.BaseProvider.random_digit_not_null_or_empty>
to generate the random values.
Aliases: numerify
Source: faker : faker.providers.user_agent.Provider.numerify
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomDigit}}
Outputs:
SomeObject(id=1, formula_field_example=0)
fake: RandomDigitAboveTwo¶
Generate a random digit above value two (2 to 9).
Aliases: random_digit_above_two, randomdigitabovetwo
Source: faker : faker.providers.user_agent.Provider.random_digit_above_two
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomDigitAboveTwo}}
Outputs:
SomeObject(id=1, formula_field_example=2)
fake: RandomDigitNotNull¶
Generate a random non-zero digit (1 to 9).
Aliases: random_digit_not_null, randomdigitnotnull
Source: faker : faker.providers.user_agent.Provider.random_digit_not_null
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomLowercaseLetter}}
Outputs:
SomeObject(id=1, formula_field_example=n)
fake: RandomNumber¶
Generate a random integer according to the following rules:
- If
digits
isNone
(default), its value will be set to a random integer from 1 to 9. - If
fix_len
isFalse
(default), all integers that do not exceed the number ofdigits
can be generated. - If
fix_len
isTrue
, only integers with the exact number ofdigits
can be generated.
Aliases: random_number, randomnumber
Source: faker : faker.providers.user_agent.Provider.random_number
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomNumber(fix_len=False)}}
Outputs:
SomeObject(id=1, formula_field_example=521760889)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomNumber(fix_len=True)}}
Outputs:
SomeObject(id=1, formula_field_example=9268)
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomNumber(digits=3)}}
Outputs:
SomeObject(id=1, formula_field_example=143)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomUppercaseLetter}}
Outputs:
SomeObject(id=1, formula_field_example=N)
fake: RandomizeNbElements¶
Generate a random integer near number
according to the following rules:
- If
le
isFalse
(default), allow generation up to 140% ofnumber
. IfTrue
, upper bound generation is capped at 100%. - If
ge
isFalse
(default), allow generation down to 60% ofnumber
. IfTrue
, lower bound generation is capped at 100%. - If a numerical value for
min
is provided, generated values less thanmin
will be clamped atmin
. - If a numerical value for
max
is provided, generated values greater thanmax
will be clamped atmax
. - If both
le
andge
areTrue
, the value ofnumber
will automatically be returned, regardless of the values supplied formin
andmax
.
Aliases: randomize_nb_elements, randomizenbelements
Source: faker : faker.providers.user_agent.Provider.randomize_nb_elements
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomizeNbElements(number=100)}}
Outputs:
SomeObject(id=1, formula_field_example=65)
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.RandomizeNbElements(number=79, le=True, ge=True,
min=80)}}
Outputs:
SomeObject(id=1, formula_field_example=79)
Python Fakers¶
fake: Pybool¶
Generates a random boolean, optionally biased towards True
or False
.
:truth_probability: Probability of generating a True
value. Must be between 0
and 100
inclusive'.
Return:: Random boolean.
:raises ValueError: If invalid truth_probability
is provided.
Aliases: pybool
Source: faker : faker.providers.python.Provider.pybool
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Pydecimal}}
Outputs:
SomeObject(id=1, formula_field_example=-54602810789.3423209471122018684833969477515917953304135256012309891013991615109032173)
fake: Pydict¶
Returns a dictionary.
:nb_elements: number of elements for dictionary :variable_nb_elements: is use variable number of elements for dictionary :value_types: type of dictionary values
Aliases: pydict
Source: faker : faker.providers.python.Provider.pydict
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Pydict}}
Outputs:
SomeObject(id=1, formula_field_example={'葉': 'rGciZpuCpymcjBdurvfV', 'バスケット': Decimal('-6549903182054842898289740559728455724548119.045229611133060168847793615349263511087317643039213765'), '明らかにする': datetime.datetime(2014, 11, 25, 2, 51, 4, 667904), '供給': 'ZZhvJTzVqzzIkFlrYUQb', 'ブランチ': 'TFitpKyPAVdgpNxSPTxt', 'コピー': 8680, '持っていました': datetime.datetime(1971, 10, 29, 15, 27, 39, 517786), 'ジャーナル': 'JPNZMVkBFQzPuESPIajA', '符号': 529902351.901653})
fake: Pyfloat¶
Aliases: pyfloat
Source: faker : faker.providers.python.Provider.pyfloat
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Pyiterable}}
Outputs:
SomeObject(id=1, formula_field_example=['JDXWVcMKILUHtBkEahrP', 'rGciZpuCpymcjBdurvfV', Decimal('-6549903182054842898289740559728455724548119.045229611133060168847793615349263511087317643039213765'), datetime.datetime(2014, 11, 25, 2, 51, 4, 667904), 'ZZhvJTzVqzzIkFlrYUQb', 'TFitpKyPAVdgpNxSPTxt'])
fake: Pylist¶
Aliases: pylist
Source: faker : faker.providers.python.Provider.pylist
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Pylist}}
Outputs:
SomeObject(id=1, formula_field_example=['chiyo92@example.net', -87353308.1354309, 'EKilxKJTbTDOKidKxUVF', 'TzqyQTQjZGeLZuJqlLaQ', datetime.datetime(2003, 3, 26, 4, 4, 50, 474288), 'gHToYfSueoxPSgBHsToa', 'knqtDSSXFzHxwTjtphor', 1535, 584])
fake: Pyobject¶
Generates a random object passing the type desired.
:object_type: the type of the object to generate.
Return:: the random object generated. :raises ValueError: if the object type passed is not supported
Aliases: pyobject
Source: faker : faker.providers.python.Provider.pyobject
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Pyobject}}
Outputs:
SomeObject(id=1, formula_field_example=None)
fake: Pyset¶
Aliases: pyset
Source: faker : faker.providers.python.Provider.pyset
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Pyset}}
Outputs:
SomeObject(id=1, formula_field_example={-87353308.1354309, 584, 'knqtDSSXFzHxwTjtphor', 'TzqyQTQjZGeLZuJqlLaQ', 'chiyo92@example.net', 'gHToYfSueoxPSgBHsToa', datetime.datetime(2003, 3, 26, 4, 4, 50, 474288), 'EKilxKJTbTDOKidKxUVF', 1535})
fake: Pystr¶
Generates a random string of upper and lowercase letters.
Param: min_chars: minimum length of the random part.
Param: max_chars: maximum length of the random part.
Param: prefix: an optional prefix to prepend to the random string.
Param: suffix: an optional suffix to append to the random string.
Return:: Random of random length between min and max characters.
Aliases: pystr
Source: faker : faker.providers.python.Provider.pystr
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Pystruct}}
Outputs:
SomeObject(id=1, formula_field_example=(['ddOgQWwfLxAUChtSAeAb', 'mituru31@example.net', 'reimurakami@example.net', 'eSXwztwkwOnQysPxmxgr', 'xZDDMtvFrZZhLRYzheSS', -475587436.952736, datetime.datetime(1991, 9, 11, 14, 17, 41, 633408), 'https://kobayashi.com/posts/blog/appauthor.jsp', 'taro47@example.org', 'sJSMGlaSNXhYrDbPWXih'], {'教授': Decimal('5927641.7483616001504400090292719208'), 'フレーム': 'ahMKHhgzzgYQTiIQqZeP', '仕上げ': datetime.datetime(2014, 6, 8, 19, 7, 22, 298744), '偏差': 'http://yamashita.jp/search/categories/wp-contentindex.jsp', 'パン': 'qkGqzrYSUZTOaJVoAKfw', '反射': Decimal('8373392865588440.54927709526042921687826528592113137306'), '日曜日': 'DvctPNYSzPOvuDxGQVHB', 'プラスチック': 'http://www.okada.jp/listcategory.htm', 'ピック': -386518988.59794, '柔らかい': 'cBwKJtcYkMDbMYhLDCwx'}, {'腐った': {0: datetime.datetime(1983, 6, 22, 2, 38, 10, 318141), 1: [6090, datetime.datetime(2019, 9, 3, 14, 13, 41, 690330), datetime.datetime(2007, 12, 9, 3, 28, 41, 491464)], 2: {0: datetime.datetime(1991, 4, 22, 2, 20, 20, 776368), 1: 82259298362.6637, 2: [4646, 8280]}}, '保持する': {1: 'yukiyamashita@example.org', 2: [-71.564173662751, 'tomoya60@example.com', datetime.datetime(1984, 9, 1, 11, 41, 38, 652809)], 3: {1: 'VcZLZHaJlZWSKnWQGikD', 2: 'http://suzuki.com/posts/blogpost.html', 3: [2817, 3837]}}, 'トリビュート': {2: Decimal('-12979101337682679491249799408799723504461539.52736903976622667341290421242648658677149544469807883'), 3: [4460, 'cfujiwara@example.org', 9102], 4: {2: 'XoQbJuBCBCMUEPNFkwli', 3: 'https://www.ogawa.org/search/tagterms.html', 4: [Decimal('-620161498196260518936359354009769011542758819214490827329000080666415416926528496774368842.689142822153007719802792941452750'), 1691]}}, '衝突': {3: 'zfExqeqosLgtNqSSjHHi', 4: [datetime.datetime(1978, 8, 20, 15, 17, 7, 841802), 'eBnKcMuzhhVhgvUoDfSU', 2819], 5: {3: datetime.datetime(1994, 7, 29, 4, 45, 56, 43128), 4: -80.7103053486144, 5: [798112357130.87, 'HQNJxURrwPpQhjlmgNws']}}, '今日': {9: datetime.datetime(1980, 2, 19, 22, 10, 45, 576386), 10: [306, 4722, 9232], 11: {9: 'mVtOrZJtdjXDPlBFWAWq', 10: 'http://www.ishikawa.jp/search/searchsearch.php', 11: ['qnPrOttTshYkEZwPKNtb', 9299]}}, '創傷': {5: datetime.datetime(2010, 9, 11, 6, 49, 19, 257301), 6: ['qxVlNMaQLZPQlYsPjLkY', 'stpnZRSbXQQWvdDBlMZL', 'OQiFFTwnBzacjzIBDZet'], 7: {5: datetime.datetime(2013, 11, 7, 17, 50, 57, 543006), 6: 'TGIUPEavdYQrfDsLRFQa', 7: ['QDpaJxdOIPgtjlCbcvoR', 'IGAWQEJvAGRkxjkbgNrp']}}, 'ブランチ': {8: datetime.datetime(1997, 5, 19, 0, 28, 36, 706241), 9: [4425, 'https://www.mori.org/posts/postsauthor.html', 7474189.21174694], 10: {8: 'smTcxtSRqJxnKyKMDnha', 9: 8594, 10: ['kyosuke57@example.net', 4349]}}, 'インチ': {7: 'maedamiki@example.com', 8: [4165, Decimal('4996608642090442339048514562020811377836125.6306984690815062120843539136540174632702029015033744958579803233121098199677609858329484698'), 'xDWnIMQDYYAxfEqJLTMQ'], 9: {7: 9647, 8: 'CDIWaqyAVzmSAOnXuxyr', 9: ['https://www.mori.org/blog/mainregister.htm', 'http://www.kondo.com/explore/tag/taghome.html']}}}))
fake: Pytuple¶
Aliases: pytuple
Source: faker : faker.providers.python.Provider.pytuple
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Pytuple}}
Outputs:
SomeObject(id=1, formula_field_example=('chiyo92@example.net', -87353308.1354309, 'EKilxKJTbTDOKidKxUVF', 'TzqyQTQjZGeLZuJqlLaQ', datetime.datetime(2003, 3, 26, 4, 4, 50, 474288), 'gHToYfSueoxPSgBHsToa', 'knqtDSSXFzHxwTjtphor', 1535, 584))
Sbn Fakers¶
fake: Sbn9¶
Aliases: sbn9
Source: faker : faker.providers.sbn.Provider.sbn9
Recipe:
- var: snowfakery_locale
value: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Sbn9}}
Outputs:
SomeObject(id=1, formula_field_example=19-489241-2)
Ssn Fakers¶
fake: Ein¶
Generate a random United States Employer Identification Number (EIN).
An United States An Employer Identification Number (EIN) is also known as a Federal Tax Identification Number, and is used to identify a business entity. EINs follow a format of a two-digit prefix followed by a hyphen and a seven-digit sequence: ##-######
https://www.irs.gov/businesses/small-businesses-self-employed/employer-id-numbers
Aliases: ein
Source: faker : faker.providers.ssn.en_US.Provider.ein
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.Firefox}}
Outputs:
SomeObject(id=1, formula_field_example=Mozilla/5.0 (Windows 95; brx-IN; rv:1.9.2.20) Gecko/4543-03-16 09:03:06.006958 Firefox/3.8)
fake: InternetExplorer¶
Generate an IE web browser user agent string.
Aliases: internet_explorer, internetexplorer
Source: faker : faker.providers.user_agent.Provider.internet_explorer
Recipe:
- var: snowfakery_locale
value: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- 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: ja_JP
- object: SomeObject
fields:
formula_field_example: ${{fake.WindowsPlatformToken}}
Outputs:
SomeObject(id=1, formula_field_example=Windows NT 5.01)