cyclonedx.output.json

Attributes

BY_SCHEMA_VERSION

Classes

`Json`	Helper class that provides a standard way to create an ABC using
`JsonV1Dot0`	Helper class that provides a standard way to create an ABC using
`JsonV1Dot1`	Helper class that provides a standard way to create an ABC using
`JsonV1Dot2`	Helper class that provides a standard way to create an ABC using
`JsonV1Dot3`	Helper class that provides a standard way to create an ABC using
`JsonV1Dot4`	Helper class that provides a standard way to create an ABC using
`JsonV1Dot5`	Helper class that provides a standard way to create an ABC using
`JsonV1Dot6`	Helper class that provides a standard way to create an ABC using
`JsonV1Dot7`	Helper class that provides a standard way to create an ABC using

Module Contents

class cyclonedx.output.json.Json(bom: cyclonedx.model.bom.Bom)

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

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

class cyclonedx.output.json.JsonV1Dot0(bom: cyclonedx.model.bom.Bom)

Bases: Json, cyclonedx.schema.schema.SchemaVersion1Dot0

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

class cyclonedx.output.json.JsonV1Dot1(bom: cyclonedx.model.bom.Bom)

Bases: Json, cyclonedx.schema.schema.SchemaVersion1Dot1

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

class cyclonedx.output.json.JsonV1Dot2(bom: cyclonedx.model.bom.Bom)

Bases: Json, cyclonedx.schema.schema.SchemaVersion1Dot2

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

class cyclonedx.output.json.JsonV1Dot3(bom: cyclonedx.model.bom.Bom)

Bases: Json, cyclonedx.schema.schema.SchemaVersion1Dot3

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

class cyclonedx.output.json.JsonV1Dot4(bom: cyclonedx.model.bom.Bom)

Bases: Json, cyclonedx.schema.schema.SchemaVersion1Dot4

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

class cyclonedx.output.json.JsonV1Dot5(bom: cyclonedx.model.bom.Bom)

Bases: Json, cyclonedx.schema.schema.SchemaVersion1Dot5

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

class cyclonedx.output.json.JsonV1Dot6(bom: cyclonedx.model.bom.Bom)

Bases: Json, cyclonedx.schema.schema.SchemaVersion1Dot6

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

class cyclonedx.output.json.JsonV1Dot7(bom: cyclonedx.model.bom.Bom)

Bases: Json, cyclonedx.schema.schema.SchemaVersion1Dot7

Helper class that provides a standard way to create an ABC using inheritance.

property schema_version: cyclonedx.schema.SchemaVersion

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

generate(force_regeneration: bool = False) → None

output_as_string(*, indent: int | str | None = None, **kwargs: Any) → 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

property schema_version_enum: cyclonedx.schema.SchemaVersion

Abstractmethod:

get_schema_version() → str

cyclonedx.output.json.BY_SCHEMA_VERSION: dict[cyclonedx.schema.SchemaVersion, type[Json]]