[issue-10] use license_expression library for LicenseExpression

Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
spdx · armintaenzertng · Jan 27, 2023 · Jan 26, 2023 · Jan 27, 2023 · Jan 27, 2023
commit cf244f53f7cb6562450ae029daf411592520f339
diff --git a/pyproject.toml b/pyproject.toml
@@ -24,7 +24,7 @@ classifiers = [
 ]
 urls = {Homepage = "https://github.com/spdx/tools-python"}
 requires-python = ">=3.7"
-dependencies = ["ply", "rdflib", "click", "pyyaml", "xmltodict", "typeguard", "uritools"]
+dependencies = ["ply", "rdflib", "click", "pyyaml", "xmltodict", "typeguard", "uritools", "license_expression"]
 dynamic = ["version"]
 
 [project.optional-dependencies]

diff --git a/src/spdx/jsonschema/optional_utils.py b/src/spdx/jsonschema/optional_utils.py
@@ -18,4 +18,4 @@ def apply_if_present(function: Callable[[T], S], optional_value: Optional[T]) ->
     """
     Apply the passed function to the optional value if it is not None. Else returns None.
     """
-    return function(optional_value) if optional_value else None
+    return function(optional_value) if optional_value is not None else None
diff --git a/src/spdx/model/file.py b/src/spdx/model/file.py
@@ -14,7 +14,7 @@
 
 from spdx.model.checksum import Checksum
 from common.typing.dataclass_with_properties import dataclass_with_properties
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from common.typing.type_checks import check_types_and_set_values

diff --git a/src/spdx/model/license_expression.py b/src/spdx/model/license_expression.py
diff --git a/src/spdx/model/package.py b/src/spdx/model/package.py
@@ -16,7 +16,7 @@
 from spdx.model.actor import Actor
 from spdx.model.checksum import Checksum
 from common.typing.dataclass_with_properties import dataclass_with_properties
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from common.typing.type_checks import check_types_and_set_values

diff --git a/src/spdx/model/snippet.py b/src/spdx/model/snippet.py
@@ -12,7 +12,7 @@
 from typing import Tuple, Optional, List, Union
 
 from common.typing.dataclass_with_properties import dataclass_with_properties
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from common.typing.type_checks import check_types_and_set_values

diff --git a/src/spdx/parser/jsonlikedict/file_parser.py b/src/spdx/parser/jsonlikedict/file_parser.py
@@ -12,7 +12,7 @@
 
 from spdx.model.checksum import Checksum
 from spdx.model.file import File, FileType
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from spdx.parser.jsonlikedict.checksum_parser import ChecksumParser

diff --git a/src/spdx/parser/jsonlikedict/license_expression_parser.py b/src/spdx/parser/jsonlikedict/license_expression_parser.py
@@ -10,31 +10,45 @@
 # limitations under the License.
 from typing import Union, List
 
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression, Licensing, ExpressionError
+
+from spdx.model.spdx_no_assertion import SpdxNoAssertion
+from spdx.model.spdx_none import SpdxNone
 from spdx.parser.error import SPDXParsingError
-from spdx.parser.jsonlikedict.dict_parsing_functions import construct_or_raise_parsing_error, append_parsed_field_or_log_error, \
+from spdx.parser.jsonlikedict.dict_parsing_functions import append_parsed_field_or_log_error, \
     raise_parsing_error_if_logger_has_messages
 from spdx.parser.logger import Logger
 
 
 class LicenseExpressionParser:
     @staticmethod
-    def parse_license_expression(license_expression_str_or_list: str) -> LicenseExpression:
-        license_expression = construct_or_raise_parsing_error(LicenseExpression,
-                                                              dict(expression_string=license_expression_str_or_list))
+    def parse_license_expression(license_expression_str: str) -> Union[LicenseExpression, SpdxNone, SpdxNoAssertion]:
+        if isinstance(license_expression_str, str):
+            if license_expression_str.upper() == "NOASSERTION":
+                return SpdxNoAssertion()
+            if license_expression_str.upper() == "NONE":
+                return SpdxNone()
+
+        try:
+            license_expression = Licensing().parse(license_expression_str)
+        except ExpressionError as err:
+            raise SPDXParsingError([f"Error parsing LicenseExpression: {err.args[0]}: {license_expression_str}"])
+
         return license_expression
 
-    def parse_license_expressions(self, license_expression_str_or_list: Union[str, List[str]]) -> Union[LicenseExpression, List[LicenseExpression]]:
-        if isinstance(license_expression_str_or_list, str):
+    def parse_license_expressions(self, license_expression_str_or_list: Union[str, List[str]]) -> Union[
+        LicenseExpression, SpdxNone, SpdxNoAssertion, List[Union[LicenseExpression, SpdxNone, SpdxNoAssertion]]]:
+        if not isinstance(license_expression_str_or_list, List):
             return self.parse_license_expression(license_expression_str_or_list)
+
         license_expressions = []
         logger = Logger()
         for license_expression_str in license_expression_str_or_list:
             try:
                 license_expressions = append_parsed_field_or_log_error(logger, license_expressions,
                                                                        license_expression_str,
                                                                        self.parse_license_expression)
-            except SPDXParsingError as err:
-                logger.append(err.get_messages())
+            except ExpressionError as err:
+                logger.append(err.args[0])
         raise_parsing_error_if_logger_has_messages(logger)
         return license_expressions
diff --git a/src/spdx/parser/jsonlikedict/package_parser.py b/src/spdx/parser/jsonlikedict/package_parser.py
@@ -12,7 +12,7 @@
 from typing import Dict, List, Optional, Union
 
 from spdx.model.actor import Actor
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression
 from spdx.model.package import Package, ExternalPackageRef, PackageVerificationCode, PackagePurpose, \
     ExternalPackageRefCategory
 from spdx.model.spdx_no_assertion import SpdxNoAssertion

diff --git a/src/spdx/parser/jsonlikedict/snippet_parser.py b/src/spdx/parser/jsonlikedict/snippet_parser.py
@@ -11,7 +11,7 @@
 from enum import auto, Enum
 from typing import Dict, Tuple, List, Optional, Union
 
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression
 from spdx.model.snippet import Snippet
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone

diff --git a/src/spdx/validation/license_expression_validator.py b/src/spdx/validation/license_expression_validator.py
@@ -11,7 +11,7 @@
 
 from typing import List, Optional, Union
 
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression
 from spdx.model.spdx_no_assertion import SpdxNoAssertion
 from spdx.model.spdx_none import SpdxNone
 from spdx.validation.validation_message import ValidationMessage

diff --git a/src/spdx/writer/tagvalue/file_writer.py b/src/spdx/writer/tagvalue/file_writer.py
@@ -11,9 +11,8 @@
 from typing import TextIO
 
 from spdx.model.file import File
-from spdx.writer.tagvalue.tagvalue_writer_helper_functions import write_value, write_text_value, \
-    write_license_expression
 from spdx.writer.tagvalue.checksum_writer import write_checksum_to_tag_value
+from spdx.writer.tagvalue.tagvalue_writer_helper_functions import write_value, write_text_value
 
 
 def write_file(file: File, text_output: TextIO):
@@ -28,8 +27,9 @@ def write_file(file: File, text_output: TextIO):
     for file_checksum in file.checksums:
         write_value("FileChecksum", write_checksum_to_tag_value(file_checksum), text_output)
 
-    write_license_expression("LicenseConcluded", file.license_concluded, text_output)
-    write_license_expression("LicenseInfoInFile", file.license_info_in_file, text_output)
+    write_value("LicenseConcluded", file.license_concluded, text_output)
+    for license_info in file.license_info_in_file:
+        write_value("LicenseInfoInFile", license_info, text_output)
     write_text_value("LicenseComments", file.license_comment, text_output)
     write_text_value("FileCopyrightText", file.copyright_text, text_output)
 

diff --git a/src/spdx/writer/tagvalue/package_writer.py b/src/spdx/writer/tagvalue/package_writer.py
@@ -12,9 +12,9 @@
 
 from spdx.datetime_conversions import datetime_to_iso_string
 from spdx.model.package import Package, PackageVerificationCode
-from spdx.writer.tagvalue.tagvalue_writer_helper_functions import write_value, write_text_value, \
-    write_license_expression, transform_enum_name_to_tv, write_actor
 from spdx.writer.tagvalue.checksum_writer import write_checksum_to_tag_value
+from spdx.writer.tagvalue.tagvalue_writer_helper_functions import write_value, write_text_value, \
+    transform_enum_name_to_tv, write_actor
 
 
 def write_package(package: Package, text_output: TextIO):
@@ -39,9 +39,10 @@ def write_package(package: Package, text_output: TextIO):
     write_value("PackageHomePage", package.homepage, text_output)
     write_text_value("PackageSourceInfo", package.source_info, text_output)
 
-    write_license_expression("PackageLicenseConcluded", package.license_concluded, text_output)
-    write_license_expression("PackageLicenseInfoFromFiles", package.license_info_from_files, text_output)
-    write_license_expression("PackageLicenseDeclared", package.license_declared, text_output)
+    write_value("PackageLicenseConcluded", package.license_concluded, text_output)
+    for license_info in package.license_info_from_files:
+        write_value("PackageLicenseInfoFromFiles", license_info, text_output)
+    write_value("PackageLicenseDeclared", package.license_declared, text_output)
     write_text_value("PackageLicenseComments", package.license_comment, text_output)
     write_text_value("PackageCopyrightText", package.copyright_text, text_output)
 

diff --git a/src/spdx/writer/tagvalue/snippet_writer.py b/src/spdx/writer/tagvalue/snippet_writer.py
@@ -11,8 +11,7 @@
 from typing import TextIO
 
 from spdx.model.snippet import Snippet
-from spdx.writer.tagvalue.tagvalue_writer_helper_functions import write_value, write_text_value, write_range, \
-    write_license_expression
+from spdx.writer.tagvalue.tagvalue_writer_helper_functions import write_value, write_text_value, write_range
 
 
 def write_snippet(snippet: Snippet, output_text: TextIO):
@@ -23,8 +22,9 @@ def write_snippet(snippet: Snippet, output_text: TextIO):
     write_range("SnippetByteRange", snippet.byte_range, output_text)
     write_range("SnippetLineRange", snippet.line_range, output_text)
 
-    write_license_expression("SnippetLicenseConcluded", snippet.license_concluded, output_text)
-    write_license_expression("LicenseInfoInSnippet", snippet.license_info_in_snippet, output_text)
+    write_value("SnippetLicenseConcluded", snippet.license_concluded, output_text)
+    for license_info in snippet.license_info_in_snippet:
+        write_value("LicenseInfoInSnippet", license_info, output_text)
     write_text_value("SnippetLicenseComments", snippet.license_comment, output_text)
     write_text_value("SnippetCopyrightText", snippet.copyright_text, output_text)
 

diff --git a/src/spdx/writer/tagvalue/tagvalue_writer_helper_functions.py b/src/spdx/writer/tagvalue/tagvalue_writer_helper_functions.py
@@ -12,7 +12,7 @@
 
 from spdx.model.actor import Actor
 from spdx.model.file import File
-from spdx.model.license_expression import LicenseExpression
+from license_expression import LicenseExpression
 from spdx.model.package import Package
 from spdx.model.relationship import Relationship
 from spdx.model.snippet import Snippet
@@ -25,7 +25,7 @@ def write_separator(out: TextIO):
 
 
 def write_value(tag: str, value: Optional[Union[bool, str, SpdxNone, SpdxNoAssertion]], out: TextIO):
-    if value:
+    if value is not None:
         out.write(f"{tag}: {value}\n")
 
 
@@ -65,17 +65,6 @@ def write_actor(tag: str, element_to_write: Optional[Union[Actor, SpdxNoAssertio
         write_value(tag, element_to_write, text_output)
 
 
-def write_license_expression(tag: str, element_to_write: Optional[Union[
-    List[LicenseExpression], LicenseExpression, SpdxNoAssertion, SpdxNone]], text_output: TextIO):
-    if isinstance(element_to_write, (SpdxNone, SpdxNoAssertion, str)):
-        write_value(tag, element_to_write, text_output)
-    elif isinstance(element_to_write, LicenseExpression):
-        write_value(tag, element_to_write.expression_string, text_output)
-    elif isinstance(element_to_write, list):
-        for element in element_to_write:
-            write_value(tag, element.expression_string, text_output)
-
-
 def scan_relationships(relationships: List[Relationship], packages: List[Package], files: List[File]) \
     -> Tuple[List, Dict]:
     contained_files_by_package_id = dict()