Add methods to serialize SPDX documents to a stream object rather than always expecting a file name

Signed-off-by: Holger Frydrych <holger.frydrych@tngtech.com>

Author: fholger

src/spdx_tools/spdx/writer/json/json_writer.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 import json
 
-from beartype.typing import List
+from beartype.typing import List, IO
 
 from spdx_tools.spdx.document_utils import create_document_without_duplicates
 from spdx_tools.spdx.jsonschema.document_converter import DocumentConverter
@@ -12,9 +12,9 @@
 from spdx_tools.spdx.validation.validation_message import ValidationMessage
 
 
-def write_document_to_file(
+def write_document_to_stream(
     document: Document,
-    file_name: str,
+    stream: IO[str],
     validate: bool = True,
     converter: DocumentConverter = None,
     drop_duplicates: bool = True,
@@ -33,5 +33,15 @@ def write_document_to_file(
     if converter is None:
         converter = DocumentConverter()
     document_dict = converter.convert(document)
+    json.dump(document_dict, stream, indent=4)
+
+
+def write_document_to_file(
+    document: Document,
+    file_name: str,
+    validate: bool = True,
+    converter: DocumentConverter = None,
+    drop_duplicates: bool = True,
+):
     with open(file_name, "w") as out:
-        json.dump(document_dict, out, indent=4)
+        write_document_to_stream(document, out, validate, converter, drop_duplicates)

src/spdx_tools/spdx/writer/rdf/rdf_writer.py

@@ -1,7 +1,7 @@
 # SPDX-FileCopyrightText: 2023 spdx contributors
 #
 # SPDX-License-Identifier: Apache-2.0
-from beartype.typing import Dict, List
+from beartype.typing import Dict, List, IO
 from rdflib import DOAP, Graph
 from rdflib.compare import to_isomorphic
 
@@ -19,7 +19,7 @@
 from spdx_tools.spdx.writer.rdf.snippet_writer import add_snippet_to_graph
 
 
-def write_document_to_file(document: Document, file_name: str, validate: bool, drop_duplicates: bool = True):
+def write_document_to_stream(document: Document, stream: IO[bytes], validate: bool, drop_duplicates: bool = True):
     if validate:
         validation_messages: List[ValidationMessage] = validate_full_spdx_document(document)
         if validation_messages:
@@ -55,4 +55,9 @@ def write_document_to_file(document: Document, file_name: str, validate: bool, d
     graph.bind("spdx", SPDX_NAMESPACE)
     graph.bind("doap", DOAP)
     graph.bind("ptr", POINTER_NAMESPACE)
-    graph.serialize(file_name, "pretty-xml", encoding="UTF-8", max_depth=100)
+    graph.serialize(stream, "pretty-xml", encoding="UTF-8", max_depth=100)
+
+
+def write_document_to_file(document: Document, file_name: str, validate: bool, drop_duplicates: bool = True):
+    with open(file_name, "wb") as out:
+        write_document_to_stream(document, out, validate, drop_duplicates)

src/spdx_tools/spdx/writer/tagvalue/tagvalue_writer.py

@@ -30,16 +30,20 @@
 )
 
 
-def write_document_to_file(document: Document, file_name: str, validate: bool = True, drop_duplicates: bool = True):
+def write_document_to_stream(document: Document, stream: TextIO, validate: bool = True, drop_duplicates: bool = True):
     if validate:
         validation_messages: List[ValidationMessage] = validate_full_spdx_document(document)
         if validation_messages:
             raise ValueError(f"Document is not valid. The following errors were detected: {validation_messages}")
     if drop_duplicates:
         document = create_document_without_duplicates(document)
 
+    write_document(document, stream)
+
+
+def write_document_to_file(document: Document, file_name: str, validate: bool = True, drop_duplicates: bool = True):
     with open(file_name, "w") as out:
-        write_document(document, out)
+        write_document_to_stream(document, out, validate, drop_duplicates)
 
 
 def write_document(document: Document, text_output: TextIO):

src/spdx_tools/spdx/writer/xml/xml_writer.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 import xmltodict
-from beartype.typing import List
+from beartype.typing import List, IO
 
 from spdx_tools.spdx.document_utils import create_document_without_duplicates
 from spdx_tools.spdx.jsonschema.document_converter import DocumentConverter
@@ -11,9 +11,9 @@
 from spdx_tools.spdx.validation.validation_message import ValidationMessage
 
 
-def write_document_to_file(
+def write_document_to_stream(
     document: Document,
-    file_name: str,
+    stream: IO[str],
     validate: bool = True,
     converter: DocumentConverter = None,
     drop_duplicates: bool = True,
@@ -33,5 +33,15 @@ def write_document_to_file(
     if converter is None:
         converter = DocumentConverter()
     document_dict = {"Document": converter.convert(document)}
+    xmltodict.unparse(document_dict, stream, encoding="utf-8", pretty=True)
+
+
+def write_document_to_file(
+    document: Document,
+    file_name: str,
+    validate: bool = True,
+    converter: DocumentConverter = None,
+    drop_duplicates: bool = True,
+):
     with open(file_name, "w") as out:
-        xmltodict.unparse(document_dict, out, encoding="utf-8", pretty=True)
+        write_document_to_stream(document, out, validate, converter, drop_duplicates)

src/spdx_tools/spdx/writer/yaml/yaml_writer.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 import yaml
-from beartype.typing import List
+from beartype.typing import List, IO
 
 from spdx_tools.spdx.document_utils import create_document_without_duplicates
 from spdx_tools.spdx.jsonschema.document_converter import DocumentConverter
@@ -11,9 +11,9 @@
 from spdx_tools.spdx.validation.validation_message import ValidationMessage
 
 
-def write_document_to_file(
+def write_document_to_stream(
     document: Document,
-    file_name: str,
+    stream: IO[str],
     validate: bool = True,
     converter: DocumentConverter = None,
     drop_duplicates: bool = True,
@@ -32,5 +32,15 @@ def write_document_to_file(
     if converter is None:
         converter = DocumentConverter()
     document_dict = converter.convert(document)
+    yaml.safe_dump(document_dict, stream, indent=2)
+
+
+def write_document_to_file(
+    document: Document,
+    file_name: str,
+    validate: bool = True,
+    converter: DocumentConverter = None,
+    drop_duplicates: bool = True,
+):
     with open(file_name, "w") as out:
-        yaml.safe_dump(document_dict, out, indent=2)
+        write_document_to_stream(document, out, validate, converter, drop_duplicates)