Add type hints for SortedSet

Fix use of set/Set.

Signed-off-by: Rodney Richardson <[email protected]>

Author: RodneyRichardson

.mypy.ini

@@ -1,6 +1,7 @@
 [mypy]
 
 files = cyclonedx/
+mypy_path = $MYPY_CONFIG_FILE_DIR/typings
 
 show_error_codes = True
 pretty = True

cyclonedx/model/__init__.py

@@ -21,7 +21,7 @@
 import warnings
 from datetime import datetime
 from enum import Enum
-from typing import Any, Iterable, Optional, Set
+from typing import Any, Iterable, Optional, Set, TypeVar
 
 from sortedcontainers import SortedSet
 
@@ -496,7 +496,7 @@ def type(self, type_: ExternalReferenceType) -> None:
         self._type = type_
 
     @property
-    def hashes(self) -> Set[HashType]:
+    def hashes(self) -> SortedSet[HashType]:
         """
         The hashes of the external reference (if applicable).
 
@@ -516,7 +516,8 @@ def __eq__(self, other: object) -> bool:
 
     def __lt__(self, other: Any) -> bool:
         if isinstance(other, ExternalReference):
-            return ComparableTuple((self._type, self._url, self._comment)) < ComparableTuple((other._type, other._url, other._comment))
+            return ComparableTuple((self._type, self._url, self._comment)) < \
+                ComparableTuple((other._type, other._url, other._comment))
         return NotImplemented
 
     def __hash__(self) -> int:
@@ -831,7 +832,8 @@ def __eq__(self, other: object) -> bool:
 
     def __lt__(self, other: Any) -> bool:
         if isinstance(other, NoteText):
-            return ComparableTuple((self.content, self.content_type, self.encoding)) < ComparableTuple((other.content, other.content_type, other.encoding))
+            return ComparableTuple((self.content, self.content_type, self.encoding)) < \
+                ComparableTuple((other.content, other.content_type, other.encoding))
         return NotImplemented
 
     def __hash__(self) -> int:
@@ -980,7 +982,8 @@ def __eq__(self, other: object) -> bool:
 
     def __lt__(self, other: Any) -> bool:
         if isinstance(other, OrganizationalContact):
-            return ComparableTuple((self.name, self.email, self.phone)) < ComparableTuple((other.name, other.email, other.phone))
+            return ComparableTuple((self.name, self.email, self.phone)) < \
+                ComparableTuple((other.name, other.email, other.phone))
         return NotImplemented
 
     def __hash__(self) -> int:
@@ -1024,7 +1027,7 @@ def name(self, name: Optional[str]) -> None:
         self._name = name
 
     @property
-    def url(self) -> Set[XsUri]:
+    def url(self) -> SortedSet[XsUri]:
         """
         Get a list of URLs of the organization. Multiple URLs are allowed.
 
@@ -1038,7 +1041,7 @@ def url(self, urls: Iterable[XsUri]) -> None:
         self._url = SortedSet(urls)
 
     @property
-    def contact(self) -> Set[OrganizationalContact]:
+    def contact(self) -> SortedSet[OrganizationalContact]:
         """
         Get a list of contact person at the organization. Multiple contacts are allowed.
 
@@ -1125,7 +1128,7 @@ def version(self, version: Optional[str]) -> None:
         self._version = version
 
     @property
-    def hashes(self) -> Set[HashType]:
+    def hashes(self) -> SortedSet[HashType]:
         """
         The hashes of the tool (if applicable).
 
@@ -1139,7 +1142,7 @@ def hashes(self, hashes: Iterable[HashType]) -> None:
         self._hashes = SortedSet(hashes)
 
     @property
-    def external_references(self) -> Set[ExternalReference]:
+    def external_references(self) -> SortedSet[ExternalReference]:
         """
         External References provide a way to document systems, sites, and information that may be relevant but which
         are not included with the BOM.
@@ -1160,7 +1163,8 @@ def __eq__(self, other: object) -> bool:
 
     def __lt__(self, other: Any) -> bool:
         if isinstance(other, Tool):
-            return ComparableTuple((self.vendor, self.name, self.version)) < ComparableTuple((other.vendor, other.name, other.version))
+            return ComparableTuple((self.vendor, self.name, self.version)) < \
+                ComparableTuple((other.vendor, other.name, other.version))
         return NotImplemented
 
     def __hash__(self) -> int:
@@ -1238,7 +1242,8 @@ def __eq__(self, other: object) -> bool:
 
     def __lt__(self, other: Any) -> bool:
         if isinstance(other, IdentifiableAction):
-            return ComparableTuple((self.timestamp, self.name, self.email)) < ComparableTuple((other.timestamp, other.name, other.email))
+            return ComparableTuple((self.timestamp, self.name, self.email)) < \
+                ComparableTuple((other.timestamp, other.name, other.email))
         return NotImplemented
 
     def __hash__(self) -> int:

cyclonedx/model/bom.py

@@ -21,6 +21,8 @@
 from typing import Iterable, Optional, Set
 from uuid import UUID, uuid4
 
+from sortedcontainers import SortedSet
+
 from ..exception.model import UnknownComponentDependencyException
 from ..parser import BaseParser
 from . import ExternalReference, LicenseChoice, OrganizationalContact, OrganizationalEntity, Property, ThisTool, Tool
@@ -43,13 +45,13 @@ def __init__(self, *, tools: Optional[Iterable[Tool]] = None,
                  licenses: Optional[Iterable[LicenseChoice]] = None,
                  properties: Optional[Iterable[Property]] = None) -> None:
         self.timestamp = datetime.now(tz=timezone.utc)
-        self.tools = set(tools or [])
-        self.authors = set(authors or [])
+        self.tools = SortedSet(tools or [])
+        self.authors = SortedSet(authors or [])
         self.component = component
         self.manufacture = manufacture
         self.supplier = supplier
-        self.licenses = set(licenses or [])
-        self.properties = set(properties or [])
+        self.licenses = SortedSet(licenses or [])
+        self.properties = SortedSet(properties or [])
 
         if not tools:
             self.tools.add(ThisTool)
@@ -69,7 +71,7 @@ def timestamp(self, timestamp: datetime) -> None:
         self._timestamp = timestamp
 
     @property
-    def tools(self) -> Set[Tool]:
+    def tools(self) -> SortedSet[Tool]:
         """
         Tools used to create this BOM.
 
@@ -80,10 +82,10 @@ def tools(self) -> Set[Tool]:
 
     @tools.setter
     def tools(self, tools: Iterable[Tool]) -> None:
-        self._tools = set(tools)
+        self._tools = SortedSet(tools)
 
     @property
-    def authors(self) -> Set[OrganizationalContact]:
+    def authors(self) -> SortedSet[OrganizationalContact]:
         """
         The person(s) who created the BOM.
 
@@ -98,7 +100,7 @@ def authors(self) -> Set[OrganizationalContact]:
 
     @authors.setter
     def authors(self, authors: Iterable[OrganizationalContact]) -> None:
-        self._authors = set(authors)
+        self._authors = SortedSet(authors)
 
     @property
     def component(self) -> Optional[Component]:
@@ -155,7 +157,7 @@ def supplier(self, supplier: Optional[OrganizationalEntity]) -> None:
         self._supplier = supplier
 
     @property
-    def licenses(self) -> Set[LicenseChoice]:
+    def licenses(self) -> SortedSet[LicenseChoice]:
         """
         A optional list of statements about how this BOM is licensed.
 
@@ -166,10 +168,10 @@ def licenses(self) -> Set[LicenseChoice]:
 
     @licenses.setter
     def licenses(self, licenses: Iterable[LicenseChoice]) -> None:
-        self._licenses = set(licenses)
+        self._licenses = SortedSet(licenses)
 
     @property
-    def properties(self) -> Set[Property]:
+    def properties(self) -> SortedSet[Property]:
         """
         Provides the ability to document properties in a key/value store. This provides flexibility to include data not
         officially supported in the standard without having to use additional namespaces or create extensions.
@@ -184,7 +186,7 @@ def properties(self) -> Set[Property]:
 
     @properties.setter
     def properties(self, properties: Iterable[Property]) -> None:
-        self._properties = set(properties)
+        self._properties = SortedSet(properties)
 
     def __eq__(self, other: object) -> bool:
         if isinstance(other, BomMetaData):
@@ -237,9 +239,9 @@ def __init__(self, *, components: Optional[Iterable[Component]] = None,
         """
         self.uuid = uuid4()
         self.metadata = BomMetaData()
-        self.components = set(components or [])
-        self.services = set(services or [])
-        self.external_references = set(external_references or [])
+        self.components = SortedSet(components or [])
+        self.services = SortedSet(services or [])
+        self.external_references = SortedSet(external_references or [])
 
     @property
     def uuid(self) -> UUID:
@@ -273,7 +275,7 @@ def metadata(self, metadata: BomMetaData) -> None:
         self._metadata = metadata
 
     @property
-    def components(self) -> Set[Component]:
+    def components(self) -> SortedSet[Component]:
         """
         Get all the Components currently in this Bom.
 
@@ -284,7 +286,7 @@ def components(self) -> Set[Component]:
 
     @components.setter
     def components(self, components: Iterable[Component]) -> None:
-        self._components = set(components)
+        self._components = SortedSet(components)
 
     def get_component_by_purl(self, purl: Optional[str]) -> Optional[Component]:
         """
@@ -327,7 +329,7 @@ def has_component(self, component: Component) -> bool:
         return component in self.components
 
     @property
-    def services(self) -> Set[Service]:
+    def services(self) -> SortedSet[Service]:
         """
         Get all the Services currently in this Bom.
 
@@ -338,10 +340,10 @@ def services(self) -> Set[Service]:
 
     @services.setter
     def services(self, services: Iterable[Service]) -> None:
-        self._services = set(services)
+        self._services = SortedSet(services)
 
     @property
-    def external_references(self) -> Set[ExternalReference]:
+    def external_references(self) -> SortedSet[ExternalReference]:
         """
         Provides the ability to document external references related to the BOM or to the project the BOM describes.
 
@@ -352,7 +354,7 @@ def external_references(self) -> Set[ExternalReference]:
 
     @external_references.setter
     def external_references(self, external_references: Iterable[ExternalReference]) -> None:
-        self._external_references = set(external_references)
+        self._external_references = SortedSet(external_references)
 
     def has_vulnerabilities(self) -> bool:
         """