cyclonedx.validation
Submodules
Classes
Validation failed with this specific error. |
|
Schema-based Validator protocol |
|
Base Schema-based Validator |
Functions
Get the default Schema-based Validator for a certain |
Package Contents
- class cyclonedx.validation.ValidationError(data: Any)
Validation failed with this specific error.
Use
data
to access the content.- data: Any
- class cyclonedx.validation.SchemabasedValidator
Bases:
Protocol
Schema-based Validator protocol
- validate_str(data: str) ValidationError | None
Validate a string
- Parameters:
data – the data string to validate
- Returns:
validation error
- Retval None:
if
data
is valid- Retval ValidationError:
if
data
is invalid
- class cyclonedx.validation.BaseSchemabasedValidator(schema_version: cyclonedx.schema.SchemaVersion)
Bases:
abc.ABC
,SchemabasedValidator
Base Schema-based Validator
- property schema_version: cyclonedx.schema.SchemaVersion
Get the schema version.
- property output_format: cyclonedx.schema.OutputFormat
- Abstractmethod:
Get the format.
- validate_str(data: str) ValidationError | None
Validate a string
- Parameters:
data – the data string to validate
- Returns:
validation error
- Retval None:
if
data
is valid- Retval ValidationError:
if
data
is invalid
- cyclonedx.validation.make_schemabased_validator(output_format: Literal[cyclonedx.schema.OutputFormat.JSON], schema_version: cyclonedx.schema.SchemaVersion) json.JsonValidator
- cyclonedx.validation.make_schemabased_validator(output_format: Literal[cyclonedx.schema.OutputFormat.XML], schema_version: cyclonedx.schema.SchemaVersion) xml.XmlValidator
- cyclonedx.validation.make_schemabased_validator(output_format: cyclonedx.schema.OutputFormat, schema_version: cyclonedx.schema.SchemaVersion) json.JsonValidator | xml.XmlValidator
Get the default Schema-based Validator for a certain
OutputFormat
.Raises error when no instance could be made.