cyclonedx.serialization

Set of helper classes for use with serializable when conducting (de-)serialization.

Package Contents

Classes

BomRef	An identifier that can be used to reference objects elsewhere in the BOM.
BomRefHelper	Helper class that provides a standard way to create an ABC using
PackageUrl	Helper class that provides a standard way to create an ABC using
UrnUuidHelper	Helper class that provides a standard way to create an ABC using

class cyclonedx.serialization.BomRef(value: str | None = None)

An identifier that can be used to reference objects elsewhere in the BOM.

This copies a similar pattern used in the CycloneDX Python Library.

Note

See https://github.com/CycloneDX/cyclonedx-php-library/blob/master/docs/dev/decisions/BomDependencyDataModel.md

property value: str

__eq__(other: object) → bool

Return self==value.

__lt__(other: Any) → bool

Return self<value.

__hash__() → int

Return hash(self).

__repr__() → str

Return repr(self).

__str__() → str

Return str(self).

class cyclonedx.serialization.BomRefHelper(*args: Any, **kwargs: Any)

Bases: serializable.helpers.BaseHelper

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

classmethod serialize(o: object) → str

classmethod deserialize(o: object) → cyclonedx.model.bom_ref.BomRef

class cyclonedx.serialization.PackageUrl(*args: Any, **kwargs: Any)

Bases: serializable.helpers.BaseHelper

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

classmethod serialize(o: object) → str

classmethod deserialize(o: object) → packageurl.PackageURL

class cyclonedx.serialization.UrnUuidHelper(*args: Any, **kwargs: Any)

Bases: serializable.helpers.BaseHelper

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

classmethod serialize(o: object) → str

classmethod deserialize(o: object) → uuid.UUID