cyclonedx.serialization
=======================

.. py:module:: cyclonedx.serialization

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   cyclonedx.serialization.BomRefHelper
   cyclonedx.serialization.PackageUrl
   cyclonedx.serialization.UrnUuidHelper
   cyclonedx.serialization.LicenseRepositoryHelper


Package Contents
----------------

.. py:class:: BomRefHelper

   Bases: :py:obj:`py_serializable.helpers.BaseHelper`


   **DEPRECATED** in favour of :class:`BomRef`.

   .. deprecated:: 8.6
      Use :class:`BomRef` instead.


   .. py:method:: serialize(o: Any) -> Optional[str]
      :classmethod:



   .. py:method:: deserialize(o: Any) -> cyclonedx.model.bom_ref.BomRef
      :classmethod:



.. py:class:: PackageUrl

   Bases: :py:obj:`py_serializable.helpers.BaseHelper`


   .. py:method:: serialize(o: Any) -> str
      :classmethod:



   .. py:method:: deserialize(o: Any) -> packageurl.PackageURL
      :classmethod:



.. py:class:: UrnUuidHelper

   Bases: :py:obj:`py_serializable.helpers.BaseHelper`


   .. py:method:: serialize(o: Any) -> str
      :classmethod:



   .. py:method:: deserialize(o: Any) -> uuid.UUID
      :classmethod:



.. py:class:: LicenseRepositoryHelper

   Bases: :py:obj:`cyclonedx.model.license._LicenseRepositorySerializationHelper`


   **DEPRECATED**

   .. deprecated:: 8.6
      No public API planned for replacing this,


   .. py:method:: json_normalize(o: LicenseRepository, *, view: Optional[type[py_serializable.ViewType]], **__: Any) -> Any
      :classmethod:



   .. py:method:: json_denormalize(o: list[dict[str, Any]], **__: Any) -> LicenseRepository
      :classmethod:



   .. py:method:: xml_normalize(o: LicenseRepository, *, element_name: str, view: Optional[type[py_serializable.ViewType]], xmlns: Optional[str], **__: Any) -> Optional[xml.etree.ElementTree.Element]
      :classmethod:



   .. py:method:: xml_denormalize(o: xml.etree.ElementTree.Element, default_ns: Optional[str], **__: Any) -> LicenseRepository
      :classmethod: