aito.schema.AitoSchema

class aito.schema.AitoSchema

Bases: aito.utils._json_format.JsonFormat, abc.ABC

The base class for Aito schema component

Methods

from_deserialized_object(obj)	create a class object from a JSON deserialized object
from_json_string(json_string, **kwargs)	create an class object from a JSON string
json_schema()	the JSON schema of the class
json_schema_validate(obj)	Validate an object with the class json_schema Returns the object if validation success, else raise JsonValidationError
json_schema_validate_with_schema(obj, schema)	Validate an object with the given schema
to_json_serializable()	convert the object to an object that can be serialized to a JSON formatted string
to_json_string(**kwargs)	convert the object to a JSON string

Attributes

column_link_pattern
column_name_pattern
comparison_properties	properties of the schema object that will be used for comparison operation
table_name_pattern
type	the type of the schema component
uuid_pattern

abstract property comparison_properties

properties of the schema object that will be used for comparison operation

Return type

Iterable[str]

abstract classmethod from_deserialized_object(obj: Any)

create a class object from a JSON deserialized object

classmethod from_json_string(json_string: str, **kwargs)

create an class object from a JSON string

Parameters

• json_string (str) – the JSON string

• kwargs – the keyword arguments for json.loads method

abstract classmethod json_schema()

the JSON schema of the class

Return type

Dict

classmethod json_schema_validate(obj: Any)

Validate an object with the class json_schema Returns the object if validation success, else raise JsonValidationError

Parameters

obj (Any) – the object to be validated

Returns

the object if validation succeed

Return type

Any

json_schema_validate_with_schema(obj: Any, schema: Dict)

Validate an object with the given schema

Parameters

• obj (Any) – the object to be validated

• schema (Dict) – the schema to be validate against

Returns

the object if validation succeed

Return type

Any

abstract to_json_serializable()

convert the object to an object that can be serialized to a JSON formatted string

to_json_string(**kwargs)

convert the object to a JSON string

Parameters

kwargs – the keyword arguments for json.dumps method

Return type

str

abstract property type

the type of the schema component

Return type

str