Address review comments

Signed-off-by: Holger Frydrych <[email protected]>

Author: fholger

examples/spdx2_convert_format.py

@@ -3,14 +3,15 @@
 #  SPDX-License-Identifier: Apache-2.0
 from os import path
 
+from spdx_tools.spdx.model import Document
 from spdx_tools.spdx.writer.write_anything import write_file
 from spdx_tools.spdx.parser.parse_anything import parse_file
 
 # This example demonstrates how to load an existing SPDX2 file and convert it to a different SPDX2 format
 
-# Provide a path to the input file in tagvalue format
+# Provide a path to the input file in the originating format
 input_path = path.join(path.dirname(__file__), "..", "tests", "spdx", "data", "SPDXLite.spdx")
-# Parse the original input file
-document = parse_file(input_path)
-# Write to XML file format
+# Parse the original input file (format is deduced automatically from the file extension)
+document: Document = parse_file(input_path)
+# Write to a different file format (e.g. XML, format is deduced automatically from the file extension)
 write_file(document, "converted_format.xml")

examples/spdx2_convert_to_spdx3.py

@@ -3,19 +3,19 @@
 #  SPDX-License-Identifier: Apache-2.0
 from os import path
 
+from spdx_tools.spdx.model import Document
+from spdx_tools.spdx3.payload import Payload
 from spdx_tools.spdx3.writer.json_ld.json_ld_writer import write_payload
-
 from spdx_tools.spdx3.bump_from_spdx2.spdx_document import bump_spdx_document
-
 from spdx_tools.spdx.parser.parse_anything import parse_file
 
 # This example demonstrates how to load an existing SPDX2 file and convert it to the SPDX3 format
 
 # Provide a path to the input file
 input_path = path.join(path.dirname(__file__), "..", "tests", "spdx", "data", "SPDXLite.spdx")
 # Parse the original SPDX2 input file
-spdx2_document = parse_file(input_path)
+spdx2_document: Document = parse_file(input_path)
 # Convert original document to an SPDX3 payload
-spdx3_payload = bump_spdx_document(spdx2_document)
+spdx3_payload: Payload = bump_spdx_document(spdx2_document)
 # Write SPDX3 payload in json-ld format
 write_payload(spdx3_payload, "spdx2_to_3")

examples/spdx2_generate_graph.py

@@ -4,13 +4,14 @@
 from os import path
 
 from spdx_tools.spdx.graph_generation import export_graph_from_document
+from spdx_tools.spdx.model import Document
 from spdx_tools.spdx.parser.parse_anything import parse_file
 
 # This example demonstrates how to generate a relationship graph for an SPDX2 document
 
 # Provide a path to the input file
 input_path = path.join(path.dirname(__file__), "..", "tests", "spdx", "data", "SPDXJSONExample-v2.3.spdx.json")
 # Parse the file
-document = parse_file(input_path)
-# Generate the graph (note: you need to have installed the optional dependency networkx, pygraphviz)
+document: Document = parse_file(input_path)
+# Generate the graph (note: you need to have installed the optional dependencies networkx and pygraphviz)
 export_graph_from_document(document, "graph.png")

examples/spdx2_parse_file.py

@@ -12,10 +12,9 @@
 
 # Provide a path to the input file
 input_path = path.join(path.dirname(__file__), "..", "tests", "spdx", "data", "SPDXLite.spdx")
-document: Document
 try:
     # Try to parse the input file. If successful, returns a Document, otherwise raises an SPDXParsingError
-    document = parse_file(input_path)
+    document: Document = parse_file(input_path)
 except SPDXParsingError:
     logging.exception("Failed to parse spdx file")