[review] use --graph as flag and save the generated graph to --outfile

meretp · meretp · commit d596d5b259df · 2023-04-05T12:56:37.000+02:00
Signed-off-by: Meret Behrens &lt;meret.behrens@tngtech.com&gt;
diff --git a/README.md b/README.md
@@ -86,10 +86,10 @@ instead of `bin`.
   relationships. The graph can be rendered to a picture. Below is an example for the file `tests/data/formats/SPDXJSONExample-v2.3.spdx.json`:
 ![SPDXJSONExample-v2.3.spdx.png](assets/SPDXJSONExample-v2.3.spdx.png)
 * Make sure you install the optional dependencies `networkx` and `pygraphviz`. To do so run `pip install ".[graph_generation]"`.
-* Use `pyspdxtools -i <input_file> --generate_graph <output_file>` where `<output_file>` is an output file name with valid format for `pygraphviz` (check 
+* Use `pyspdxtools -i <input_file> --graph -o <output_file>` where `<output_file>` is an output file name with valid format for `pygraphviz` (check 
   the documentation [here](https://pygraphviz.github.io/documentation/stable/reference/agraph.html#pygraphviz.AGraph.draw)). 
 * If you are using a source distribution, try running
-  `pyspdxtools -i tests/data/formats/SPDXJSONExample-v2.3.spdx.json --generate_graph SPDXJSONExample-v2.3.spdx.png` to generate 
+  `pyspdxtools -i tests/data/formats/SPDXJSONExample-v2.3.spdx.json --graph -o SPDXJSONExample-v2.3.spdx.png` to generate 
   a png with an overview of the structure of the example file.  
 
 ## Library usage
diff --git a/src/spdx/clitools/pyspdxtools.py b/src/spdx/clitools/pyspdxtools.py
@@ -33,7 +33,8 @@
 @click.option(
     "--outfile",
     "-o",
-    help="The file to write the converted document to (write a dash for output to stdout or omit for no conversion).",
+    help="The file to write the converted document to (write a dash for output to stdout or omit for no conversion). "
+    "If you add the option --graph to the command the generated graph will be written to this file.",
 )
 @click.option(
     "--version",
@@ -43,12 +44,14 @@
 )
 @click.option("--novalidation", is_flag=True, help="Don't validate the provided document.")
 @click.option(
-    "--generate_graph",
-    default="",
-    help="The file to write the structure of the spdx document as a pygraphviz AGraph to. Note: You need to install"
-    " the optional dependencies 'networkx' and 'pygraphviz' for this feature.",
+    "--graph",
+    is_flag=True,
+    default=False,
+    help="Generate a relationship graph from the input file. "
+    "The generated graph is saved to the file specified with --outfile. "
+    "Note: You need to install the optional dependencies 'networkx' and 'pygraphviz' for this feature.",
 )
-def main(infile: str, outfile: str, version: str, novalidation: bool, generate_graph: str):
+def main(infile: str, outfile: str, version: str, novalidation: bool, graph: bool):
     """
     CLI-tool for validating SPDX documents and converting between RDF, TAG-VALUE, JSON, YAML and XML formats.
     Formats are determined by the file endings.
@@ -57,9 +60,6 @@ def main(infile: str, outfile: str, version: str, novalidation: bool, generate_g
     try:
         document: Document = parse_file(infile)
 
-        if outfile == "-":
-            tagvalue_writer.write_document(document, sys.stdout)
-
         if not novalidation:
             if not version:
                 version = document.creation_info.spdx_version
@@ -79,19 +79,22 @@ def main(infile: str, outfile: str, version: str, novalidation: bool, generate_g
             else:
                 logging.info("The document is valid.")
 
-        if outfile and outfile != "-":
-            write_file(document, outfile, validate=False)
+        if outfile == "-":
+            tagvalue_writer.write_document(document, sys.stdout)
 
-        if generate_graph:
+        elif graph:
             try:
-                export_graph_from_document(document, generate_graph)
+                export_graph_from_document(document, outfile)
             except ImportError:
                 logging.error(
                     "To be able to draw a relationship graph of the parsed document "
                     "you need to install 'networkx' and 'pygraphviz'. Run 'pip install \".[graph_generation]\"'."
                 )
                 sys.exit(1)
 
+        elif outfile:
+            write_file(document, outfile, validate=False)
+
     except NotImplementedError as err:
         logging.error(
             err.args[0]
