proposal: Display full path in the header for nested columns (#515)

Author: lgarber-akamai

linodecli/output.py

@@ -103,7 +103,7 @@ def print(
             )
 
         if isinstance(columns[0], OpenAPIResponseAttr):
-            header = [c.column_name for c in columns]
+            header = [c.name for c in columns]
         else:
             header = columns
 
@@ -238,7 +238,9 @@ def _get_columns(self, attrs):
             columns = []
             for col in self.columns.split(","):
                 for attr in attrs:
-                    if attr.column_name == col:
+                    # Display this column if the format string
+                    # matches the column_name or path of this column
+                    if col in (attr.column_name, attr.name):
                         attrs.remove(attr)
                         columns.append(attr)
 
@@ -314,6 +316,10 @@ def _json_output(self, header, data, to):
         """
         Prints data in JSON format
         """
+        # Special handling for JSON headers.
+        # We're only interested in the last part of the column name.
+        header = [v.split(".")[-1] for v in header]
+
         content = []
         if len(data) and isinstance(data[0], dict):  # we got delimited json in
             # parse down to the value we display

tests/unit/test_output.py

@@ -504,7 +504,10 @@ def test_print_subtable_single(
 
         output = output.getvalue().splitlines()
 
-        lines = ["foo\tbar\tfoobar", "cool\tcool2\twow"]
+        lines = [
+            "foo.single_nested.foo\tfoo.single_nested.bar\tfoobar",
+            "cool\tcool2\twow",
+        ]
 
         for i, line in enumerate(lines):
             assert line in output[i]
@@ -551,3 +554,37 @@ def test_print_subtable_with_selection(
 
         for i, line in enumerate(lines):
             assert line in output[i]
+
+    def test_format_nested_field(
+        self, mock_cli, get_operation_for_subtable_test
+    ):
+        output = io.StringIO()
+
+        mock_cli.output_handler.mode = OutputMode.delimited
+        mock_cli.output_handler.single_table = True
+        mock_cli.output_handler.columns = "foo.single_nested.bar"
+
+        mock_data = {
+            "table": [{"foo": "cool", "bar": 12345}],
+            "foo": {
+                "single_nested": {"foo": "cool", "bar": "cool2"},
+                "table": [{"foobar": ["127.0.0.1", "127.0.0.2"]}],
+            },
+            "foobar": "wow",
+        }
+
+        mock_cli.output_handler.print_response(
+            get_operation_for_subtable_test.response_model,
+            data=[mock_data],
+            to=output,
+        )
+
+        output = output.getvalue().splitlines()
+
+        lines = [
+            "foo.single_nested.bar",
+            "cool2",
+        ]
+
+        for i, line in enumerate(lines):
+            assert line in output[i]