Options

ranjg uses options during generation and you can specify some options. For example:

>>> schema = {
>>>     'type': 'object',
>>>     'required': ['sent_flg'],  # generated must contains 'sent_flg'
>>>     'properties': {
>>>         'sent_flg': {'type': 'boolean'},  # generated[sent_flg] is boolean value
>>>     }
>>> }
>>> options = Options(default_prob_of_true_given_bool=0.2)  # 0.2 = 20%
>>> generated = ranjg.gen(schema, options=options)
>>> assert isinstance(generated['sent_flg'], bool)  # -> it's True with probability 20% or False with probability 80%

Options also apply to the generation of descendant elements, as described above, and allow you to specify generation rules that are not specified in the schema.

The following pages show keywords of Options.

References:

• Options for Enum Generation
  • Copy Candidates
• Options for String Generation
  • Length Range
  • Default minLength and maxLength
• Options for Boolean Generation
  • Probability
• Options for Array Generation
  • Default Schema of Items
• Options for Object Generation
  • Schema of Properties
  • Probability of Non-Required Properties

Options file

You can also use ranjg.gen with a file containing the options. For example:

>>> schema = { 'type': 'boolean' }
>>> ranjg.gen(schema, options_file='./options.json')  # -> returns True or False

with options file ./options.json:

{
  "default_prob_of_true_given_bool": 0.2
}

In addition, you can also specify options in command line execution. For example:

$ python -m ranjg ./schema.json --options ./options.json