:py:mod:`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



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

Classes
~~~~~~~

.. autoapisummary::

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




Attributes
~~~~~~~~~~

.. autoapisummary::

   cyclonedx.model.lifecycle.Lifecycle


.. 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:method:: capitalize()

      Return a capitalized version of the string.

      More specifically, make the first character have upper case and the rest lower
      case.


   .. py:method:: casefold()

      Return a version of the string suitable for caseless comparisons.


   .. py:method:: center()

      Return a centered string of length width.

      Padding is done using the specified fill character (default is a space).


   .. py:method:: count()

      S.count(sub[, start[, end]]) -> int

      Return the number of non-overlapping occurrences of substring sub in
      string S[start:end].  Optional arguments start and end are
      interpreted as in slice notation.


   .. py:method:: encode()

      Encode the string using the codec registered for encoding.

      encoding
        The encoding in which to encode the string.
      errors
        The error handling scheme to use for encoding errors.
        The default is 'strict' meaning that encoding errors raise a
        UnicodeEncodeError.  Other possible values are 'ignore', 'replace' and
        'xmlcharrefreplace' as well as any other name registered with
        codecs.register_error that can handle UnicodeEncodeErrors.


   .. py:method:: endswith()

      S.endswith(suffix[, start[, end]]) -> bool

      Return True if S ends with the specified suffix, False otherwise.
      With optional start, test S beginning at that position.
      With optional end, stop comparing S at that position.
      suffix can also be a tuple of strings to try.


   .. py:method:: expandtabs()

      Return a copy where all tab characters are expanded using spaces.

      If tabsize is not given, a tab size of 8 characters is assumed.


   .. py:method:: find()

      S.find(sub[, start[, end]]) -> int

      Return the lowest index in S where substring sub is found,
      such that sub is contained within S[start:end].  Optional
      arguments start and end are interpreted as in slice notation.

      Return -1 on failure.


   .. py:method:: format()

      S.format(*args, **kwargs) -> str

      Return a formatted version of S, using substitutions from args and kwargs.
      The substitutions are identified by braces ('{' and '}').


   .. py:method:: format_map()

      S.format_map(mapping) -> str

      Return a formatted version of S, using substitutions from mapping.
      The substitutions are identified by braces ('{' and '}').


   .. py:method:: index()

      S.index(sub[, start[, end]]) -> int

      Return the lowest index in S where substring sub is found,
      such that sub is contained within S[start:end].  Optional
      arguments start and end are interpreted as in slice notation.

      Raises ValueError when the substring is not found.


   .. py:method:: isalnum()

      Return True if the string is an alpha-numeric string, False otherwise.

      A string is alpha-numeric if all characters in the string are alpha-numeric and
      there is at least one character in the string.


   .. py:method:: isalpha()

      Return True if the string is an alphabetic string, False otherwise.

      A string is alphabetic if all characters in the string are alphabetic and there
      is at least one character in the string.


   .. py:method:: isascii()

      Return True if all characters in the string are ASCII, False otherwise.

      ASCII characters have code points in the range U+0000-U+007F.
      Empty string is ASCII too.


   .. py:method:: isdecimal()

      Return True if the string is a decimal string, False otherwise.

      A string is a decimal string if all characters in the string are decimal and
      there is at least one character in the string.


   .. py:method:: isdigit()

      Return True if the string is a digit string, False otherwise.

      A string is a digit string if all characters in the string are digits and there
      is at least one character in the string.


   .. py:method:: isidentifier()

      Return True if the string is a valid Python identifier, False otherwise.

      Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
      such as "def" or "class".


   .. py:method:: islower()

      Return True if the string is a lowercase string, False otherwise.

      A string is lowercase if all cased characters in the string are lowercase and
      there is at least one cased character in the string.


   .. py:method:: isnumeric()

      Return True if the string is a numeric string, False otherwise.

      A string is numeric if all characters in the string are numeric and there is at
      least one character in the string.


   .. py:method:: isprintable()

      Return True if the string is printable, False otherwise.

      A string is printable if all of its characters are considered printable in
      repr() or if it is empty.


   .. py:method:: isspace()

      Return True if the string is a whitespace string, False otherwise.

      A string is whitespace if all characters in the string are whitespace and there
      is at least one character in the string.


   .. py:method:: istitle()

      Return True if the string is a title-cased string, False otherwise.

      In a title-cased string, upper- and title-case characters may only
      follow uncased characters and lowercase characters only cased ones.


   .. py:method:: isupper()

      Return True if the string is an uppercase string, False otherwise.

      A string is uppercase if all cased characters in the string are uppercase and
      there is at least one cased character in the string.


   .. py:method:: join()

      Concatenate any number of strings.

      The string whose method is called is inserted in between each given string.
      The result is returned as a new string.

      Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'


   .. py:method:: ljust()

      Return a left-justified string of length width.

      Padding is done using the specified fill character (default is a space).


   .. py:method:: lower()

      Return a copy of the string converted to lowercase.


   .. py:method:: lstrip()

      Return a copy of the string with leading whitespace removed.

      If chars is given and not None, remove characters in chars instead.


   .. py:method:: partition()

      Partition the string into three parts using the given separator.

      This will search for the separator in the string.  If the separator is found,
      returns a 3-tuple containing the part before the separator, the separator
      itself, and the part after it.

      If the separator is not found, returns a 3-tuple containing the original string
      and two empty strings.


   .. py:method:: removeprefix()

      Return a str with the given prefix string removed if present.

      If the string starts with the prefix string, return string[len(prefix):].
      Otherwise, return a copy of the original string.


   .. py:method:: removesuffix()

      Return a str with the given suffix string removed if present.

      If the string ends with the suffix string and that suffix is not empty,
      return string[:-len(suffix)]. Otherwise, return a copy of the original
      string.


   .. py:method:: replace()

      Return a copy with all occurrences of substring old replaced by new.

        count
          Maximum number of occurrences to replace.
          -1 (the default value) means replace all occurrences.

      If the optional argument count is given, only the first count occurrences are
      replaced.


   .. py:method:: rfind()

      S.rfind(sub[, start[, end]]) -> int

      Return the highest index in S where substring sub is found,
      such that sub is contained within S[start:end].  Optional
      arguments start and end are interpreted as in slice notation.

      Return -1 on failure.


   .. py:method:: rindex()

      S.rindex(sub[, start[, end]]) -> int

      Return the highest index in S where substring sub is found,
      such that sub is contained within S[start:end].  Optional
      arguments start and end are interpreted as in slice notation.

      Raises ValueError when the substring is not found.


   .. py:method:: rjust()

      Return a right-justified string of length width.

      Padding is done using the specified fill character (default is a space).


   .. py:method:: rpartition()

      Partition the string into three parts using the given separator.

      This will search for the separator in the string, starting at the end. If
      the separator is found, returns a 3-tuple containing the part before the
      separator, the separator itself, and the part after it.

      If the separator is not found, returns a 3-tuple containing two empty strings
      and the original string.


   .. py:method:: rsplit()

      Return a list of the substrings in the string, using sep as the separator string.

        sep
          The separator used to split the string.

          When set to None (the default value), will split on any whitespace
          character (including \n \r \t \f and spaces) and will discard
          empty strings from the result.
        maxsplit
          Maximum number of splits.
          -1 (the default value) means no limit.

      Splitting starts at the end of the string and works to the front.


   .. py:method:: rstrip()

      Return a copy of the string with trailing whitespace removed.

      If chars is given and not None, remove characters in chars instead.


   .. py:method:: split()

      Return a list of the substrings in the string, using sep as the separator string.

        sep
          The separator used to split the string.

          When set to None (the default value), will split on any whitespace
          character (including \n \r \t \f and spaces) and will discard
          empty strings from the result.
        maxsplit
          Maximum number of splits.
          -1 (the default value) means no limit.

      Splitting starts at the front of the string and works to the end.

      Note, str.split() is mainly useful for data that has been intentionally
      delimited.  With natural text that includes punctuation, consider using
      the regular expression module.


   .. py:method:: splitlines()

      Return a list of the lines in the string, breaking at line boundaries.

      Line breaks are not included in the resulting list unless keepends is given and
      true.


   .. py:method:: startswith()

      S.startswith(prefix[, start[, end]]) -> bool

      Return True if S starts with the specified prefix, False otherwise.
      With optional start, test S beginning at that position.
      With optional end, stop comparing S at that position.
      prefix can also be a tuple of strings to try.


   .. py:method:: strip()

      Return a copy of the string with leading and trailing whitespace removed.

      If chars is given and not None, remove characters in chars instead.


   .. py:method:: swapcase()

      Convert uppercase characters to lowercase and lowercase characters to uppercase.


   .. py:method:: title()

      Return a version of the string where each word is titlecased.

      More specifically, words start with uppercased characters and all remaining
      cased characters have lower case.


   .. py:method:: translate()

      Replace each character in the string using the given translation table.

        table
          Translation table, which must be a mapping of Unicode ordinals to
          Unicode ordinals, strings, or None.

      The table must implement lookup/indexing via __getitem__, for instance a
      dictionary or list.  If this operation raises LookupError, the character is
      left untouched.  Characters mapped to None are deleted.


   .. py:method:: upper()

      Return a copy of the string converted to uppercase.


   .. py:method:: zfill()

      Pad a numeric string with zeros on the left, to fill a field of the given width.

      The string is never truncated.


   .. py:method:: name()

      The name of the Enum member.


   .. py:method:: value()

      The value of the Enum member.



.. 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(iterable=None, key=None)


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

   Collection of :class:`Lifecycle`.

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

   .. py:property:: key

      Function used to extract comparison key from values.

      Sorted set compares values directly when the key function is none.



   .. py:method:: add(value)

      Add `value` to sorted set.

      Runtime complexity: `O(log(n))` -- approximate.

      >>> ss = SortedSet()
      >>> ss.add(3)
      >>> ss.add(1)
      >>> ss.add(2)
      >>> ss
      SortedSet([1, 2, 3])

      :param value: value to add to sorted set



   .. py:method:: clear()

      Remove all values from sorted set.

      Runtime complexity: `O(n)`



   .. py:method:: copy()

      Return a shallow copy of the sorted set.

      Runtime complexity: `O(n)`

      :return: new sorted set



   .. py:method:: count(value)

      Return number of occurrences of `value` in the sorted set.

      Runtime complexity: `O(1)`

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> ss.count(3)
      1

      :param value: value to count in sorted set
      :return: count



   .. py:method:: discard(value)

      Remove `value` from sorted set if it is a member.

      If `value` is not a member, do nothing.

      Runtime complexity: `O(log(n))` -- approximate.

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> ss.discard(5)
      >>> ss.discard(0)
      >>> ss == set([1, 2, 3, 4])
      True

      :param value: `value` to discard from sorted set



   .. py:method:: pop(index=-1)

      Remove and return value at `index` in sorted set.

      Raise :exc:`IndexError` if the sorted set is empty or index is out of
      range.

      Negative indices are supported.

      Runtime complexity: `O(log(n))` -- approximate.

      >>> ss = SortedSet('abcde')
      >>> ss.pop()
      'e'
      >>> ss.pop(2)
      'c'
      >>> ss
      SortedSet(['a', 'b', 'd'])

      :param int index: index of value (default -1)
      :return: value
      :raises IndexError: if index is out of range



   .. py:method:: remove(value)

      Remove `value` from sorted set; `value` must be a member.

      If `value` is not a member, raise :exc:`KeyError`.

      Runtime complexity: `O(log(n))` -- approximate.

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> ss.remove(5)
      >>> ss == set([1, 2, 3, 4])
      True
      >>> ss.remove(0)
      Traceback (most recent call last):
        ...
      KeyError: 0

      :param value: `value` to remove from sorted set
      :raises KeyError: if `value` is not in sorted set



   .. py:method:: difference(*iterables)

      Return the difference of two or more sets as a new sorted set.

      The `difference` method also corresponds to operator ``-``.

      ``ss.__sub__(iterable)`` <==> ``ss - iterable``

      The difference is all values that are in this sorted set but not the
      other `iterables`.

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> ss.difference([4, 5, 6, 7])
      SortedSet([1, 2, 3])

      :param iterables: iterable arguments
      :return: new sorted set



   .. py:method:: difference_update(*iterables)

      Remove all values of `iterables` from this sorted set.

      The `difference_update` method also corresponds to operator ``-=``.

      ``ss.__isub__(iterable)`` <==> ``ss -= iterable``

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> _ = ss.difference_update([4, 5, 6, 7])
      >>> ss
      SortedSet([1, 2, 3])

      :param iterables: iterable arguments
      :return: itself



   .. py:method:: intersection(*iterables)

      Return the intersection of two or more sets as a new sorted set.

      The `intersection` method also corresponds to operator ``&``.

      ``ss.__and__(iterable)`` <==> ``ss & iterable``

      The intersection is all values that are in this sorted set and each of
      the other `iterables`.

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> ss.intersection([4, 5, 6, 7])
      SortedSet([4, 5])

      :param iterables: iterable arguments
      :return: new sorted set



   .. py:method:: intersection_update(*iterables)

      Update the sorted set with the intersection of `iterables`.

      The `intersection_update` method also corresponds to operator ``&=``.

      ``ss.__iand__(iterable)`` <==> ``ss &= iterable``

      Keep only values found in itself and all `iterables`.

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> _ = ss.intersection_update([4, 5, 6, 7])
      >>> ss
      SortedSet([4, 5])

      :param iterables: iterable arguments
      :return: itself



   .. py:method:: symmetric_difference(other)

      Return the symmetric difference with `other` as a new sorted set.

      The `symmetric_difference` method also corresponds to operator ``^``.

      ``ss.__xor__(other)`` <==> ``ss ^ other``

      The symmetric difference is all values tha are in exactly one of the
      sets.

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> ss.symmetric_difference([4, 5, 6, 7])
      SortedSet([1, 2, 3, 6, 7])

      :param other: `other` iterable
      :return: new sorted set



   .. py:method:: symmetric_difference_update(other)

      Update the sorted set with the symmetric difference with `other`.

      The `symmetric_difference_update` method also corresponds to operator
      ``^=``.

      ``ss.__ixor__(other)`` <==> ``ss ^= other``

      Keep only values found in exactly one of itself and `other`.

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> _ = ss.symmetric_difference_update([4, 5, 6, 7])
      >>> ss
      SortedSet([1, 2, 3, 6, 7])

      :param other: `other` iterable
      :return: itself



   .. py:method:: union(*iterables)

      Return new sorted set with values from itself and all `iterables`.

      The `union` method also corresponds to operator ``|``.

      ``ss.__or__(iterable)`` <==> ``ss | iterable``

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> ss.union([4, 5, 6, 7])
      SortedSet([1, 2, 3, 4, 5, 6, 7])

      :param iterables: iterable arguments
      :return: new sorted set



   .. py:method:: update(*iterables)

      Update the sorted set adding values from all `iterables`.

      The `update` method also corresponds to operator ``|=``.

      ``ss.__ior__(iterable)`` <==> ``ss |= iterable``

      >>> ss = SortedSet([1, 2, 3, 4, 5])
      >>> _ = ss.update([4, 5, 6, 7])
      >>> ss
      SortedSet([1, 2, 3, 4, 5, 6, 7])

      :param iterables: iterable arguments
      :return: itself



   .. py:method:: isdisjoint(other)

      Return True if two sets have a null intersection.


   .. py:method:: index(value, start=0, stop=None)

      S.index(value, [start, [stop]]) -> integer -- return first index of value.
      Raises ValueError if the value is not present.

      Supporting start and stop arguments is optional, but
      recommended.



