fiftyone.operators.executor.ValidationContext

class documentation

class ValidationContext(object): (source)

Constructor: ValidationContext(ctx, inputs_property, operator)

View In Hierarchy

Represents the validation context of an operator.

Parameters
ctxthe ExecutionContext
inputs_propertythe fiftyone.operators.types.Property of the operator inputs
operatorthe fiftyone.operators.operator.Operator
Method __init__ Undocumented
Method add_error Adds a validation error.
Method exists_or_non_required Undocumented
Method to_json Returns a JSON dict representation of the context.
Method validate_enum Validates an enum value.
Method validate_list Validates a list value.
Method validate_object Validates an object value.
Method validate_primitive Validates a primitive value.
Method validate_property Validates a property value.
Instance Variable ctx Undocumented
Instance Variable disable_schema_validation Undocumented
Instance Variable errors Undocumented
Instance Variable inputs_property Undocumented
Instance Variable invalid Undocumented
Instance Variable params Undocumented
Method _validate Undocumented
def __init__(self, ctx, inputs_property, operator): (source)

Undocumented

def add_error(self, error): (source)

Adds a validation error.

Parameters
errora ValidationError
def exists_or_non_required(self, property, value): (source)

Undocumented

def to_json(self): (source)

Returns a JSON dict representation of the context.

Returns
a JSON dict
def validate_enum(self, path, property, value): (source)

Validates an enum value.

Parameters
paththe path to the property
propertythe fiftyone.operators.types.Property
valuethe value to validate
Returns
a ValidationError, if the value is invalid
def validate_list(self, path, property, value): (source)

Validates a list value.

Parameters
paththe path to the property
propertythe fiftyone.operators.types.Property
valuethe value to validate
Returns
a ValidationError, if the value is invalid
def validate_object(self, path, property, value): (source)

Validates an object value.

Parameters
paththe path to the property
propertythe fiftyone.operators.types.Property
valuethe value to validate
Returns
a ValidationError, if the value is invalid
def validate_primitive(self, path, property, value): (source)

Validates a primitive value.

Parameters
paththe path to the property
propertythe fiftyone.operators.types.Property
valuethe value to validate
Returns
a ValidationError, if the value is invalid
def validate_property(self, path, property, value): (source)

Validates a property value.

Parameters
paththe path to the property
propertythe fiftyone.operators.types.Property
valuethe value to validate
Returns
a ValidationError, if the value is invalid
ctx = (source)

Undocumented

disable_schema_validation = (source)

Undocumented

errors: list = (source)

Undocumented

inputs_property = (source)

Undocumented

invalid: bool = (source)

Undocumented

params = (source)

Undocumented

def _validate(self): (source)

Undocumented