BPt.Option#

class BPt.Option(value, name='repr', key=None)[source]#

This is a special BPt input class designed to be used with Compare. It is used as a formal way to represent comparison options.

Parameters
valueoption value

The explicit value in which the parameter it is passed to will take.

namestr or ‘repr’, optional

The name of this value, where this name is used to index the CompareDict of results.

If left as default value of ‘repr’ then a str representation of the value will be automatically created.

default = 'repr'
keystr or None, optional

This parameter should typically not be set directly. It is instead inferred by the context in which the option is eventually used.

default = None