Merge branch 'case_sparql_select_add_json_output' into case_sparql_select_cross_json_and_anno_flag_testing

Author: ajnelson-nist

case_utils/case_sparql_select/__init__.py

@@ -123,6 +123,8 @@ def graph_and_query_to_data_frame(
 def data_frame_to_table_text(
     df: pd.DataFrame,
     *args: typing.Any,
+    json_indent: typing.Optional[int] = None,
+    json_orient: str,
     output_mode: str,
     use_header: bool,
     use_index: bool,
@@ -160,6 +162,12 @@ def data_frame_to_table_text(
         table_text = df.to_html(
             classes=("table", "table-bordered", "table-condensed"), **general_kwargs
         )
+    elif output_mode == "json":
+        # https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.to_json.html
+
+        table_text = df.to_json(
+            indent=json_indent, orient=json_orient, date_format="iso"
+        )
     elif output_mode == "md":
         # https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.to_markdown.html
         # https://pypi.org/project/tabulate/
@@ -199,14 +207,25 @@ def main() -> None:
         action="store_true",
         help="Raise error if no results are returned for query.",
     )
+    parser.add_argument(
+        "--json-indent",
+        type=int,
+        help="Number of whitespace characters to use for indentation.  Only applicable for JSON output.",
+    )
+    parser.add_argument(
+        "--json-orient",
+        default="columns",
+        choices=("columns", "index", "records", "split", "table", "values"),
+        help="Orientation to use for Pandas DataFrame JSON output.  Only applicable for JSON output.",
+    )
     parser.add_argument(
         "--use-prefixes",
         action="store_true",
         help="Abbreviate node IDs according to graph's encoded prefixes.  (This will use prefixes in the graph, not the query.)",
     )
     parser.add_argument(
         "out_table",
-        help="Expected extensions are .html for HTML tables, .md for Markdown tables, .csv for comma-separated values, and .tsv for tab-separated values.",
+        help="Expected extensions are .html for HTML tables, .json for JSON tables, .md for Markdown tables, .csv for comma-separated values, and .tsv for tab-separated values.  Note that JSON is a Pandas output JSON format (chosen by '--json-orient'), and not JSON-LD.",
     )
     parser.add_argument(
         "in_sparql",
@@ -293,6 +312,8 @@ def main() -> None:
 
     table_text = data_frame_to_table_text(
         df,
+        json_indent=args.json_indent,
+        json_orient=args.json_orient,
         output_mode=output_mode,
         use_header=use_header,
         use_index=use_index,

tests/case_utils/case_sparql_select/.check-prefixed_results-indented.json

@@ -0,0 +1,6 @@
+{
+    "?nFile":{
+        "0":"kb:file-1",
+        "1":"kb:file-2"
+    }
+}

tests/case_utils/case_sparql_select/.check-prefixed_results.json

@@ -0,0 +1 @@
+{"?nFile":{"0":"kb:file-1","1":"kb:file-2"}}

tests/case_utils/case_sparql_select/.check-w3-output-indented.json

@@ -0,0 +1,10 @@
+{
+    "?name":{
+        "0":"Johnny Lee Outlaw",
+        "1":"Peter Goodguy"
+    },
+    "?mbox":{
+        "0":"mailto:[email protected]",
+        "1":"mailto:[email protected]"
+    }
+}

tests/case_utils/case_sparql_select/.check-w3-output.json

@@ -0,0 +1 @@
+{"?name":{"0":"Johnny Lee Outlaw","1":"Peter Goodguy"},"?mbox":{"0":"mailto:[email protected]","1":"mailto:[email protected]"}}

tests/case_utils/case_sparql_select/.gitignore

@@ -1,3 +1,3 @@
 prefixed*
 subclass-*.md
-w3-output.*
+w3-output*

tests/case_utils/case_sparql_select/Makefile

@@ -20,12 +20,16 @@ tests_srcdir := $(top_srcdir)/tests
 all: \
   prefixed_results.csv \
   prefixed_results.html \
+  prefixed_results.json \
+  prefixed_results-indented.json \
   prefixed_results.md \
   prefixed_results.tsv \
   subclass-explicit-none.md \
   subclass-implicit-any.md \
   w3-output.csv \
   w3-output.html \
+  w3-output.json \
+  w3-output-indented.json \
   w3-output.md \
   w3-output.tsv
 
@@ -35,6 +39,8 @@ all: \
   check-subclass-implicit-any \
   check-w3-csv \
   check-w3-html \
+  check-w3-json \
+  check-w3-json-indented \
   check-w3-markdown \
   check-w3-tsv
 
@@ -46,6 +52,7 @@ all: \
 check: \
   check-w3-csv \
   check-w3-html \
+  check-w3-json \
   check-w3-markdown \
   check-w3-tsv \
   check-prefixed_results \
@@ -57,6 +64,7 @@ check: \
 check-prefixed_results: \
   check-prefixed_results-csv \
   check-prefixed_results-html \
+  check-prefixed_results-json \
   check-prefixed_results-md \
   check-prefixed_results-tsv
 
@@ -70,6 +78,19 @@ check-prefixed_results-html: \
   prefixed_results.html
 	diff $^
 
+check-prefixed_results-json: \
+  check-prefixed_results-json-indented \
+  .check-prefixed_results.json \
+  prefixed_results.json
+	diff \
+	  .check-prefixed_results.json \
+	  prefixed_results.json
+
+check-prefixed_results-json-indented: \
+  .check-prefixed_results-indented.json \
+  prefixed_results-indented.json
+	diff $^
+
 check-prefixed_results-md: \
   .check-prefixed_results.md \
   prefixed_results.md
@@ -104,6 +125,19 @@ check-w3-html: \
   w3-output.html
 	diff $^
 
+check-w3-json: \
+  .check-w3-output.json \
+  check-w3-json-indented \
+  w3-output.json
+	diff \
+	  .check-w3-output.json \
+	  w3-output.json
+
+check-w3-json-indented: \
+  .check-w3-output-indented.json \
+  w3-output-indented.json
+	diff $^
+
 check-w3-markdown: \
   .check-w3-output.md \
   w3-output.md
@@ -122,6 +156,7 @@ clean:
 	  *.html \
 	  *.md \
 	  *.tsv \
+	  *output*.json \
 	  _*
 
 prefixed_results.%: \
@@ -139,6 +174,22 @@ prefixed_results.%: \
 	    subclass.json
 	mv _$@ $@
 
+prefixed_results-indented.json: \
+  $(tests_srcdir)/.venv.done.log \
+  $(top_srcdir)/case_utils/case_sparql_select/__init__.py \
+  $(top_srcdir)/case_utils/ontology/__init__.py \
+  $(top_srcdir)/case_utils/ontology/version_info.py \
+  subclass.json \
+  subclass.sparql
+	source $(tests_srcdir)/venv/bin/activate \
+	  && case_sparql_select \
+	    --json-indent 4 \
+	    --use-prefixes \
+	    _$@ \
+	    subclass.sparql \
+	    subclass.json
+	mv _$@ $@
+
 subclass-explicit-none.md: \
   $(tests_srcdir)/.venv.done.log \
   $(top_srcdir)/case_utils/case_sparql_select/__init__.py \
@@ -183,3 +234,20 @@ w3-output.%: \
 	    w3-input-2.ttl \
 	    w3-input-3.json
 	mv _$@ $@
+
+w3-output-indented.json: \
+  $(tests_srcdir)/.venv.done.log \
+  $(top_srcdir)/case_utils/case_sparql_select/__init__.py \
+  $(top_srcdir)/case_utils/ontology/__init__.py \
+  $(top_srcdir)/case_utils/ontology/version_info.py \
+  w3-input-1.sparql \
+  w3-input-2.ttl \
+  w3-input-3.json
+	source $(tests_srcdir)/venv/bin/activate \
+	  && case_sparql_select \
+	    --json-indent 4 \
+	    _$@ \
+	    w3-input-1.sparql \
+	    w3-input-2.ttl \
+	    w3-input-3.json
+	mv _$@ $@