Additioal cleanup and improving semantics

Author: jkugler

cyclonedx/model/bom.py

@@ -26,7 +26,11 @@
 from sortedcontainers import SortedSet
 
 from .._internal.time import get_now_utc as _get_now_utc
-from ..exception.model import LicenseExpressionAlongWithOthersException, UnknownComponentDependencyException
+from ..exception.model import (
+    LicenseExpressionAlongWithOthersException,
+    MutuallyExclusivePropertiesException,
+    UnknownComponentDependencyException,
+)
 from ..model.tool import Tool, ToolRepository, ToolRepositoryHelper
 from ..schema.schema import (
     SchemaVersion1Dot0,
@@ -119,27 +123,35 @@ def timestamp(self, timestamp: datetime) -> None:
     @serializable.type_mapping(ToolRepositoryHelper)
     @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'tool')
     @serializable.xml_sequence(3)
-    def tools(self) -> ToolRepository:
+    def tools(self) -> Union[Iterable[Tool], ToolRepository]:
         """
         Tools used to create this BOM.
 
         Returns:
             `Set` of `Tool` objects.
         """
-        return self._tools  # type: ignore
+        if self._tools._tools:  # pylint: disable=protected-access
+            return self._tools._tools  # pylint: disable=protected-access
+
+        return self._tools
 
     @tools.setter
-    def tools(self, tools: Union[ToolRepository, Iterable[Tool]]) -> None:
+    def tools(self, tools: Union[Iterable[Tool], ToolRepository]) -> None:
         if isinstance(tools, ToolRepository):
             self._tools = tools
         else:
             # This allows the old behavior of assigning the list of tools directly to bom.metadata.tools
             warn(
                 '`bom.metadata.tools` as a list of Tool objects is deprecated from CycloneDX v1.5 '
                 'onwards. Please use lists of `Component` and `Service` objects as `tools.components` '
-                'and `tools.services`, respecitvely'
+                'and `tools.services`, respectively.'
             )
-            self._tools = ToolRepository(tools=tools)  # type:ignore
+            if self._tools._components or self._tools._services:
+                raise MutuallyExclusivePropertiesException(
+                    'Cannot serialize both old (CycloneDX <= 1.4) and new '
+                    '(CycloneDX >= 1.5) format for tools.'
+                )
+            self._tools = ToolRepository(tools=tools)
 
     @property
     @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'author')

cyclonedx/model/tool.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, Iterable, List, Optional, Type, Union
+from typing import Any, Dict, Iterable, Iterator, List, Optional, Type, Union
 from xml.etree.ElementTree import Element  # nosec B405
 
 import serializable
@@ -7,7 +7,8 @@
 from sortedcontainers import SortedSet
 
 from .._internal.compare import ComparableTuple as _ComparableTuple
-from ..exception.serialization import CycloneDxDeserializationException, SerializationOfUnexpectedValueException
+from ..exception.model import MutuallyExclusivePropertiesException
+from ..exception.serialization import CycloneDxDeserializationException
 from ..model import ExternalReference, HashType, _HashTypeRepositorySerializationHelper
 from ..model.component import Component
 from ..model.service import Service
@@ -152,15 +153,57 @@ def __init__(self, *, components: Optional[Iterable[Component]] = None,
         # Must use components/services or tools. Cannot use both
         self._tools = tools or SortedSet()
 
+    @property
+    def components(self) -> Iterable[Component]:
+        """
+        Returns:
+            A SortedSet of Components
+        """
+        return self._components
+
+    @components.setter
+    def components(self, components: Iterable[Component]) -> None:
+        if self._tools:
+            raise MutuallyExclusivePropertiesException(
+                'Cannot serialize both old (CycloneDX <= 1.4) and new '
+                '(CycloneDX >= 1.5) format for tools.'
+            )
+
+        self._components = components
+
+    @property
+    def services(self) -> Iterable[Service]:
+        """
+        Returns:
+            A SortedSet of Services
+        """
+        return self._services
+
+    @services.setter
+    def services(self, services: Iterable[Service]) -> None:
+        if self._tools:
+            raise MutuallyExclusivePropertiesException(
+                'Cannot serialize both old (CycloneDX <= 1.4) and new '
+                '(CycloneDX >= 1.5) format for tools: {o!r}'
+            )
+        self._services = services
+
     def __getattr__(self, name: str) -> Any:
-        if name == 'components':
-            return self._components
-        if name == 'services':
-            return self._services
+        """
+        Enables us to behave as list of tools to maintain
+        backward compatibility.
 
+        Returns:
+            An attribute of SortedSet
+        """
         return getattr(self._tools, name)
 
-    def __iter__(self) -> Tool:
+    def __iter__(self) -> Iterator[Tool]:
+        """
+        Also part of acting as a list of tools
+
+        Returns Iterator[Tool]
+        """
         for t in self._tools:
             yield t
 
@@ -173,12 +216,6 @@ def json_normalize(cls, o: ToolRepository, *,
         if not any([o._tools, o._components, o._services]):  # pylint: disable=protected-access
             return None
 
-        if o._tools and any([o._components, o._services]):  # pylint: disable=protected-access
-            raise SerializationOfUnexpectedValueException(
-                'Cannot serialize both old (CycloneDX <= 1.4) and new '
-                '(CycloneDX >= 1.5) format for tools: {o!r}'
-            )
-
         if o._tools:  # pylint: disable=protected-access
             return [Tool.as_json(t) for t in o._tools]  # pylint: disable=protected-access