Merge JSON output and --no-(header,index) flag branches

ajnelson-nist · ajnelson-nist · commit ed44477f1ae3 · 2022-12-07T17:26:03.000-05:00
This patch addresses issues with some parameter-values being compatible
with some of the DataFrame table rendering functions, but not with
certain `orient` parameters of the JSON rendering function.  The
incompatible pairings are now caught at parameter-parsing time.

Signed-off-by: Alex Nelson &lt;alexander.nelson@nist.gov&gt;
diff --git a/case_utils/case_sparql_select/__init__.py b/case_utils/case_sparql_select/__init__.py
@@ -165,8 +165,11 @@ def data_frame_to_table_text(
     elif output_mode == "json":
         # https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.to_json.html
 
+        # Drop unsupported kwarg.
+        del general_kwargs["header"]
+
         table_text = df.to_json(
-            indent=json_indent, orient=json_orient, date_format="iso"
+            indent=json_indent, orient=json_orient, date_format="iso", **general_kwargs
         )
     elif output_mode == "md":
         # https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.to_markdown.html
@@ -253,7 +256,7 @@ def main() -> None:
     parser_index_group.add_argument(
         "--no-index",
         action="store_true",
-        help="Do not print index.",
+        help="Do not print index.  If output is JSON, --json-orient must be 'split' or 'table'.",
     )
 
     parser.add_argument("in_graph", nargs="+")
@@ -302,6 +305,15 @@ def main() -> None:
     else:
         use_index = True
 
+    if (
+        output_mode == "json"
+        and use_index is False
+        and args.json_orient not in {"split", "table"}
+    ):
+        raise ValueError(
+            "For JSON output, --no-index flag requires --json-orient to be either 'split' or 'table'."
+        )
+
     df = graph_and_query_to_data_frame(
         graph,
         select_query_text,
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-columns.json b/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-columns.json
@@ -0,0 +1 @@
+{"?name":{"0":"Johnny Lee Outlaw","1":"Peter Goodguy"},"?mbox":{"0":"mailto:jlow@example.com","1":"mailto:peter@example.org"}}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-index.json b/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-index.json
@@ -0,0 +1 @@
+{"0":{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},"1":{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-records.json b/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-records.json
@@ -0,0 +1 @@
+[{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-split.json b/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-split.json
@@ -0,0 +1 @@
+{"columns":["?name","?mbox"],"index":[0,1],"data":[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-table.json b/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-table.json
@@ -0,0 +1 @@
+{"schema":{"fields":[{"name":"index","type":"integer"},{"name":"?name","type":"string"},{"name":"?mbox","type":"string"}],"primaryKey":["index"],"pandas_version":"1.4.0"},"data":[{"index":0,"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"index":1,"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-values.json b/tests/case_utils/case_sparql_select/.check-w3-output-with_header-with_index-orient-values.json
@@ -0,0 +1 @@
+[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-with_header-without_index-orient-split.json b/tests/case_utils/case_sparql_select/.check-w3-output-with_header-without_index-orient-split.json
@@ -0,0 +1 @@
+{"columns":["?name","?mbox"],"data":[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-with_header-without_index-orient-table.json b/tests/case_utils/case_sparql_select/.check-w3-output-with_header-without_index-orient-table.json
@@ -0,0 +1 @@
+{"schema":{"fields":[{"name":"?name","type":"string"},{"name":"?mbox","type":"string"}],"pandas_version":"1.4.0"},"data":[{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-columns.json b/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-columns.json
@@ -0,0 +1 @@
+{"?name":{"0":"Johnny Lee Outlaw","1":"Peter Goodguy"},"?mbox":{"0":"mailto:jlow@example.com","1":"mailto:peter@example.org"}}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-index.json b/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-index.json
@@ -0,0 +1 @@
+{"0":{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},"1":{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-records.json b/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-records.json
@@ -0,0 +1 @@
+[{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-split.json b/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-split.json
@@ -0,0 +1 @@
+{"columns":["?name","?mbox"],"index":[0,1],"data":[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-table.json b/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-table.json
@@ -0,0 +1 @@
+{"schema":{"fields":[{"name":"index","type":"integer"},{"name":"?name","type":"string"},{"name":"?mbox","type":"string"}],"primaryKey":["index"],"pandas_version":"1.4.0"},"data":[{"index":0,"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"index":1,"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-values.json b/tests/case_utils/case_sparql_select/.check-w3-output-without_header-with_index-orient-values.json
@@ -0,0 +1 @@
+[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-without_header-without_index-orient-split.json b/tests/case_utils/case_sparql_select/.check-w3-output-without_header-without_index-orient-split.json
@@ -0,0 +1 @@
+{"columns":["?name","?mbox"],"data":[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]}
diff --git a/tests/case_utils/case_sparql_select/.check-w3-output-without_header-without_index-orient-table.json b/tests/case_utils/case_sparql_select/.check-w3-output-without_header-without_index-orient-table.json
@@ -0,0 +1 @@
+{"schema":{"fields":[{"name":"?name","type":"string"},{"name":"?mbox","type":"string"}],"pandas_version":"1.4.0"},"data":[{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]}
diff --git a/tests/case_utils/case_sparql_select/test_data_frame_to_table_text_json.py b/tests/case_utils/case_sparql_select/test_data_frame_to_table_text_json.py
@@ -37,36 +37,59 @@
 
 
 def make_data_frame_to_json_table_text_parameters() -> typing.Iterator[
-    typing.Tuple[str, bool, bool]
+    typing.Tuple[str, str, bool, bool]
 ]:
     for use_header in [False, True]:
         for use_index in [False, True]:
-            for output_mode in ["csv", "html", "md", "tsv"]:
-                yield (output_mode, use_header, use_index)
+            for output_mode in ["csv", "html", "json", "md", "tsv"]:
+                if output_mode == "json":
+                    for json_orient in [
+                        "columns",
+                        "index",
+                        "records",
+                        "split",
+                        "table",
+                        "values",
+                    ]:
+                        # Handle incompatible parameter pairings for JSON mode.
+                        if use_index is False:
+                            if json_orient not in {"split", "table"}:
+                                continue
+
+                        yield (json_orient, output_mode, use_header, use_index)
+                else:
+                    yield ("columns", output_mode, use_header, use_index)
 
 
 @pytest.mark.parametrize(
-    "output_mode, use_header, use_index",
+    "json_orient, output_mode, use_header, use_index",
     make_data_frame_to_json_table_text_parameters(),
 )
 def test_data_frame_to_table_text_json(
+    json_orient: str,
     output_mode: str,
     use_header: bool,
     use_index: bool,
 ) -> None:
     table_text = case_utils.case_sparql_select.data_frame_to_table_text(
         DATA_FRAME,
+        json_orient=json_orient,
         output_mode=output_mode,
         use_header=use_header,
         use_index=use_index,
     )
 
-    output_filename_template = ".check-w3-output-%s_header-%s_index.%s"
+    output_filename_template = ".check-w3-output-%s_header-%s_index%s.%s"
     header_part = "with" if use_header else "without"
     index_part = "with" if use_index else "without"
+    if output_mode == "json":
+        json_orient_part = "-orient-" + json_orient
+    else:
+        json_orient_part = ""
     output_filename = output_filename_template % (
         header_part,
         index_part,
+        json_orient_part,
         output_mode,
     )
     with (SRCDIR / output_filename).open("w") as out_fh:

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"?name":{"0":"Johnny Lee Outlaw","1":"Peter Goodguy"},"?mbox":{"0":"mailto:jlow@example.com","1":"mailto:peter@example.org"}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"0":{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},"1":{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+[{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"columns":["?name","?mbox"],"index":[0,1],"data":[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"schema":{"fields":[{"name":"index","type":"integer"},{"name":"?name","type":"string"},{"name":"?mbox","type":"string"}],"primaryKey":["index"],"pandas_version":"1.4.0"},"data":[{"index":0,"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"index":1,"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"columns":["?name","?mbox"],"data":[["Johnny Lee Outlaw","mailto:jlow@example.com"],["Peter Goodguy","mailto:peter@example.org"]]}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"schema":{"fields":[{"name":"?name","type":"string"},{"name":"?mbox","type":"string"}],"pandas_version":"1.4.0"},"data":[{"?name":"Johnny Lee Outlaw","?mbox":"mailto:jlow@example.com"},{"?name":"Peter Goodguy","?mbox":"mailto:peter@example.org"}]}`