spdx_tools.spdx.model.relationship_filters

 1# SPDX-FileCopyrightText: 2022 spdx contributors
 2#
 3# SPDX-License-Identifier: Apache-2.0
 4from beartype.typing import List
 5
 6from spdx_tools.spdx.model import Document, Package, Relationship, RelationshipType
 7
 8
 9def find_package_contains_file_relationships(document: Document, package: Package) -> List[Relationship]:
10    file_ids_in_document = [file.spdx_id for file in document.files]
11    package_contains_relationships = filter_by_type_and_origin(
12        document.relationships, RelationshipType.CONTAINS, package.spdx_id
13    )
14    return [
15        relationship
16        for relationship in package_contains_relationships
17        if relationship.related_spdx_element_id in file_ids_in_document
18    ]
19
20
21def find_file_contained_by_package_relationships(document: Document, package: Package) -> List[Relationship]:
22    file_ids_in_document = [file.spdx_id for file in document.files]
23    contained_by_package_relationships = filter_by_type_and_target(
24        document.relationships, RelationshipType.CONTAINED_BY, package.spdx_id
25    )
26    return [
27        relationship
28        for relationship in contained_by_package_relationships
29        if relationship.spdx_element_id in file_ids_in_document
30    ]
31
32
33def filter_by_type_and_target(
34    relationships: List[Relationship], relationship_type: RelationshipType, target_id: str
35) -> List[Relationship]:
36    return [
37        relationship
38        for relationship in relationships
39        if relationship.relationship_type == relationship_type and relationship.related_spdx_element_id == target_id
40    ]
41
42
43def filter_by_type_and_origin(
44    relationships: List[Relationship], relationship_type: RelationshipType, origin_id: str
45) -> List[Relationship]:
46    return [
47        relationship
48        for relationship in relationships
49        if relationship.relationship_type == relationship_type and relationship.spdx_element_id == origin_id
50    ]