pg.hyper.OneOf

Accessible via pg.hyper.OneOf, pg.hyper.ChoiceValue.

class OneOf(candidates, hints=None, where=None, *, name=None, num_choices=1, choices_distinct=True, choices_sorted=False)

Bases: pg.hyper.Choices

N Choose 1.

Example:

# A single categorical choice:
v = pg.oneof([1, 2, 3])

# A hierarchical categorical choice:
v2 = pg.oneof([
    'foo',
    'bar',
    pg.oneof([1, 2, 3])
])

See also

• pg.oneof

• pg.hyper.Choices

• pg.hyper.ManyOf

• pg.hyper.Float

• pg.hyper.CustomHyper

Methods:

custom_apply(path, value_spec, allow_partial)	Validate candidates during value_spec binding time.
encode(value)	Encode a value into a DNA.

custom_apply(path, value_spec, allow_partial, child_transform=None)

Validate candidates during value_spec binding time.

Return type:

Tuple[bool, pg.hyper.OneOf]

encode(value)

Encode a value into a DNA.

Return type:

pg.DNA