fix type hint for get_component_by_purl

Signed-off-by: gruebel <[email protected]>

Author: gruebel

cyclonedx/model/bom.py

@@ -18,7 +18,7 @@
 # Copyright (c) OWASP Foundation. All Rights Reserved.
 import warnings
 from datetime import datetime, timezone
-from typing import Iterable, Optional, Set
+from typing import TYPE_CHECKING, Iterable, Optional, Set
 from uuid import UUID, uuid4
 
 from sortedcontainers import SortedSet
@@ -29,6 +29,9 @@
 from .component import Component
 from .service import Service
 
+if TYPE_CHECKING:
+    from packageurl import PackageURL  # type:ignore[import]
+
 
 class BomMetaData:
     """
@@ -288,19 +291,19 @@ def components(self) -> "SortedSet[Component]":
     def components(self, components: Iterable[Component]) -> None:
         self._components = SortedSet(components)
 
-    def get_component_by_purl(self, purl: Optional[str]) -> Optional[Component]:
+    def get_component_by_purl(self, purl: Optional["PackageURL"]) -> Optional[Component]:
         """
         Get a Component already in the Bom by its PURL
 
         Args:
              purl:
-                Package URL as a `str` to look and find `Component`
+                An instance of `packageurl.PackageURL` to look and find `Component`.
 
         Returns:
             `Component` or `None`
         """
         if purl:
-            found = list(filter(lambda x: x.purl == purl, self.components))
+            found = [x for x in self.components if x.purl == purl]
             if len(found) == 1:
                 return found[0]
 

tests/test_component.py

@@ -85,3 +85,13 @@ def test_has_component_1(self) -> None:
         self.assertEqual(len(bom.components), 2)
         self.assertTrue(bom.has_component(component=get_component_setuptools_simple_no_version()))
         self.assertIsNot(get_component_setuptools_simple(), get_component_setuptools_simple_no_version())
+
+    def test_get_component_by_purl(self) -> None:
+        bom = Bom()
+        setuptools_simple = get_component_setuptools_simple()
+        bom.components.add(get_component_setuptools_simple())
+
+        result = bom.get_component_by_purl(get_component_setuptools_simple().purl)
+
+        self.assertEqual(result, setuptools_simple)
+        self.assertIsNone(bom.get_component_by_purl(get_component_setuptools_simple_no_version().purl))