Merge pull request #244 from oslokommune/csv-output

Add new output format option for printing CSV

Author: simenheg

CHANGELOG.md

@@ -9,6 +9,7 @@
 * Streamlined output in the dataset listing commands.
 * New option `--verbose` for the `datasets ls` command which lists every
   relevant metadata field for the listed datasets.
+* New output format option for printing CSV: `--format=csv`.
 
 ## 4.4.0 - 2025-05-14
 

doc/datasets.md

@@ -208,7 +208,7 @@ uploaded=false
 echo "Checking status for uploaded file"
 while ! $uploaded; do
   echo "\Checking upload status..."
-  upload_status=`okdaata status $trace_id --format=json`
+  upload_status=`okdata status $trace_id --format=json`
   uploaded=`echo $upload_status | jq -r '.done'`
 done
 echo "Uploaded file is processed and ready to be consumed"

okdata/cli/command.py

@@ -79,8 +79,9 @@ def handle_input(self):
         return content
 
     def print(self, str, payload=None):
-        is_json = self.opt("format") == "json"
-        if not is_json:
+        is_structured_data = self.opt("format") in ("csv", "json")
+
+        if not is_structured_data:
             print(str)
         # Normally a return json value from the API
         if payload:

okdata/cli/commands/datasets/datasets.py

@@ -38,6 +38,7 @@ class DatasetsCommand(BaseCommand):
   okdata datasets ls my-dataset --verbose
   okdata datasets ls my-dataset/1
   okdata datasets ls my-dataset/1/20240101T102030
+  okdata datasets ls my-dataset/1/20240101T102030 --format=csv
   okdata datasets ls my-dataset/1/20240101T102030 --format=json
   okdata datasets create --file=dataset.json
   okdata datasets cp /tmp/file.csv ds:my-dataset-id

okdata/cli/output.py

@@ -1,3 +1,5 @@
+import csv
+import io
 import json
 import logging
 import os
@@ -9,25 +11,28 @@
 log = logging.getLogger()
 
 
-def get_script_path():
+def _get_script_path():
     return os.path.dirname(__file__)
 
 
-# Create a output printer
-#
-# Formatting of output is defined in okdata/cli/data/ouput-format.
-# Each command defines what (from the API response) should be printed, and
-# what the human-readable name should be
-def create_output(format, configfile):
-    datadir = f"{get_script_path()}/data/output-format"
-    filename = f"{datadir}/{configfile}"
-    log.info(f"Creating output format: {format}, from: {filename}")
-    with open(filename) as config_file:
-        config = json.load(config_file)
+def create_output(fmt, config_file):
+    """Create and return an output printer.
 
-    if format == "json":
-        return JsonOutput(config)
-    return TableOutput(config)
+    Formatting of output is defined in the `okdata/cli/data/ouput-format`
+    directory. Each command defines which fields from the API response should
+    be printed, and what the human-readable name should be.
+    """
+    datadir = f"{_get_script_path()}/data/output-format"
+    filename = f"{datadir}/{config_file}"
+    log.info(f"Creating output format: {fmt}, from: {filename}")
+
+    with open(filename) as f:
+        config = json.load(f)
+
+    return {
+        "json": JsonOutput(config),
+        "csv": CSVOutput(config),
+    }.get(fmt, TableOutput(config))
 
 
 class TableOutput(PrettyTable):
@@ -104,13 +109,9 @@ def format_cell_value(value, max_width):
         return value
 
 
-# TODO: merge many outputs to one array of elements when listing a version
-class JsonOutput:
+class StructuredDataOutput:
     def __init__(self, config):
         self.config = config
-        # set to True it will return a single object from self.out when printed. This will make it
-        # easier to pass output to jq without having to access out[0] from the CLI
-        self.output_singular_object = False
         self.out = []
 
     def field_values(self, row, row_key, key):
@@ -144,6 +145,36 @@ def add_rows(self, rows):
         for row in rows:
             self.add_row(row)
 
+    def __str__(self):
+        raise NotImplementedError
+
+
+class CSVOutput(StructuredDataOutput):
+    def __str__(self):
+        out = io.StringIO()
+        writer = csv.DictWriter(out, self.out[0].keys())
+        writer.writeheader()
+        writer.writerows(self.out)
+        return out.getvalue()
+
+    def get_row_value(self, row, key):
+        val = super().get_row_value(row, key)
+
+        if isinstance(val, str):
+            return val.replace("\n", "")
+        elif isinstance(val, list):
+            return ";".join(val)
+        return val
+
+
+# TODO: merge many outputs to one array of elements when listing a version
+class JsonOutput(StructuredDataOutput):
+    def __init__(self, config):
+        super().__init__(config)
+        # set to True it will return a single object from self.out when printed. This will make it
+        # easier to pass output to jq without having to access out[0] from the CLI
+        self.output_singular_object = False
+
     def __repr__(self):
         return json.dumps(self.out)