Merge pull request #1 from paulgibert/fast-paulgibert

Created a document cache decorator and handled Relationships as tuple…

Author: jonjohnsonjr

src/spdx_tools/common/typing/dataclass_with_properties.py

@@ -1,12 +1,16 @@
 # SPDX-FileCopyrightText: 2022 spdx contributors
 #
 # SPDX-License-Identifier: Apache-2.0
-from dataclasses import dataclass
+from dataclasses import dataclass, astuple
 
 from beartype import beartype
 from beartype.roar import BeartypeCallHintException
 
 
+def freeze_dataclass_with_properties_list(items):
+    return {astuple(itm) for itm in items}
+
+
 def dataclass_with_properties(cls):
     """Decorator to generate a dataclass with properties out of the class' value:type list.
     Their getters and setters will be subjected to the @typechecked decorator to ensure type conformity."""

src/spdx_tools/spdx/model/document.py

@@ -1,7 +1,7 @@
 # SPDX-FileCopyrightText: 2022 spdx contributors
 #
 # SPDX-License-Identifier: Apache-2.0
-from dataclasses import field
+from dataclasses import field, astuple
 from datetime import datetime
 
 from beartype.typing import List, Optional
@@ -82,5 +82,17 @@ def __init__(
         extracted_licensing_info = [] if extracted_licensing_info is None else extracted_licensing_info
         check_types_and_set_values(self, locals())
 
-    def __hash__(self):
-        return id(self)
+
+def document_cache(func):
+    cache = {}
+
+    def cached_function(document: Document):
+        key = id(document)
+        if key in cache.keys():
+            return cache[key]
+        else:
+            value = func(document)
+            cache[key] = value
+            return value
+    
+    return cached_function

src/spdx_tools/spdx/model/relationship.py

@@ -73,6 +73,3 @@ def __init__(
         comment: Optional[str] = None,
     ):
         check_types_and_set_values(self, locals())
-
-    def __hash__(self):
-        return hash("{} -> {} ({})".format(self.spdx_element_id, str(self.related_spdx_element_id), str(self.relationship_type)))

src/spdx_tools/spdx/parser/jsonlikedict/relationship_parser.py

@@ -1,9 +1,12 @@
 # SPDX-FileCopyrightText: 2022 spdx contributors
 #
 # SPDX-License-Identifier: Apache-2.0
+from dataclasses import astuple
+
 from beartype.typing import Dict, List, Optional, Set
 
 from spdx_tools.common.typing.constructor_type_errors import ConstructorTypeErrors
+from spdx_tools.common.typing.dataclass_with_properties import freeze_dataclass_with_properties_list
 from spdx_tools.spdx.model import Relationship, RelationshipType
 from spdx_tools.spdx.parser.error import SPDXParsingError
 from spdx_tools.spdx.parser.jsonlikedict.dict_parsing_functions import (
@@ -35,9 +38,12 @@ def parse_all_relationships(self, input_doc_dict: Dict) -> List[Relationship]:
         document_describes: List[str] = delete_duplicates_from_list(input_doc_dict.get("documentDescribes", []))
         doc_spdx_id: Optional[str] = input_doc_dict.get("SPDXID")
 
-        existing_relationships_without_comments: Set[Relationship] = set(self.get_all_relationships_without_comments(
-            relationships
-        ))
+        relationship_hash = lambda r: hash("{} -> {} ({})" \
+                .format(r.spdx_element_id,
+                        str(r.related_spdx_element_id),
+                        str(r.relationship_type)))
+        existing_relationships_without_comments: Set[Relationship] = freeze_dataclass_with_properties_list(
+                self.get_all_relationships_without_comments(relationships))
         relationships.extend(
             parse_field_or_log_error(
                 self.logger,
@@ -161,10 +167,10 @@ def check_if_relationship_exists(
         self, relationship: Relationship, existing_relationships: Set[Relationship]
     ) -> bool:
         # assume existing relationships are stripped of comments
-        if relationship in existing_relationships:
+        if astuple(relationship) in existing_relationships:
             return True
         relationship_inverted: Relationship = self.invert_relationship(relationship)
-        if relationship_inverted in existing_relationships:
+        if astuple(relationship_inverted) in existing_relationships:
             return True
 
         return False

src/spdx_tools/spdx/validation/spdx_id_validators.py

@@ -10,6 +10,7 @@
 
 from spdx_tools.spdx.document_utils import get_contained_spdx_element_ids
 from spdx_tools.spdx.model import Document, File
+from spdx_tools.spdx.model.document import document_cache
 
 
 def is_valid_internal_spdx_id(spdx_id: str) -> bool:
@@ -24,13 +25,13 @@ def is_spdx_id_present_in_files(spdx_id: str, files: List[File]) -> bool:
     return spdx_id in [file.spdx_id for file in files]
 
 
-@cache
+# @cache
 def is_spdx_id_present_in_document(spdx_id: str, document: Document) -> bool:
     all_spdx_ids_in_document: Set[str] = get_set_of_all_spdx_ids(document)
 
     return spdx_id in all_spdx_ids_in_document
 
-@cache
+@document_cache
 def get_set_of_all_spdx_ids(document: Document) -> Set[str]:
     return set(get_list_of_all_spdx_ids(document))