API Reference

Workflow Exceptions

These custom exceptions are associated with generating the workflows provided by the PTB. They are located in the exasol.toolbox.util.workflows.exceptions module.

exception InvalidWorkflowPatcherEntryError(file_path: Path, **kwargs)

Raised when the WorkflowPatcher is used but one of the specified keys it listed does not exist in the relevant workflow template file.

exception InvalidWorkflowPatcherYamlError(file_path: Path, **kwargs)

Raised when the WorkflowPatcher failed the validation constraints of WorkflowPatcherConfig.

exception TemplateRenderingError(file_path: Path, **kwargs)

Raised when Jinja fails to modify the template. It may be that a Jinja variable was not defined, a brace was not closed, etc.

exception YamlError(file_path: Path, **kwargs)

Base exception for YAML errors.

exception YamlJobValueError(**kwargs)

Raised when a job cannot be found in a YAML file.

exception YamlKeyError(**kwargs)

Base exception for when a specified value cannot be found in a YAML.

exception YamlOutputError(file_path: Path, **kwargs)

Raised when the final workflow cannot be exported as a YAML file. This would likely indicate that one of the preceding transformation steps led to a format that is no longer able to be exported as a YAML file.

exception YamlParsingError(file_path: Path, **kwargs)

Raised when the rendered template is not a valid YAML file, as it cannot be parsed by ruamel-yaml.

exception YamlStepIdValueError(**kwargs)

Raised when a step_id associated with a specific job cannot be found in a YAML file.