cyclonedx.model.lifecycle
=========================

.. py:module:: cyclonedx.model.lifecycle

.. autoapi-nested-parse::

       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
----------

.. autoapisummary::

   cyclonedx.model.lifecycle.Lifecycle


Classes
-------

.. autoapisummary::

   cyclonedx.model.lifecycle.LifecyclePhase
   cyclonedx.model.lifecycle.PredefinedLifecycle
   cyclonedx.model.lifecycle.NamedLifecycle
   cyclonedx.model.lifecycle.LifecycleRepository


Module Contents
---------------

.. py:class:: LifecyclePhase

   Bases: :py:obj:`str`, :py:obj:`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


   .. py:attribute:: DESIGN
      :value: 'design'



   .. py:attribute:: PRE_BUILD
      :value: 'pre-build'



   .. py:attribute:: BUILD
      :value: 'build'



   .. py:attribute:: POST_BUILD
      :value: 'post-build'



   .. py:attribute:: OPERATIONS
      :value: 'operations'



   .. py:attribute:: DISCOVERY
      :value: 'discovery'



   .. py:attribute:: DECOMMISSION
      :value: 'decommission'



.. py:class:: 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


   .. py:property:: phase
      :type: LifecyclePhase



.. py:class:: NamedLifecycle(name: str, *, description: Optional[str] = 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


   .. py:property:: name
      :type: str


      Name of the lifecycle phase.

      Returns:
           `str`



   .. py:property:: description
      :type: Optional[str]


      Description of the lifecycle phase.

      Returns:
           `str`



.. py:data:: Lifecycle

   TypeAlias for a union of supported lifecycle models.

   - :class:`PredefinedLifecycle`
   - :class:`NamedLifecycle`


.. py:class:: LifecycleRepository

   Bases: :py:obj:`sortedcontainers.SortedSet`\ [\ :py:obj:`Lifecycle`\ ]


   Collection of :class:`Lifecycle`.

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