cyclonedx.output.xml ==================== .. py:module:: cyclonedx.output.xml Attributes ---------- .. autoapisummary:: cyclonedx.output.xml.BY_SCHEMA_VERSION Classes ------- .. autoapisummary:: cyclonedx.output.xml.Xml cyclonedx.output.xml.XmlV1Dot0 cyclonedx.output.xml.XmlV1Dot1 cyclonedx.output.xml.XmlV1Dot2 cyclonedx.output.xml.XmlV1Dot3 cyclonedx.output.xml.XmlV1Dot4 cyclonedx.output.xml.XmlV1Dot5 cyclonedx.output.xml.XmlV1Dot6 cyclonedx.output.xml.XmlV1Dot7 Module Contents --------------- .. py:class:: Xml(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`cyclonedx.schema.schema.BaseSchemaVersion`, :py:obj:`cyclonedx.output.BaseOutput` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:class:: XmlV1Dot0(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`Xml`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot0` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:class:: XmlV1Dot1(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`Xml`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot1` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:class:: XmlV1Dot2(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`Xml`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot2` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:class:: XmlV1Dot3(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`Xml`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot3` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:class:: XmlV1Dot4(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`Xml`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot4` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:class:: XmlV1Dot5(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`Xml`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot5` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:class:: XmlV1Dot6(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`Xml`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot6` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:class:: XmlV1Dot7(bom: cyclonedx.model.bom.Bom) Bases: :py:obj:`Xml`, :py:obj:`cyclonedx.schema.schema.SchemaVersion1Dot7` Helper class that provides a standard way to create an ABC using inheritance. .. py:property:: schema_version :type: cyclonedx.schema.SchemaVersion .. py:property:: output_format :type: Literal[cyclonedx.schema.OutputFormat.XML] .. py:method:: generate(force_regeneration: bool = False) -> None .. py:method:: output_as_string(*, indent: Optional[Union[int, str]] = None, **kwargs: Any) -> str .. py:method:: get_target_namespace() -> str .. py:property:: schema_version_enum :type: cyclonedx.schema.SchemaVersion :abstractmethod: .. py:method:: get_schema_version() -> str .. py:data:: BY_SCHEMA_VERSION :type: dict[cyclonedx.schema.SchemaVersion, type[Xml]]