cyclonedx.model.lifecycle

This set of classes represents the lifecycles types in the CycloneDX standard.

Note

Introduced in CycloneDX v1.5

Note

See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.7/xml/#metadata_lifecycles

Attributes

Lifecycle

TypeAlias for a union of supported lifecycle models.

Classes

LifecyclePhase

Enum object that defines the permissible 'phase' for a Lifecycle according to the CycloneDX schema.

PredefinedLifecycle

Object that defines pre-defined phases in the product lifecycle.

NamedLifecycle

Object that defines custom state in the product lifecycle.

LifecycleRepository

Collection of Lifecycle.

Module Contents

class cyclonedx.model.lifecycle.LifecyclePhase

Bases: str, enum.Enum

Enum object that defines the permissible ‘phase’ for a Lifecycle according to the CycloneDX schema.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_classification

DESIGN = 'design'
PRE_BUILD = 'pre-build'
BUILD = 'build'
POST_BUILD = 'post-build'
OPERATIONS = 'operations'
DISCOVERY = 'discovery'
DECOMMISSION = 'decommission'
class cyclonedx.model.lifecycle.PredefinedLifecycle(phase: LifecyclePhase)

Object that defines pre-defined phases in the product lifecycle.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/json/#tab-pane_metadata_lifecycles_items_oneOf_i0

property phase: LifecyclePhase
class cyclonedx.model.lifecycle.NamedLifecycle(name: str, *, description: str | None = None)

Object that defines custom state in the product lifecycle.

Note

See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/json/#tab-pane_metadata_lifecycles_items_oneOf_i1

property name: str

Name of the lifecycle phase.

Returns:

str

property description: str | None

Description of the lifecycle phase.

Returns:

str

cyclonedx.model.lifecycle.Lifecycle

TypeAlias for a union of supported lifecycle models.

class cyclonedx.model.lifecycle.LifecycleRepository

Bases: sortedcontainers.SortedSet[Lifecycle]

Collection of Lifecycle.

This is a set, not a list. Order MUST NOT matter here.