spdx_tools.spdx.parser.jsonlikedict.json_like_dict_parser

 1# SPDX-FileCopyrightText: 2022 spdx contributors
 2#
 3# SPDX-License-Identifier: Apache-2.0
 4from beartype.typing import Dict
 5
 6from spdx_tools.spdx.model import Document
 7from spdx_tools.spdx.parser.error import SPDXParsingError
 8from spdx_tools.spdx.parser.jsonlikedict.annotation_parser import AnnotationParser
 9from spdx_tools.spdx.parser.jsonlikedict.creation_info_parser import CreationInfoParser
10from spdx_tools.spdx.parser.jsonlikedict.dict_parsing_functions import parse_list_of_elements
11from spdx_tools.spdx.parser.jsonlikedict.extracted_licensing_info_parser import ExtractedLicensingInfoParser
12from spdx_tools.spdx.parser.jsonlikedict.file_parser import FileParser
13from spdx_tools.spdx.parser.jsonlikedict.package_parser import PackageParser
14from spdx_tools.spdx.parser.jsonlikedict.relationship_parser import RelationshipParser
15from spdx_tools.spdx.parser.jsonlikedict.snippet_parser import SnippetParser
16from spdx_tools.spdx.parser.logger import Logger
17from spdx_tools.spdx.parser.parsing_functions import (
18    construct_or_raise_parsing_error,
19    raise_parsing_error_if_logger_has_messages,
20)
21
22
23class JsonLikeDictParser:
24    logger: Logger
25    creation_info_parser: CreationInfoParser
26    package_parser: PackageParser
27    file_parser: FileParser
28    snippet_parser: SnippetParser
29    extracted_licensing_info_parser: ExtractedLicensingInfoParser
30    relationship_parser: RelationshipParser
31    annotation_parser: AnnotationParser
32
33    def __init__(self):
34        self.logger = Logger()
35        self.creation_info_parser = CreationInfoParser()
36        self.package_parser = PackageParser()
37        self.file_parser = FileParser()
38        self.snippet_parser = SnippetParser()
39        self.extracted_licensing_info_parser = ExtractedLicensingInfoParser()
40        self.relationship_parser = RelationshipParser()
41        self.annotation_parser = AnnotationParser()
42
43    def parse(self, json_like_dict: Dict) -> Document:
44        fields_to_parse = [
45            ("creation_info", json_like_dict, self.creation_info_parser.parse_creation_info, False),
46            (
47                "packages",
48                json_like_dict.get("packages"),
49                lambda x: parse_list_of_elements(x, self.package_parser.parse_package, self.package_parser.logger),
50                True,
51            ),
52            (
53                "files",
54                json_like_dict.get("files"),
55                lambda x: parse_list_of_elements(x, self.file_parser.parse_file, self.file_parser.logger),
56                True,
57            ),
58            ("annotations", json_like_dict, self.annotation_parser.parse_all_annotations, True),
59            (
60                "snippets",
61                json_like_dict.get("snippets"),
62                lambda x: parse_list_of_elements(x, self.snippet_parser.parse_snippet, self.snippet_parser.logger),
63                True,
64            ),
65            ("relationships", json_like_dict, self.relationship_parser.parse_all_relationships, True),
66            (
67                "extracted_licensing_info",
68                json_like_dict.get("hasExtractedLicensingInfos"),
69                lambda x: parse_list_of_elements(
70                    x,
71                    self.extracted_licensing_info_parser.parse_extracted_licensing_info,
72                    self.extracted_licensing_info_parser.logger,
73                ),
74                True,
75            ),
76        ]
77
78        parsed_fields = {}
79
80        for argument_name, field, parsing_method, optional in fields_to_parse:
81            if optional and not field:
82                continue
83            try:
84                parsed_fields[argument_name] = parsing_method(field)
85            except SPDXParsingError as err:
86                self.logger.extend(err.get_messages())
87
88        raise_parsing_error_if_logger_has_messages(self.logger)
89
90        document = construct_or_raise_parsing_error(Document, parsed_fields)
91
92        return document