cyclonedx.serialization

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

Classes

BomRefHelper	DEPRECATED in favour of BomRef.
PackageUrl
UrnUuidHelper
XmlBoolAttribute	Helper for serializing boolean values as XML attribute-compatible 'true'/'false' strings,
LicenseRepositoryHelper	DEPRECATED

Package Contents

class cyclonedx.serialization.BomRefHelper

Bases: py_serializable.helpers.BaseHelper

DEPRECATED in favour of BomRef.

Deprecated since version 8.6: Use BomRef instead.

classmethod serialize(o: Any) → str | None

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

class cyclonedx.serialization.PackageUrl

Bases: py_serializable.helpers.BaseHelper

classmethod serialize(o: Any) → str

classmethod deserialize(o: Any) → packageurl.PackageURL

class cyclonedx.serialization.UrnUuidHelper

Bases: py_serializable.helpers.BaseHelper

classmethod serialize(o: Any) → str

classmethod deserialize(o: Any) → uuid.UUID

class cyclonedx.serialization.XmlBoolAttribute

Bases: py_serializable.helpers.BaseHelper

Helper for serializing boolean values as XML attribute-compatible ‘true’/’false’ strings, while keeping native boolean values for JSON.

classmethod json_serialize(o: Any) → bool | None

classmethod json_deserialize(o: Any) → bool | None

classmethod xml_serialize(o: Any) → str | None

classmethod xml_deserialize(o: Any) → bool | None

classmethod serialize(o: Any) → Any

classmethod deserialize(o: Any) → Any

class cyclonedx.serialization.LicenseRepositoryHelper

Bases: cyclonedx.model.license._LicenseRepositorySerializationHelper

DEPRECATED

Deprecated since version 8.6: No public API planned for replacing this,

classmethod json_normalize(o: LicenseRepository, *, view: type[py_serializable.ViewType] | None, **__: Any) → Any

classmethod json_denormalize(o: list[dict[str, Any]], **__: Any) → LicenseRepository

classmethod xml_normalize(o: LicenseRepository, *, element_name: str, view: type[py_serializable.ViewType] | None, xmlns: str | None, **__: Any) → xml.etree.ElementTree.Element | None

classmethod xml_denormalize(o: xml.etree.ElementTree.Element, default_ns: str | None, **__: Any) → LicenseRepository