cyclonedx.output.xml

Attributes

BY_SCHEMA_VERSION

Classes

Xml	Base class for schema version views.
XmlV1Dot0	Base class for schema version views.
XmlV1Dot1	Base class for schema version views.
XmlV1Dot2	Base class for schema version views.
XmlV1Dot3	Base class for schema version views.
XmlV1Dot4	Base class for schema version views.
XmlV1Dot5	Base class for schema version views.
XmlV1Dot6	Base class for schema version views.
XmlV1Dot7	Base class for schema version views.

Module Contents

class cyclonedx.output.xml.Xml(bom: cyclonedx.model.bom.Bom)

Bases: cyclonedx.schema.schema.BaseSchemaVersion, cyclonedx.output.BaseOutput

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

class cyclonedx.output.xml.XmlV1Dot0(bom: cyclonedx.model.bom.Bom)

Bases: Xml, cyclonedx.schema.schema.SchemaVersion1Dot0

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

class cyclonedx.output.xml.XmlV1Dot1(bom: cyclonedx.model.bom.Bom)

Bases: Xml, cyclonedx.schema.schema.SchemaVersion1Dot1

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

class cyclonedx.output.xml.XmlV1Dot2(bom: cyclonedx.model.bom.Bom)

Bases: Xml, cyclonedx.schema.schema.SchemaVersion1Dot2

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

class cyclonedx.output.xml.XmlV1Dot3(bom: cyclonedx.model.bom.Bom)

Bases: Xml, cyclonedx.schema.schema.SchemaVersion1Dot3

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

class cyclonedx.output.xml.XmlV1Dot4(bom: cyclonedx.model.bom.Bom)

Bases: Xml, cyclonedx.schema.schema.SchemaVersion1Dot4

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

class cyclonedx.output.xml.XmlV1Dot5(bom: cyclonedx.model.bom.Bom)

Bases: Xml, cyclonedx.schema.schema.SchemaVersion1Dot5

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

class cyclonedx.output.xml.XmlV1Dot6(bom: cyclonedx.model.bom.Bom)

Bases: Xml, cyclonedx.schema.schema.SchemaVersion1Dot6

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

class cyclonedx.output.xml.XmlV1Dot7(bom: cyclonedx.model.bom.Bom)

Bases: Xml, cyclonedx.schema.schema.SchemaVersion1Dot7

Base class for schema version views.

property schema_version: cyclonedx.schema.SchemaVersion

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

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → str

get_target_namespace() → str

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

property generated: bool

get_bom() → cyclonedx.model.bom.Bom

set_bom(bom: cyclonedx.model.bom.Bom) → None

output_to_file(filename: str, allow_overwrite: bool = False, *, indent: int | str | None = None, **kwargs: Any) → None

cyclonedx.output.xml.BY_SCHEMA_VERSION: dict[cyclonedx.schema.SchemaVersion, type[Xml]]