Skip to content

model

Model implementation for the Validator.

ValidatorModel

Bases: BaseModel

A description of a validator for a test.

Source code in mlte/validation/model.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class ValidatorModel(BaseModel):
    """A description of a validator for a test."""

    bool_exp: Optional[str]
    """A text-encoded, dilled-serialized version of the function to execute when checking the bool condition."""

    bool_exp_str: Optional[str]
    """A string representation of the code for the bool expression to check for."""

    thresholds: list[str]
    """A list of thresholds used in the bool expression, serialized to string, for auditing purposes."""

    success: Optional[str]
    """A string to be used when recording that the validation was succesful."""

    failure: Optional[str]
    """A string to be used when recording that the validation was not succesful."""

    default_success: str
    """A default string to be used when recording that the validation was succesful, if success is not defined, and in detailed messages.."""

    default_failure: str
    """A default string to be used when recording that the validation was not succesful, if failure is not defined, and in detailed messages."""

    info: Optional[str]
    """A string to be used when recording that the validation was not checked against a expression, just recorded information."""

    input_types: list[str] = []
    """A list of strings representing the types of inputs to be received when validating."""

    creator_entity: Optional[str] = None
    """The full name of the class or module used to create this validator, if any."""

    creator_function: Optional[str] = None
    """The name of the function used to create this validator, if any."""

    creator_args: list[Any] = []
    """The arguments of the function used to create this validator, if any."""

bool_exp instance-attribute

A text-encoded, dilled-serialized version of the function to execute when checking the bool condition.

bool_exp_str instance-attribute

A string representation of the code for the bool expression to check for.

creator_args = [] class-attribute instance-attribute

The arguments of the function used to create this validator, if any.

creator_entity = None class-attribute instance-attribute

The full name of the class or module used to create this validator, if any.

creator_function = None class-attribute instance-attribute

The name of the function used to create this validator, if any.

default_failure instance-attribute

A default string to be used when recording that the validation was not succesful, if failure is not defined, and in detailed messages.

default_success instance-attribute

A default string to be used when recording that the validation was succesful, if success is not defined, and in detailed messages..

failure instance-attribute

A string to be used when recording that the validation was not succesful.

info instance-attribute

A string to be used when recording that the validation was not checked against a expression, just recorded information.

input_types = [] class-attribute instance-attribute

A list of strings representing the types of inputs to be received when validating.

success instance-attribute

A string to be used when recording that the validation was succesful.

thresholds instance-attribute

A list of thresholds used in the bool expression, serialized to string, for auditing purposes.