Skip to main content

Small wrapper around faker, to make values optional!

Project description

optional-faker

Support Ukraine

Build Status codecov Code style: black Python support versions badge (from pypi)

Small wrapper around faker, to make values optional!

Example

>>> from faker import Faker
>>> 
>>> fake = Faker()
>>> Faker.seed(444)
>>> 
>>> # `fake.optional` can take any value, and return it, or None.
>>> fake.optional(fake.pystr())
'qazSMGwqdElzLTggMaPM'
>>> fake.optional(fake.pystr())
None
>>> # or it can take callable, and *args with **kwargs
>>> # that will be passed to this callable.
>>> fake.optional(fake.pystr, 1, max_chars=10)
'hmIEP'
>>> fake.optional(fake.pystr, 1, max_chars=10)
None
>>> # there is no explicit check is callable a faker part,
>>> # so you can pass anything.
>>> fake.optional(lambda: "my callable!")
'my callable!'
>>> fake.optional(lambda: "my callable!")
None

Installing

pip install optional-faker

And then you need to import optional_faker anywhere but before creating Faker instance.

Installing for local developing

git clone https://github.com/PerchunPak/optional-faker.git
cd optional-faker

Installing poetry

Next we need install poetry with recommended way.

If you use Linux, use command:

curl -sSL https://install.python-poetry.org | python -

If you use Windows, open PowerShell with admin privileges and use:

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -

Installing dependencies

poetry install

If something is not clear

You can always write me!

Updating

pip install -U optional-faker

For local development

For updating, just re-download repository, if you used git for downloading, just run git pull.

Thanks

This project was inspired by faker-optional.

This project was generated with python-template. Current template version: 4a2261d1a645d05e269c2f4b02c0b68203ad72fa. See what updated.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optional_faker-1.0.0.post1.tar.gz (15.2 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page