Add json encoder for virtual table lines and option to print json

... instead of pretty printed table. Introduced --print-json option

Also, apply --print-json option for data tree

Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>

Author: bhufmann

README.md

@@ -178,6 +178,8 @@ optional arguments:
                         The output ID
   --json-file JSON_FILE
                         JSON file with parameter
+  --print-json
+                        Print JSON representation of model instead of pretty-format (for some replies only)
 ```
 
 Examples:

tsp/entry_model.py

@@ -60,12 +60,15 @@ def __init__(self, params, model_type=ModelType.XY_TREE):
 
     def __repr__(self) -> str:
         return 'EntryModel({})'.format(', '.join(str(entry) for entry in self.entries))
+    
+    def to_json(self):
+        return json.dumps(self, cls=EntryModelEncoder, indent=4)
 
 class EntryModelEncoder(json.JSONEncoder):
     def default(self, obj):
         if isinstance(obj, EntryModel):
             return {
-                'headers': [EntryHeaderEncoder().default(header) for header in obj.headers],
-                'entries': [TimeGraphEntryEncoder().default(entry) if isinstance(entry, TimeGraphEntry) else EntryEncoder().default(entry) for entry in obj.entries]
+                HEADER_KEY: [EntryHeaderEncoder().default(header) for header in obj.headers],
+                ENTRIES_KEY: [TimeGraphEntryEncoder().default(entry) if isinstance(entry, TimeGraphEntry) else EntryEncoder().default(entry) for entry in obj.entries]
             }
         return super().default(obj)

tsp/virtual_table_model.py

@@ -22,6 +22,7 @@
 
 """VirtualTableModel class file."""
 
+import json
 from tsp.virtual_table_tag import VirtualTableTag
 
 SIZE_KEY = "size"
@@ -71,6 +72,9 @@ def __init__(self, params):
                 self.lines.append(VirtualTableLine(line))
             del params[LINES_KEY]
 
+    def to_json(self):
+        return json.dumps(self, cls=VirtualTableModelEncoder, indent=4)
+
     def print(self):
         print("VirtualTableModel:")
         print(f"  size: {self.size}")
@@ -81,6 +85,17 @@ def print(self):
         for i, line in enumerate(self.lines):
             line.print()
 
+class VirtualTableModelEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, VirtualTableModel):
+            result = {}
+            result[SIZE_KEY] = obj.size
+            result[LOW_INDEX_KEY] = obj.low_index
+            result[COLUMN_IDS_KEY] = obj.column_ids
+            result[LINES_KEY] = [ VirtualTableLineEncoder().default(line) for line in obj.lines ]
+            return result
+        return super().default(obj)
+
 class VirtualTableLine:
     '''
     Virtual table line that will be returned by the server
@@ -122,6 +137,9 @@ def __init__(self, params):
     def has_tag(self, tag):
         return bool(self.tags & tag)
 
+    def to_json(self):
+        return json.dumps(self, cls=VirtualTableLineEncoder, indent=4)
+
     def print(self):
 
         print(f"    index: {self.index}")
@@ -138,6 +156,16 @@ def print(self):
             cell.print()
         print(f"    {'-' * 30}")
 
+class VirtualTableLineEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, VirtualTableLine):
+            result = {}
+            result[TABLE_LINE_INDEX_KEY] = obj.index
+            result[TAGS_KEY] = obj.tags.value
+            result[TABLE_LINE_CELLS_KEY] = [ VirtualTableLineCellEncoder().default(cell) for cell in obj.cells ]
+            return result
+        return super().default(obj)
+
 class VirtualTableLineCell:
     '''
     Virtual table line cell that will be returned by the server
@@ -180,4 +208,16 @@ def print(self):
             tags_str = " | ".join(active_tags)
 
         print(f"    \"tags\": \"{tags_str}\"")
-        print(f"    {'-' * 10}")
+        print(f"    {'-' * 10}")
+    
+    def to_json(self):
+        return json.dumps(self, cls=VirtualTableLineCell, indent=4)
+
+class VirtualTableLineCellEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, VirtualTableLineCell):
+            return {
+                TABLE_LINE_CELL_CONTENT_KEY: obj.content,
+                TAGS_KEY: obj.tags.value
+            }
+        return super().default(obj)

tsp_cli_client

@@ -87,6 +87,10 @@ def __get_tree(uuid, outputid, treetype):
                 print("Tree had no model; retry?")
                 sys.exit(1)
 
+            if (options.print_json):
+                print(tree.to_json())
+                sys.exit(0)
+
             tree_model = TreeModel(tree.entries, tree.headers)
             tree_model.print()
             sys.exit(0)
@@ -221,6 +225,8 @@ if __name__ == "__main__":
     parser.add_argument("--delete-output", dest="delete_output", help="Delete derived output", metavar="DERIVED_OUTPUT_ID")
     parser.add_argument("--output-id", dest="output_id", help="The output ID")
     parser.add_argument("--json-file", dest="json_file", help="JSON file with parameter")
+    parser.add_argument("--print-json", action='store_true', dest="print_json", help="Print JSON representation of model instead of pretty-format (for some replies only)")
+
 
     argcomplete.autocomplete(parser)
     options = parser.parse_args()
@@ -482,6 +488,10 @@ if __name__ == "__main__":
                     if response.status_code == 200:
                         headers = columns_response.model.model.columns
 
+                    if (options.print_json):
+                        print(response.model.model.to_json())
+                        sys.exit(0)
+
                     table_model = TableModel(response.model.model, headers)
                     table_model.print()