Faker 0.7.3

Faker is a Python package that generates fake data for you.

_|_|_|_|          _|
_|        _|_|_|  _|  _|      _|_|    _|  _|_|
_|_|_|  _|    _|  _|_|      _|_|_|_|  _|_|
_|      _|    _|  _|  _|    _|        _|
_|        _|_|_|  _|    _|    _|_|_|  _|

Faker is a Python package that generates fake data for you. Whether you need to bootstrap your database, create good-looking XML documents, fill-in your persistence to stress test it, or anonymize data taken from a production service, Faker is for you.

Faker is heavily inspired by PHP Faker, Perl Faker, and by Ruby Faker.

---

---

For more details, see the extended docs.

Basic Usage

Install with pip:

pip install Faker

Use faker.Factory.create() to create and initialize a faker generator, which can generate data by accessing properties named after the type of data you want.

from faker import Factory
fake = Factory.create()

# OR
from faker import Faker
fake = Faker()

fake.name()
# 'Lucy Cechtelar'

fake.address()
# "426 Jordy Lodge
#  Cartwrightshire, SC 88120-6700"

fake.text()
# Sint velit eveniet. Rerum atque repellat voluptatem quia rerum. Numquam excepturi
# beatae sint laudantium consequatur. Magni occaecati itaque sint et sit tempore. Nesciunt
# amet quidem. Iusto deleniti cum autem ad quia aperiam.
# A consectetur quos aliquam. In iste aliquid et aut similique suscipit. Consequatur qui
# quaerat iste minus hic expedita. Consequuntur error magni et laboriosam. Aut aspernatur
# voluptatem sit aliquam. Dolores voluptatum est.
# Aut molestias et maxime. Fugit autem facilis quos vero. Eius quibusdam possimus est.
# Ea quaerat et quisquam. Deleniti sunt quam. Adipisci consequatur id in occaecati.
# Et sint et. Ut ducimus quod nemo ab voluptatum.

Each call to method fake.name() yields a different (random) result. This is because faker forwards faker.Generator.method_name() calls to faker.Generator.format(method_name).

for _ in range(0,10):
  print fake.name()

    # Adaline Reichel
    # Dr. Santa Prosacco DVM
    # Noemy Vandervort V
    # Lexi O'Conner
    # Gracie Weber
    # Roscoe Johns
    # Emmett Lebsack
    # Keegan Thiel
    # Wellington Koelpin II
    # Ms. Karley Kiehn V

Providers

Each of the generator properties (like name, address, and lorem) are called “fake”. A faker generator has many of them, packaged in “providers”.

Check the extended docs for a list of bundled providers and a list of community providers.

Localization

faker.Factory can take a locale as an argument, to return localized data. If no localized provider is found, the factory falls back to the default en_US locale.

from faker import Factory
fake = Factory.create('it_IT')
for _ in range(0,10):
    print fake.name()

> Elda Palumbo
> Pacifico Giordano
> Sig. Avide Guerra
> Yago Amato
> Eustachio Messina
> Dott. Violante Lombardo
> Sig. Alighieri Monti
> Costanzo Costa
> Nazzareno Barbieri
> Max Coppola

You can check available Faker locales in the source code, under the providers package. The localization of Faker is an ongoing process, for which we need your help. Please don’t hesitate to create a localized provider for your own locale and submit a Pull Request (PR).

Included localized providers:

• bg_BG - Bulgarian

• cs_CZ - Czech

• de_DE - German

• dk_DK - Danish

• el_GR - Greek

• en_AU - English (Australia)

• en_CA - English (Canada)

• en_GB - English (Great Britain)

• en_US - English (United States)

• es_ES - Spanish (Spain)

• es_MX - Spanish (Mexico)

• fa_IR - Persian (Iran)

• fi_FI - Finnish

• fr_FR - French

• hi_IN - Hindi

• hr_HR - Croatian

• it_IT - Italian

• ja_JP - Japanese

• ko_KR - Korean

• lt_LT - Lithuanian

• lv_LV - Latvian

• ne_NP - Nepali

• nl_NL - Dutch (Netherlands)

• no_NO - Norwegian

• pl_PL - Polish

• pt_BR - Portuguese (Brazil)

• pt_PT - Portuguese (Portugal)

• ru_RU - Russian

• sl_SI - Slovene

• sv_SE - Swedish

• tr_TR - Turkish

• zh_CN - Chinese (China)

• zh_TW - Chinese (Taiwan)

Command line usage

When installed, you can invoke faker from the command-line:

faker [-h] [--version] [-o output]
      [-l {bg_BG,cs_CZ,...,zh_CN,zh_TW}]
      [-r REPEAT] [-s SEP]
      [-i {module.containing.custom_provider othermodule.containing.custom_provider}]
      [fake] [fake argument [fake argument ...]]

Where:

• faker: is the script when installed in your environment, in development you could use python -m faker instead

• -h, --help: shows a help message

• --version: shows the program’s version number

• -o FILENAME: redirects the output to the specified filename

• -l {bg_BG,cs_CZ,...,zh_CN,zh_TW}: allows use of a localized provider

• -r REPEAT: will generate a specified number of outputs

• -s SEP: will generate the specified separator after each generated output

• -i {my.custom_provider other.custom_provider} list of additional custom providers to use. Note that is the import path of the module containing your Provider class, not the custom Provider class itself.

• fake: is the name of the fake to generate an output for, such as name, address, or text

• [fake argument ...]: optional arguments to pass to the fake (e.g. the profile fake takes an optional list of comma separated field names as the first argument)

Examples:

$ faker address
968 Bahringer Garden Apt. 722
Kristinaland, NJ 09890

$ faker -l de_DE address
Samira-Niemeier-Allee 56
94812 Biedenkopf

$ faker profile ssn,birthdate
{'ssn': u'628-10-1085', 'birthdate': '2008-03-29'}

$ faker -r=3 -s=";" name
Willam Kertzmann;
Josiah Maggio;
Gayla Schmitt;

How to create a Provider

from faker import Faker
fake = Faker()

# first, import a similar Provider or use the default one
from faker.providers import BaseProvider

# create new provider class
class MyProvider(BaseProvider):
    def foo(self):
        return 'bar'

# then add new provider to faker instance
fake.add_provider(MyProvider)

# now you can use:
fake.foo()
> 'bar'

How to use with factory-boy

import factory
from faker import Factory as FakerFactory
from myapp.models import Book

faker = FakerFactory.create()


class Book(factory.Factory):
    FACTORY_FOR = Book

    title = factory.LazyAttribute(lambda x: faker.sentence(nb_words=4))
    author_name = factory.LazyAttribute(lambda x: faker.name())

Accessing the random instance

The .random property on the generator returns the instance of random.Random used to generate the values:

from faker import Faker
fake = Faker()
fake.random
fake.random.getstate()

Seeding the Generator

When using Faker for unit testing, you will often want to generate the same data set. For convenience, the generator also provide a seed() method, which seeds the random number generator. Calling the same script twice with the same seed produces the same results.

from faker import Faker
fake = Faker()
fake.seed(4321)

print fake.name()
> Margaret Boehm

The code above is equivalent to the following:

from faker import Faker
fake = Faker()
faker.random.seed(4321)

print fake.name()
> Margaret Boehm

Tests

Installing dependencies:

$ pip install -r faker/tests/requirements.txt

Run tests:

$ python setup.py test

or

$ python -m unittest -v faker.tests

Write documentation for providers:

$ python -m faker > docs.txt

Contribute

Please see CONTRIBUTING.

License

Faker is released under the MIT License. See the bundled LICENSE file for details.

Credits

• FZaninotto / PHP Faker

• Distribute

• Buildout

• modern-package-template

Changelog

0.7.3 - 16-September-2016

• date_time_this_century now returns datetime s outside the current decade. Thanks @JarUrb.

• Add support for localized jobs for hr_HR. Thanks @mislavcimpersak.

• Adding support for Croatian hr_HR ssn (oib). Thanks @mislavcimpersak.

• Rename PyPI package to Faker.

0.6.0 - 09-August-2016

• Dropped Python 2.6 support

0.5.11 - 09-August-2016

• Add optional parameter sex to profile and simple_profile. Thanks @navyad.

• Fix whitespace in dk_DK provider last_names/last_name. Thanks @iAndriy.

• Fix utf8 coding issue with address/fi_FI provider. Thanks @delneg.

• ! Latest version to support Python 2.6

0.5.10 - 01-August-2016

• Fix random_sample_unique. Thanks @cecedille1.

0.5.9 - 08-July-2016

• Add more pt_BR names. Thanks @cuducos.

• Added en_GB names. Thanks @jonny5532.

• Add romanized internet provider for zh_CN.

• Add fr_CH providers. Thanks @gfavre.

0.5.8 - 28-June-2016

• Improve CLI output and help. Thanks @cbaines.

• Update en_US anmes to be more realistic. Thanks @dethpickle.

• Modify pystr provider to accept a minimum number of characters. Thanks @tamarbuta.

• Add job Provider for zh_TW. Thanks @weihanglo.

• Modify zh_TW phone number for a more valid format. Thanks @weihanglo.

• Reduce the maximum value of start timestamps. Thanks @cbaines.

• Add random_sample and random_sample_unique. Thanks @bengolder.

0.5.7 - 07-March-2016

• Repackage to resolve PyPI issue.

0.5.6 - 07-March-2016

• Add date handling for datetime functions. Thanks @rpkilby.

• Discern male and female first names in pt_BR. Thanks @gabrielusvicente.

0.5.5 - 29-February-2016

• Specify help text for command line. Thanks @cbaines.

0.5.4 - 29-February-2016

• Expose Provider’s random instance. Thank @gsingers for the suggestion.

• Make sure required characters are in the password. Thanks @craig552uk.

• Add internet and job Providers for fa_IR. Thanks @hamidfzm.

• Correct Poland phone numbers. Thanks @fizista.

• Fix brittly tests due to seconds elapsed in-between comparison

• Allow unicode in emails and domains. Thanks @zdelagrange for the report.

• Use dateutil for computing next_month. Thanks @mark-love, @rshk.

• Fix tests module import. Thanks @jorti for the report.

• Handle unexpected length in ean(). Thanks @michaelcho.

• Add internet provider for ja_JP. Thanks @massa142.

• Add Romanized Japanese person name. Thanks @massa142.

• Add tzinfo support to datetime methods. Thanks @j0hnsmith.

• Add an ‘office’ file extensions category. Thanks @j0hnsmith.

• Generate name according to profile’s sex. Thanks @Dutcho for the report.

• Add bs_BA phone number and internet provider. Thanks @elahmo.

• Add a SSN provider for zh_CN. Thanks @felixonmars.

• Differentiate male and female first names in fr_FR locale. Thanks @GregoryVds

• Add Maestro credit card. Thanks @anthonylauzon.

• Add hr_HR localization. Thanks @mislavcimpersak.

• Update de_DE first names. Thanks @WarrenFaith and @mschoebel.

• Allow generation of IPv4 and IPv6 network address with valid CIDR. Thanks @kdeldycke.

• Unittest IPv4 and IPv6 address and network generation. Thanks @kdeldycke.

• Add a new provider to generate random binary blob. Thanks @kdeldycke.

• Check that randomly produced language codes are parseable as locale by the factory constructor. Thanks @kdeldycke.

• Fix chinese random language code. Thanks @kdeldycke.

• Remove duplicate words from Lorem provider. Thanks @jeffwidman.

0.5.3 - 21-September-2015

• Added company_vat to company fi_FI provider. Thanks @kivipe.

• Seed a Random instance instead of the module. Thanks Amy Hanlon.

• Fixed en_GB postcodes to be more realistic. Thanks @mapleoin for the report.

• Fixed support for Python 3 in the python provider. Thanks @derekjamescurtis.

• Fixed U.S. SSN generation. Thanks @jschaf.

• Use environment markers for wheels. Thanks @RonnyPfannschmidt

• Fixed Python3 issue in pyiterable and pystruct providers. Thanks @derekjamescurtis.

• Fixed en_GB postcodes to be more realistic. Thanks @mapleoin.

• Fixed and improved performance of credit card number provider. Thanks @0x000.

• Added Brazilian SSN, aka CPF. Thanks @ericchaves.

• Added female and male names for fa_IR. Thanks @afshinrodgar.

• Fixed issues with Decimal objects as input to geo_coordinate. Thanks @davy.

• Fixed bug for center set to None in geo_coordinate. Thanks @davy.

• Fixed deprecated image URL placeholder services.

• Fixed provider’s example formatting in documentation.

• Added en_AU provider. Thanks @xfxf.

0.5.2 - 11-June-2015

• Added uuid4 to misc provider. Thanks Jared Culp.

• Fixed jcb15 and jcb16 in credit_card provider. Thanks Rodrigo Braz.

• Fixed CVV and CID code generation in credit_card provider. Thanks Kevin Stone.

• Added --include flag to command line tool. Thanks Flavio Curella.

• Added country_code to address` provider. Thanks @elad101 and Tobin Brown.

0.5.1 - 21-May-2015

• Fixed egg installation. Thanks David R. MacIver, @kecaps

• Updated person names for ru_RU. Thanks @mousebaiker.

• Updated ko_KR locale. Thanks Lee Yeonjae.

• Fixed installation to install importlib on Python 2.6. Thanks Guillaume Thomas.

• Improved tests. Thanks Aarni Koskela, @kecaps, @kaushal.

• Made Person prefixes/suffixes always return strings. Thanks Aarni Koskela.

• pl_PL jobs added. Thanks Dariusz Choruży.

• Added ja_JP provider. Thanks Tatsuji Tsuchiya, Masato Ohba.

• Localized remaining providers for consistency. Thanks Flavio Curella.

• List of providers in compiled on runtime and is not hardcoded anymore. Thanks Flavio Curella.

• Fixed State names in en_US. Thanks Greg Meece.

• Added time_delta method to date_time provider. Thanks Tobin Brown.

• Added filename and file extension methods to file provider. Thanks Tobin Brown.

• Added Finnish ssn (HETU) provider. Thanks @kivipe.

• Fixed person names for pl_PL. Thanks Marek Bleschke.

• Added sv_SE locale providers. Thanks Tome Cvitan.

• pt_BR Provider: Added catch_phrase to Company provider and fixed names in Person Provider. Thanks Marcelo Fonseca Tambalo.

• Added sk_SK localized providers. Thanks @viktormaruna.

• Removed miscelleneous provider. It is superceded by the misc provider.

0.5.0 - 16-Feb-2015

• Localized providers

• Updated ko_KR provider. Thanks Lee Yeonjae.

• Added pt_PT provider. Thanks João Delgado.

• Fixed mispellings for en_US company provider. Thanks Greg Meece.

• Added currency provider. Thanks Wiktor Ślęczka

• Ensure choice_distribution always uses floats. Thanks Katy Lavallee.

• Added uk_UA provider. Thanks Cyril Tarasenko.

• Fixed encoding issues with README, CHANGELOG and setup.py. Thanks Sven-Hendrik Haase.

• Added Turkish person names and phone number patterns. Thanks Murat Çorlu.

• Added ne_NP provider. Thanks Sudip Kafle.

• Added provider for Austrian de_AT. Thanks Bernhard Essl.

0.4.2 - 20-Aug-2014

• Fixed setup

0.4.1 - 20-Aug-2014

• Added MAC address provider. Thanks Sébastien Béal.

• Added lt_LT and lv_LV localized providers. Thanks Edgar Gavrik.

• Added nl_NL localized providers. Thanks @LolkeAB, @mdxs.

• Added bg_BG localized providers. Thanks Bret B.

• Added sl_SI. Thanks to @janezkranjc

• Added distribution feature. Thanks to @fcurella

• Relative date time. Thanks to @soobrosa

• Fixed date_time_ad on 32bit Linux. Thanks @mdxs.

• Fixed domain_word to output slugified strings.

0.4 - 30-Mar-2014

• Modified en_US person.py to ouput female and male names. Thanks Adrian Klaver.

• Added SSN provider for en_US and en_CA. Thanks Scott (@milliquet).

• Added hi_IN localized provider. Thanks Pratik Kabra.

• Refactoring of command line

0.3.2 - 11-Nov-2013

• New provider: Credit card generator

• Improved Documentor

0.3.1

• FIX setup.py

0.3 - 18-Oct-2013

• PEP8 style conversion (old camelCased methods are deprecated!)

• New language: pt_BR (thanks to @rvnovaes)

• all localized provider now uses from __future__ import unicode_literals

• documentor prints localized provider after all defaults

• FIX tests for python 2.6

0.2 - 01-Dec-2012

• New providers: Python, File

• Providers imported with __import__

• Module is runnable with python -m faker [name] [*args]

• Rewrite fake generator system (allow autocompletation)

• New language: French

• Rewrite module __main__ and new Documentor class

0.1 - 13-Nov-2012

• First release