*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`_.
----
::
_|_|_|_| _|
_| _|_|_| _| _| _|_| _| _|_|
_|_|_| _| _| _|_| _|_|_|_| _|_|
_| _| _| _| _| _| _|
_| _|_|_| _| _| _|_|_| _|
|pypi| |build| |coverage| |license|
----
Compatibility
-------------
Starting from version ``4.0.0``, ``Faker`` dropped support for Python 2 and from version ``5.0.0``
only supports Python 3.7 and above. If you still need Python 2 compatibility, please install version ``3.0.1`` in the
meantime, and please consider updating your codebase to support Python 3 so you can enjoy the
latest features ``Faker`` has to offer. Please see the `extended docs`_ for more details, especially
if you are upgrading from version ``2.0.4`` and below as there might be breaking changes.
This package was also previously called ``fake-factory`` which was already deprecated by the end
of 2016, and much has changed since then, so please ensure that your project and its dependencies
do not depend on the old package.
Basic Usage
-----------
Install with pip:
.. code:: bash
pip install Faker
Use ``faker.Faker()`` to create and initialize a faker
generator, which can generate data by accessing properties named after
the type of data you want.
.. code:: python
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)``.
.. code:: python
for _ in range(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'
Pytest fixtures
---------------
``Faker`` also has its own ``pytest`` plugin which provides a ``faker`` fixture you can use in your
tests. Please check out the `pytest fixture docs` to learn more.
Providers
---------
Each of the generator properties (like ``name``, ``address``, and
``lorem``) are called "fake". A faker generator has many of them,
packaged in "providers".
.. code:: python
from faker import Faker
from faker.providers import internet
fake = Faker()
fake.add_provider(internet)
print(fake.ipv4_private())
Check the `extended docs`_ for a list of `bundled providers`_ and a list of
`community providers`_.
Localization
------------
``faker.Faker`` can take a locale as an argument, to return localized
data. If no localized provider is found, the factory falls back to the
default LCID string for US english, ie: ``en_US``.
.. code:: python
from faker import Faker
fake = Faker('it_IT')
for _ in range(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'
``faker.Faker`` also supports multiple locales. New in v3.0.0.
.. code:: python
from faker import Faker
fake = Faker(['it_IT', 'en_US', 'ja_JP'])
for _ in range(10):
print(fake.name())
# 鈴木 陽一
# Leslie Moreno
# Emma Williams
# 渡辺 裕美子
# Marcantonio Galuppi
# Martha Davis
# Kristen Turner
# 中津川 春香
# Ashley Castillo
# 山田 桃子
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).
Optimizations
-------------
The Faker constructor takes a performance-related argument called
``use_weighting``. It specifies whether to attempt to have the frequency
of values match real-world frequencies (e.g. the English name Gary would
be much more frequent than the name Lorimer). If ``use_weighting`` is ``False``,
then all items have an equal chance of being selected, and the selection
process is much faster. The default is ``True``.
Command line usage
------------------
When installed, you can invoke faker from the command-line:
.. code:: console
faker [-h] [--version] [-o output]
[-l {bg_BG,cs_CZ,...,zh_CN,zh_TW}]
[-r REPEAT] [-s SEP]
[-i {package.containing.custom_provider otherpkg.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 package 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:
.. code:: console
$ 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': '628-10-1085', 'birthdate': '2008-03-29'}
$ faker -r=3 -s=";" name
Willam Kertzmann;
Josiah Maggio;
Gayla Schmitt;
How to create a Provider
------------------------
.. code:: python
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) -> str:
return 'bar'
# then add new provider to faker instance
fake.add_provider(MyProvider)
# now you can use:
fake.foo()
# 'bar'
How to create a Dynamic Provider
--------------------------------
Dynamic providers can read elements from an external source.
.. code:: python
from faker import Faker
from faker.providers import DynamicProvider
medical_professions_provider = DynamicProvider(
provider_name="medical_profession",
elements=["dr.", "doctor", "nurse", "surgeon", "clerk"],
)
fake = Faker()
# then add new provider to faker instance
fake.add_provider(medical_professions_provider)
# now you can use:
fake.medical_profession()
# 'dr.'
How to customize the Lorem Provider
-----------------------------------
You can provide your own sets of words if you don't want to use the
default lorem ipsum one. The following example shows how to do it with a list of words picked from `cakeipsum <http://www.cupcakeipsum.com/>`__ :
.. code:: python
from faker import Faker
fake = Faker()
my_word_list = [
'danish','cheesecake','sugar',
'Lollipop','wafer','Gummies',
'sesame','Jelly','beans',
'pie','bar','Ice','oat' ]
fake.sentence()
# 'Expedita at beatae voluptatibus nulla omnis.'
fake.sentence(ext_word_list=my_word_list)
# 'Oat beans oat Lollipop bar cheesecake.'
How to use with Factory Boy
---------------------------
`Factory Boy` already ships with integration with ``Faker``. Simply use the
``factory.Faker`` method of ``factory_boy``:
.. code:: python
import factory
from myapp.models import Book
class BookFactory(factory.Factory):
class Meta:
model = Book
title = factory.Faker('sentence', nb_words=4)
author_name = factory.Faker('name')
Accessing the `random` instance
-------------------------------
The ``.random`` property on the generator returns the instance of
``random.Random`` used to generate the values:
.. code:: python
from faker import Faker
fake = Faker()
fake.random
fake.random.getstate()
By default all generators share the same instance of ``random.Random``, which
can be accessed with ``from faker.generator import random``. Using this may
be useful for plugins that want to affect all faker instances.
Unique values
-------------
Through use of the ``.unique`` property on the generator, you can guarantee
that any generated values are unique for this specific instance.
.. code:: python
from faker import Faker
fake = Faker()
names = [fake.unique.first_name() for i in range(500)]
assert len(set(names)) == len(names)
Calling ``fake.unique.clear()`` clears the already seen values.
Note, to avoid infinite loops, after a number of attempts to find a unique
value, Faker will throw a ``UniquenessException``. Beware of the `birthday
paradox <https://en.wikipedia.org/wiki/Birthday_problem>`_, collisions
are more likely than you'd think.
.. code:: python
from faker import Faker
fake = Faker()
for i in range(3):
# Raises a UniquenessException
fake.unique.boolean()
In addition, only hashable arguments and return values can be used
with ``.unique``.
Seeding the Generator
---------------------
When using Faker for unit testing, you will often want to generate the same
data set. For convenience, the generator also provides a ``seed()`` method,
which seeds the shared random number generator. A Seed produces the same result
when the same methods with the same version of faker are called.
.. code:: python
from faker import Faker
fake = Faker()
Faker.seed(4321)
print(fake.name())
# 'Margaret Boehm'
Each generator can also be switched to use its own instance of ``random.Random``,
separated from the shared one, by using the ``seed_instance()`` method, which acts
the same way. For example:
.. code:: python
from faker import Faker
fake = Faker()
fake.seed_instance(4321)
print(fake.name())
# 'Margaret Boehm'
Please note that as we keep updating datasets, results are not guaranteed to be
consistent across patch versions. If you hardcode results in your test, make sure
you pinned the version of ``Faker`` down to the patch number.
If you are using ``pytest``, you can seed the ``faker`` fixture by defining a ``faker_seed``
fixture. Please check out the `pytest fixture docs` to learn more.
Tests
-----
Run tests:
.. code:: bash
$ tox
Write documentation for the providers of the default locale:
.. code:: bash
$ python -m faker > docs.txt
Write documentation for the providers of a specific locale:
.. code:: bash
$ python -m faker --lang=de_DE > docs_de.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`_
.. _FZaninotto: https://github.com/fzaninotto
.. _PHP Faker: https://github.com/fzaninotto/Faker
.. _Perl Faker: http://search.cpan.org/~jasonk/Data-Faker-0.07/
.. _Ruby Faker: https://github.com/stympy/faker
.. _Distribute: https://pypi.org/project/distribute/
.. _Buildout: http://www.buildout.org/
.. _modern-package-template: https://pypi.org/project/modern-package-template/
.. _extended docs: https://faker.readthedocs.io/en/stable/
.. _bundled providers: https://faker.readthedocs.io/en/stable/providers.html
.. _community providers: https://faker.readthedocs.io/en/stable/communityproviders.html
.. _pytest fixture docs: https://faker.readthedocs.io/en/master/pytest-fixtures.html
.. _LICENSE: https://github.com/joke2k/faker/blob/master/LICENSE.txt
.. _CONTRIBUTING: https://github.com/joke2k/faker/blob/master/CONTRIBUTING.rst
.. _Factory Boy: https://github.com/FactoryBoy/factory_boy
.. |pypi| image:: https://img.shields.io/pypi/v/Faker.svg?style=flat-square&label=version
:target: https://pypi.org/project/Faker/
:alt: Latest version released on PyPI
.. |coverage| image:: https://img.shields.io/coveralls/joke2k/faker/master.svg?style=flat-square
:target: https://coveralls.io/r/joke2k/faker?branch=master
:alt: Test coverage
.. |build| image:: https://github.com/joke2k/faker/actions/workflows/ci.yml/badge.svg
:target: https://github.com/joke2k/faker/actions/workflows/ci.yml
:alt: Build status of the master branch
.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
:target: https://raw.githubusercontent.com/joke2k/faker/master/LICENSE.txt
:alt: Package license
Raw data
{
"_id": null,
"home_page": "https://github.com/joke2k/faker",
"name": "Faker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "faker fixtures data test mock generator",
"author": "joke2k",
"author_email": "joke2k@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/05/18/897bae41fedb7e366439f2e4756c21436ccc27bc3f6cac3ca143cf5d57e4/Faker-24.11.0.tar.gz",
"platform": "any",
"description": "*Faker* is a Python package that generates fake data for you. Whether\nyou need to bootstrap your database, create good-looking XML documents,\nfill-in your persistence to stress test it, or anonymize data taken from\na production service, Faker is for you.\n\nFaker is heavily inspired by `PHP Faker`_, `Perl Faker`_, and by `Ruby Faker`_.\n\n----\n\n::\n\n _|_|_|_| _|\n _| _|_|_| _| _| _|_| _| _|_|\n _|_|_| _| _| _|_| _|_|_|_| _|_|\n _| _| _| _| _| _| _|\n _| _|_|_| _| _| _|_|_| _|\n\n|pypi| |build| |coverage| |license|\n\n----\n\nCompatibility\n-------------\n\nStarting from version ``4.0.0``, ``Faker`` dropped support for Python 2 and from version ``5.0.0``\nonly supports Python 3.7 and above. If you still need Python 2 compatibility, please install version ``3.0.1`` in the\nmeantime, and please consider updating your codebase to support Python 3 so you can enjoy the\nlatest features ``Faker`` has to offer. Please see the `extended docs`_ for more details, especially\nif you are upgrading from version ``2.0.4`` and below as there might be breaking changes.\n\nThis package was also previously called ``fake-factory`` which was already deprecated by the end\nof 2016, and much has changed since then, so please ensure that your project and its dependencies\ndo not depend on the old package.\n\nBasic Usage\n-----------\n\nInstall with pip:\n\n.. code:: bash\n\n pip install Faker\n\nUse ``faker.Faker()`` to create and initialize a faker\ngenerator, which can generate data by accessing properties named after\nthe type of data you want.\n\n.. code:: python\n\n from faker import Faker\n fake = Faker()\n\n fake.name()\n # 'Lucy Cechtelar'\n\n fake.address()\n # '426 Jordy Lodge\n # Cartwrightshire, SC 88120-6700'\n\n fake.text()\n # 'Sint velit eveniet. Rerum atque repellat voluptatem quia rerum. Numquam excepturi\n # beatae sint laudantium consequatur. Magni occaecati itaque sint et sit tempore. Nesciunt\n # amet quidem. Iusto deleniti cum autem ad quia aperiam.\n # A consectetur quos aliquam. In iste aliquid et aut similique suscipit. Consequatur qui\n # quaerat iste minus hic expedita. Consequuntur error magni et laboriosam. Aut aspernatur\n # voluptatem sit aliquam. Dolores voluptatum est.\n # Aut molestias et maxime. Fugit autem facilis quos vero. Eius quibusdam possimus est.\n # Ea quaerat et quisquam. Deleniti sunt quam. Adipisci consequatur id in occaecati.\n # Et sint et. Ut ducimus quod nemo ab voluptatum.'\n\nEach call to method ``fake.name()`` yields a different (random) result.\nThis is because faker forwards ``faker.Generator.method_name()`` calls\nto ``faker.Generator.format(method_name)``.\n\n.. code:: python\n\n for _ in range(10):\n print(fake.name())\n\n # 'Adaline Reichel'\n # 'Dr. Santa Prosacco DVM'\n # 'Noemy Vandervort V'\n # 'Lexi O'Conner'\n # 'Gracie Weber'\n # 'Roscoe Johns'\n # 'Emmett Lebsack'\n # 'Keegan Thiel'\n # 'Wellington Koelpin II'\n # 'Ms. Karley Kiehn V'\n\nPytest fixtures\n---------------\n\n``Faker`` also has its own ``pytest`` plugin which provides a ``faker`` fixture you can use in your\ntests. Please check out the `pytest fixture docs` to learn more.\n\nProviders\n---------\n\nEach of the generator properties (like ``name``, ``address``, and\n``lorem``) are called \"fake\". A faker generator has many of them,\npackaged in \"providers\".\n\n.. code:: python\n\n from faker import Faker\n from faker.providers import internet\n\n fake = Faker()\n fake.add_provider(internet)\n\n print(fake.ipv4_private())\n\n\nCheck the `extended docs`_ for a list of `bundled providers`_ and a list of\n`community providers`_.\n\nLocalization\n------------\n\n``faker.Faker`` can take a locale as an argument, to return localized\ndata. If no localized provider is found, the factory falls back to the\ndefault LCID string for US english, ie: ``en_US``.\n\n.. code:: python\n\n from faker import Faker\n fake = Faker('it_IT')\n for _ in range(10):\n print(fake.name())\n\n # 'Elda Palumbo'\n # 'Pacifico Giordano'\n # 'Sig. Avide Guerra'\n # 'Yago Amato'\n # 'Eustachio Messina'\n # 'Dott. Violante Lombardo'\n # 'Sig. Alighieri Monti'\n # 'Costanzo Costa'\n # 'Nazzareno Barbieri'\n # 'Max Coppola'\n\n``faker.Faker`` also supports multiple locales. New in v3.0.0.\n\n.. code:: python\n\n from faker import Faker\n fake = Faker(['it_IT', 'en_US', 'ja_JP'])\n for _ in range(10):\n print(fake.name())\n\n # \u9234\u6728 \u967d\u4e00\n # Leslie Moreno\n # Emma Williams\n # \u6e21\u8fba \u88d5\u7f8e\u5b50\n # Marcantonio Galuppi\n # Martha Davis\n # Kristen Turner\n # \u4e2d\u6d25\u5ddd \u6625\u9999\n # Ashley Castillo\n # \u5c71\u7530 \u6843\u5b50\n\nYou can check available Faker locales in the source code, under the\nproviders package. The localization of Faker is an ongoing process, for\nwhich we need your help. Please don't hesitate to create a localized\nprovider for your own locale and submit a Pull Request (PR).\n\nOptimizations\n-------------\nThe Faker constructor takes a performance-related argument called\n``use_weighting``. It specifies whether to attempt to have the frequency\nof values match real-world frequencies (e.g. the English name Gary would\nbe much more frequent than the name Lorimer). If ``use_weighting`` is ``False``,\nthen all items have an equal chance of being selected, and the selection\nprocess is much faster. The default is ``True``.\n\nCommand line usage\n------------------\n\nWhen installed, you can invoke faker from the command-line:\n\n.. code:: console\n\n faker [-h] [--version] [-o output]\n [-l {bg_BG,cs_CZ,...,zh_CN,zh_TW}]\n [-r REPEAT] [-s SEP]\n [-i {package.containing.custom_provider otherpkg.containing.custom_provider}]\n [fake] [fake argument [fake argument ...]]\n\nWhere:\n\n- ``faker``: is the script when installed in your environment, in\n development you could use ``python -m faker`` instead\n\n- ``-h``, ``--help``: shows a help message\n\n- ``--version``: shows the program's version number\n\n- ``-o FILENAME``: redirects the output to the specified filename\n\n- ``-l {bg_BG,cs_CZ,...,zh_CN,zh_TW}``: allows use of a localized\n provider\n\n- ``-r REPEAT``: will generate a specified number of outputs\n\n- ``-s SEP``: will generate the specified separator after each\n generated output\n\n- ``-i {my.custom_provider other.custom_provider}`` list of additional custom\n providers to use. Note that is the import path of the package containing\n your Provider class, not the custom Provider class itself.\n\n- ``fake``: is the name of the fake to generate an output for, such as\n ``name``, ``address``, or ``text``\n\n- ``[fake argument ...]``: optional arguments to pass to the fake (e.g. the\n profile fake takes an optional list of comma separated field names as the\n first argument)\n\nExamples:\n\n.. code:: console\n\n $ faker address\n 968 Bahringer Garden Apt. 722\n Kristinaland, NJ 09890\n\n $ faker -l de_DE address\n Samira-Niemeier-Allee 56\n 94812 Biedenkopf\n\n $ faker profile ssn,birthdate\n {'ssn': '628-10-1085', 'birthdate': '2008-03-29'}\n\n $ faker -r=3 -s=\";\" name\n Willam Kertzmann;\n Josiah Maggio;\n Gayla Schmitt;\n\nHow to create a Provider\n------------------------\n\n.. code:: python\n\n from faker import Faker\n fake = Faker()\n\n # first, import a similar Provider or use the default one\n from faker.providers import BaseProvider\n\n # create new provider class\n class MyProvider(BaseProvider):\n def foo(self) -> str:\n return 'bar'\n\n # then add new provider to faker instance\n fake.add_provider(MyProvider)\n\n # now you can use:\n fake.foo()\n # 'bar'\n\n\nHow to create a Dynamic Provider\n--------------------------------\n\nDynamic providers can read elements from an external source.\n\n.. code:: python\n\n from faker import Faker\n from faker.providers import DynamicProvider\n\n medical_professions_provider = DynamicProvider(\n provider_name=\"medical_profession\",\n elements=[\"dr.\", \"doctor\", \"nurse\", \"surgeon\", \"clerk\"],\n )\n\n fake = Faker()\n\n # then add new provider to faker instance\n fake.add_provider(medical_professions_provider)\n\n # now you can use:\n fake.medical_profession()\n # 'dr.'\n\nHow to customize the Lorem Provider\n-----------------------------------\n\nYou can provide your own sets of words if you don't want to use the\ndefault lorem ipsum one. The following example shows how to do it with a list of words picked from `cakeipsum <http://www.cupcakeipsum.com/>`__ :\n\n.. code:: python\n\n from faker import Faker\n fake = Faker()\n\n my_word_list = [\n 'danish','cheesecake','sugar',\n 'Lollipop','wafer','Gummies',\n 'sesame','Jelly','beans',\n 'pie','bar','Ice','oat' ]\n\n fake.sentence()\n # 'Expedita at beatae voluptatibus nulla omnis.'\n\n fake.sentence(ext_word_list=my_word_list)\n # 'Oat beans oat Lollipop bar cheesecake.'\n\n\nHow to use with Factory Boy\n---------------------------\n\n`Factory Boy` already ships with integration with ``Faker``. Simply use the\n``factory.Faker`` method of ``factory_boy``:\n\n.. code:: python\n\n import factory\n from myapp.models import Book\n\n class BookFactory(factory.Factory):\n class Meta:\n model = Book\n\n title = factory.Faker('sentence', nb_words=4)\n author_name = factory.Faker('name')\n\nAccessing the `random` instance\n-------------------------------\n\nThe ``.random`` property on the generator returns the instance of\n``random.Random`` used to generate the values:\n\n.. code:: python\n\n from faker import Faker\n fake = Faker()\n fake.random\n fake.random.getstate()\n\nBy default all generators share the same instance of ``random.Random``, which\ncan be accessed with ``from faker.generator import random``. Using this may\nbe useful for plugins that want to affect all faker instances.\n\nUnique values\n-------------\n\nThrough use of the ``.unique`` property on the generator, you can guarantee\nthat any generated values are unique for this specific instance.\n\n.. code:: python\n\n from faker import Faker\n fake = Faker()\n names = [fake.unique.first_name() for i in range(500)]\n assert len(set(names)) == len(names)\n\nCalling ``fake.unique.clear()`` clears the already seen values.\nNote, to avoid infinite loops, after a number of attempts to find a unique\nvalue, Faker will throw a ``UniquenessException``. Beware of the `birthday\nparadox <https://en.wikipedia.org/wiki/Birthday_problem>`_, collisions\nare more likely than you'd think.\n\n\n.. code:: python\n\n from faker import Faker\n\n fake = Faker()\n for i in range(3):\n # Raises a UniquenessException\n fake.unique.boolean()\n\nIn addition, only hashable arguments and return values can be used\nwith ``.unique``.\n\nSeeding the Generator\n---------------------\n\nWhen using Faker for unit testing, you will often want to generate the same\ndata set. For convenience, the generator also provides a ``seed()`` method,\nwhich seeds the shared random number generator. A Seed produces the same result\nwhen the same methods with the same version of faker are called.\n\n.. code:: python\n\n from faker import Faker\n fake = Faker()\n Faker.seed(4321)\n\n print(fake.name())\n # 'Margaret Boehm'\n\nEach generator can also be switched to use its own instance of ``random.Random``,\nseparated from the shared one, by using the ``seed_instance()`` method, which acts\nthe same way. For example:\n\n.. code:: python\n\n from faker import Faker\n fake = Faker()\n fake.seed_instance(4321)\n\n print(fake.name())\n # 'Margaret Boehm'\n\nPlease note that as we keep updating datasets, results are not guaranteed to be\nconsistent across patch versions. If you hardcode results in your test, make sure\nyou pinned the version of ``Faker`` down to the patch number.\n\nIf you are using ``pytest``, you can seed the ``faker`` fixture by defining a ``faker_seed``\nfixture. Please check out the `pytest fixture docs` to learn more.\n\nTests\n-----\n\nRun tests:\n\n.. code:: bash\n\n $ tox\n\nWrite documentation for the providers of the default locale:\n\n.. code:: bash\n\n $ python -m faker > docs.txt\n\nWrite documentation for the providers of a specific locale:\n\n.. code:: bash\n\n $ python -m faker --lang=de_DE > docs_de.txt\n\n\nContribute\n----------\n\nPlease see `CONTRIBUTING`_.\n\nLicense\n-------\n\nFaker is released under the MIT License. See the bundled `LICENSE`_ file\nfor details.\n\nCredits\n-------\n\n- `FZaninotto`_ / `PHP Faker`_\n- `Distribute`_\n- `Buildout`_\n- `modern-package-template`_\n\n\n.. _FZaninotto: https://github.com/fzaninotto\n.. _PHP Faker: https://github.com/fzaninotto/Faker\n.. _Perl Faker: http://search.cpan.org/~jasonk/Data-Faker-0.07/\n.. _Ruby Faker: https://github.com/stympy/faker\n.. _Distribute: https://pypi.org/project/distribute/\n.. _Buildout: http://www.buildout.org/\n.. _modern-package-template: https://pypi.org/project/modern-package-template/\n.. _extended docs: https://faker.readthedocs.io/en/stable/\n.. _bundled providers: https://faker.readthedocs.io/en/stable/providers.html\n.. _community providers: https://faker.readthedocs.io/en/stable/communityproviders.html\n.. _pytest fixture docs: https://faker.readthedocs.io/en/master/pytest-fixtures.html\n.. _LICENSE: https://github.com/joke2k/faker/blob/master/LICENSE.txt\n.. _CONTRIBUTING: https://github.com/joke2k/faker/blob/master/CONTRIBUTING.rst\n.. _Factory Boy: https://github.com/FactoryBoy/factory_boy\n\n.. |pypi| image:: https://img.shields.io/pypi/v/Faker.svg?style=flat-square&label=version\n :target: https://pypi.org/project/Faker/\n :alt: Latest version released on PyPI\n\n.. |coverage| image:: https://img.shields.io/coveralls/joke2k/faker/master.svg?style=flat-square\n :target: https://coveralls.io/r/joke2k/faker?branch=master\n :alt: Test coverage\n\n.. |build| image:: https://github.com/joke2k/faker/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/joke2k/faker/actions/workflows/ci.yml\n :alt: Build status of the master branch\n\n.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square\n :target: https://raw.githubusercontent.com/joke2k/faker/master/LICENSE.txt\n :alt: Package license\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Faker is a Python package that generates fake data for you.",
"version": "24.11.0",
"project_urls": {
"Bug Tracker": "https://github.com/joke2k/faker/issues",
"Changes": "https://github.com/joke2k/faker/blob/master/CHANGELOG.md",
"Documentation": "http://faker.rtfd.org/",
"Homepage": "https://github.com/joke2k/faker",
"Source Code": "https://github.com/joke2k/faker"
},
"split_keywords": [
"faker",
"fixtures",
"data",
"test",
"mock",
"generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1722a5424c499c0cbd0d793f7f1499a904f83efb5762950ff6bafe4bca314a38",
"md5": "bf56f634e60b8805e38e44f7551a2a83",
"sha256": "adb98e771073a06bdc5d2d6710d8af07ac5da64c8dc2ae3b17bb32319e66fd82"
},
"downloads": -1,
"filename": "Faker-24.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf56f634e60b8805e38e44f7551a2a83",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1763323,
"upload_time": "2024-04-17T16:22:36",
"upload_time_iso_8601": "2024-04-17T16:22:36.512168Z",
"url": "https://files.pythonhosted.org/packages/17/22/a5424c499c0cbd0d793f7f1499a904f83efb5762950ff6bafe4bca314a38/Faker-24.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0518897bae41fedb7e366439f2e4756c21436ccc27bc3f6cac3ca143cf5d57e4",
"md5": "5ce3976a2c85044abbd1c8fc3109b955",
"sha256": "34b947581c2bced340c39b35f89dbfac4f356932cfff8fe893bde854903f0e6e"
},
"downloads": -1,
"filename": "Faker-24.11.0.tar.gz",
"has_sig": false,
"md5_digest": "5ce3976a2c85044abbd1c8fc3109b955",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1726502,
"upload_time": "2024-04-17T16:22:41",
"upload_time_iso_8601": "2024-04-17T16:22:41.837887Z",
"url": "https://files.pythonhosted.org/packages/05/18/897bae41fedb7e366439f2e4756c21436ccc27bc3f6cac3ca143cf5d57e4/Faker-24.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 16:22:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joke2k",
"github_project": "faker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "faker"
}
JSON
