datacraft-faker 0.2.0

Custom faker type extensions for datacraft package

datacraft-faker

Custom plugin for datacraft to wrap the faker python module

Usage

The datacraft-faker module adds a faker Field Spec type to datacraft. This type allows a user to reference the various data generation methods from faker in their Data Specs. For example:

{
  "id": {"type":  "uuid"},
  "time:date.iso":  {},
  "name": {"type": "faker", "data": "name"},
  "dob:faker": "date_of_birth"
}

The above example uses two built in datacraft types uuid and date.iso and two faker ones. The record generated for this spec will look something like:

 {
  "id": "ad8f5737-59f9-48e3-bf4f-ed4deb357d0a",
  "time": "2024-07-18T19:57:17",
  "name": "Kimberly Wright",
  "dob": "1979-06-27"
}

The type for the field will always be faker. The data element of the spec is where you define the method name that generates the data of interest. Here are a bunch of examples:

Faker method	Spec Example
fake.name()	{"name": {"type": "faker", "data": "name"}}
fake.address()	{"address": {"type": "faker", "data": "address"}}
fake.email()	{"email": {"type": "faker", "data": "email"}}
fake.phone_number()	{"phone_number": {"type": "faker", "data": "phone_number"}}
fake.company()	{"company": {"type": "faker", "data": "company"}}
fake.date_of_birth()	{"date_of_birth": {"type": "faker", "data": "date_of_birth"}}
fake.text()	{"text": {"type": "faker", "data": "text"}}
fake.city()	{"city": {"type": "faker", "data": "city"}}
fake.state()	{"state": {"type": "faker", "data": "state"}}
fake.zipcode()	{"zipcode": {"type": "faker", "data": "zipcode"}}

Note that datacraft has a shorthand notation that works well for faker specs:

Faker method	Shorthand Spec
fake.name()	{"name:faker": "name"}
fake.address()	{"address:faker": "address"}
fake.email()	{"email:faker": "email"}
fake.phone_number()	{"phone_number:faker": "phone_number"}
fake.company()	{"company:faker": "company"}
fake.date_of_birth()	{"date_of_birth:faker": "date_of_birth"}
fake.text()	{"text:faker": "text"}
fake.city()	{"city:faker": "city"}
fake.state()	{"state:faker": "state"}
fake.zipcode()	{"zipcode:faker": "zipcode"}

Note that datacraft-faker extends this when the field name is the same as the provider:

Faker method	Shorthand Spec
fake.name()	{"name:faker": {} }
fake.address()	{"address:faker": {} }
fake.email()	{"email:faker": {} }
fake.phone_number()	{"phone_number:faker": {} }
fake.company()	{"company:faker": {} }
fake.date_of_birth()	{"date_of_birth:faker": {} }
fake.text()	{"text:faker": {} }
fake.city()	{"city:faker": {} }
fake.state()	{"state:faker": {} }
fake.zipcode()	{"zipcode:faker": {} }

Locales

Faker allows the ability to specify one or more locales to use for data generation. To configure this with a faker Field Spec, add the config option locale:

{
  "name": {
    "type": "faker",
    "data": "name",
    "config": {
      "locale": ["en_GB", "it_IT"]
    }
  },
  "email:faker?locale=en_GB,it_IT": {}
}

The record generated for this spec will look something like:

 {
  "name": "Anita Bosio",
  "email": "[e-mail]"
}

Providers

To make use of other faker module providers, you will need to add the include config option:

{
  "make_model": {
    "type": "faker",
    "data": "vehicle_make_model",
    "config": {
      "include": "faker_vehicle"
    }
  },
  "cat": {
    "type": "faker",
    "data": "vehicle_category",
    "config": {
      "include": "faker_vehicle"
    }
  },
  "year:faker?include=faker_vehicle": "vehicle_year"
}

The record generated for this spec will look something like:

{
  "make_model": "Mercury Grand Marquis",
  "cat": "Hatchback",
  "year": "2014"
}

Inspecting available faker types

Here is a shell command that can be used to list the available faker types

# assuming pip install faker already done
faker | grep '()' | sed 's/fake.\(.*\)()/\1/g' | awk '{print $1}'