Public API

This page is the primary resource for explaining the public capabilities of Est Shizard.

To see the plugin API, follow this link.

get_config_from_yaml

get_config_from_yaml(
    yaml_path: str | Path,
) -> TestWizardConfig

Generate a TestWizardConfig object from yaml file

Parameters:

Name	Type	Description	Default
yaml_path	str | Path	path to YAML	required

Returns:

Name	Type	Description
TestWizardConfig	TestWizardConfig	config object

get_model_from_yaml_string

get_model_from_yaml_string(
    yaml_str: str, model_type: type[T]
) -> T

Generate a model of type T from yaml string

Parameters:

Name	Type	Description	Default
yaml_str	str	string that repsents YAML document	required
model_type	Type[T]	model type	required

Raises:

Type	Description
ValidationError	Raised when ValidationError occured

Returns:

Name	Type	Description
T	T	model object