spdx_tools.spdx3.bump_from_spdx2.license_expression

 1# SPDX-FileCopyrightText: 2023 spdx contributors
 2#
 3# SPDX-License-Identifier: Apache-2.0
 4from beartype.typing import List, Union
 5from license_expression import AND, OR, LicenseExpression, LicenseSymbol, LicenseWithExceptionSymbol
 6
 7from spdx_tools.common.spdx_licensing import spdx_licensing
 8from spdx_tools.spdx3.model.licensing import (
 9    AnyLicenseInfo,
10    ConjunctiveLicenseSet,
11    CustomLicense,
12    CustomLicenseAddition,
13    DisjunctiveLicenseSet,
14    License,
15    LicenseAddition,
16    LicenseField,
17    ListedLicense,
18    ListedLicenseException,
19    NoAssertionLicense,
20    NoneLicense,
21    WithAdditionOperator,
22)
23from spdx_tools.spdx.model import ExtractedLicensingInfo, SpdxNoAssertion, SpdxNone
24
25
26def bump_license_expression_or_none_or_no_assertion(
27    element: Union[LicenseExpression, SpdxNoAssertion, SpdxNone],
28    extracted_licensing_info: List[ExtractedLicensingInfo],
29) -> LicenseField:
30    if isinstance(element, SpdxNone):
31        return NoneLicense()
32    elif isinstance(element, SpdxNoAssertion):
33        return NoAssertionLicense()
34    else:
35        return bump_license_expression(element, extracted_licensing_info)
36
37
38def bump_license_expression(
39    license_expression: LicenseExpression, extracted_licensing_info: List[ExtractedLicensingInfo]
40) -> AnyLicenseInfo:
41    if isinstance(license_expression, AND):
42        return ConjunctiveLicenseSet(
43            member=[bump_license_expression(element, extracted_licensing_info) for element in license_expression.args]
44        )
45    if isinstance(license_expression, OR):
46        return DisjunctiveLicenseSet(
47            member=[bump_license_expression(element, extracted_licensing_info) for element in license_expression.args]
48        )
49    if isinstance(license_expression, LicenseWithExceptionSymbol):
50        subject_license = bump_license_expression(license_expression.license_symbol, extracted_licensing_info)
51        if not isinstance(subject_license, License):
52            raise ValueError("Subject of LicenseException couldn't be converted to License.")
53        return WithAdditionOperator(
54            subject_license=subject_license,
55            subject_addition=bump_license_exception(license_expression.exception_symbol, extracted_licensing_info),
56        )
57    if isinstance(license_expression, LicenseSymbol):
58        if not spdx_licensing.validate(license_expression).invalid_symbols:
59            return ListedLicense(license_expression.key, license_expression.obj, "blank")
60        else:
61            for licensing_info in extracted_licensing_info:
62                if licensing_info.license_id == license_expression.key:
63                    # the fields are optional in ExtractedLicensingInfo, to prevent type errors we use a type
64                    # conversion to str as a quick fix
65                    return CustomLicense(
66                        str(licensing_info.license_id),
67                        str(licensing_info.license_name),
68                        str(licensing_info.extracted_text),
69                    )
70
71            return CustomLicense(license_expression.key, "", "")
72
73
74def bump_license_exception(
75    license_exception: LicenseSymbol, extracted_licensing_info: List[ExtractedLicensingInfo]
76) -> LicenseAddition:
77    if not spdx_licensing.validate(license_exception).invalid_symbols:
78        return ListedLicenseException(license_exception.key, "", "")
79    else:
80        for licensing_info in extracted_licensing_info:
81            if licensing_info.license_id == license_exception.key:
82                # the fields are optional in ExtractedLicensingInfo, to prevent type errors we use a type conversion
83                # to str as a quick fix
84                return CustomLicenseAddition(
85                    str(licensing_info.license_id),
86                    str(licensing_info.license_name),
87                    str(licensing_info.extracted_text),
88                )
89        return CustomLicenseAddition(license_exception.key, "", "")