cyclonedx.model.composition =========================== .. py:module:: cyclonedx.model.composition .. autoapi-nested-parse:: This set of classes represents the compositions in the CycloneDX standard. .. note:: Introduced in CycloneDX v1.3 .. note:: See the CycloneDX Schema for compositions: https://cyclonedx.org/docs/1.7/xml/#type_compositionType Classes ------- .. autoapisummary:: cyclonedx.model.composition.AggregateType cyclonedx.model.composition.Composition Module Contents --------------- .. py:class:: AggregateType Bases: :py:obj:`str`, :py:obj:`enum.Enum` Enum object that defines the permissible 'aggregate' types for a Composition according to the CycloneDX schema. Specifies an aggregate type that describes how complete a relationship is. .. note:: See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_aggregateType .. py:attribute:: COMPLETE :value: 'complete' .. py:attribute:: INCOMPLETE :value: 'incomplete' .. py:attribute:: INCOMPLETE_FIRST_PARTY_ONLY :value: 'incomplete_first_party_only' .. py:attribute:: INCOMPLETE_FIRST_PARTY_PROPRIETARY_ONLY :value: 'incomplete_first_party_proprietary_only' .. py:attribute:: INCOMPLETE_FIRST_PARTY_OPENSOURCE_ONLY :value: 'incomplete_first_party_opensource_only' .. py:attribute:: INCOMPLETE_THIRD_PARTY_ONLY :value: 'incomplete_third_party_only' .. py:attribute:: INCOMPLETE_THIRD_PARTY_PROPRIETARY_ONLY :value: 'incomplete_third_party_proprietary_only' .. py:attribute:: INCOMPLETE_THIRD_PARTY_OPENSOURCE_ONLY :value: 'incomplete_third_party_opensource_only' .. py:attribute:: UNKNOWN :value: 'unknown' .. py:attribute:: NOT_SPECIFIED :value: 'not_specified' .. py:class:: Composition(*, aggregate: AggregateType = AggregateType.NOT_SPECIFIED, assemblies: Optional[collections.abc.Iterable[_Assembly]] = None, dependencies: Optional[collections.abc.Iterable[cyclonedx.model.bom_ref.BomRef]] = None, vulnerabilities: Optional[collections.abc.Iterable[cyclonedx.model.bom_ref.BomRef]] = None, bom_ref: Optional[Union[str, cyclonedx.model.bom_ref.BomRef]] = None) Models a Composition within a BOM. .. note:: See https://cyclonedx.org/docs/1.7/xml/#type_compositionType .. py:property:: aggregate :type: AggregateType Specifies an aggregate type that describes how complete a relationship is. Returns: `AggregateType` .. py:property:: assemblies :type: _AssemblyRepository The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. Returns: Set of `BomRef`/`XsUri` .. py:property:: dependencies :type: _BomRefRepository The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. Returns: Set of `BomRef` .. py:property:: vulnerabilities :type: _BomRefRepository The bom-ref identifiers of the vulnerabilities being described. Returns: Set of `BomRef` .. py:property:: bom_ref :type: Optional[cyclonedx.model.bom_ref.BomRef] An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref MUST be unique within the BOM. Returns: `BomRef`