cyclonedx.validation.xml

Classes

XmlValidator

Validator for CycloneDX documents in XML format.

Module Contents

class cyclonedx.validation.xml.XmlValidator(schema_version: cyclonedx.schema.SchemaVersion)

Bases: _BaseXmlValidator, cyclonedx.validation.BaseSchemabasedValidator, cyclonedx.validation.SchemabasedValidator

Validator for CycloneDX documents in XML format.

property output_format: Literal[cyclonedx.schema.OutputFormat.XML]

Get the format.

property schema_version: cyclonedx.schema.SchemaVersion

Get the schema version.

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