proposal: Add support for printing additional tables in command outputs (#511)

Author: lgarber-akamai

Makefile

@@ -51,7 +51,7 @@ clean:
 .PHONY: testunit
 testunit: export LINODE_CLI_TEST_MODE = 1
 testunit:
-	pytest tests/unit
+	pytest -v tests/unit
 
 .PHONY: testint
 testint:

README.rst

@@ -509,5 +509,9 @@ added to Linode's OpenAPI spec:
 |                             |             | paired with ``x-linode-cli-nested-list``, allowing a schema to describe the flattened     |
 |                             |             | object instead of the original object.                                                    |
 +-----------------------------+-------------+-------------------------------------------------------------------------------------------+
+|x-linode-cli-subtables       | content-type| Indicates that certain response attributes should be printed in a separate "sub"-table.   |
+|                             |             | This allows certain endpoints with nested structures in the response to be displayed      |
+|                             |             | correctly.                                                                                |
++-----------------------------+-------------+-------------------------------------------------------------------------------------------+
 
 .. _Specification Extensions: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.1.md#specificationExtensions

linodecli/__init__.py

@@ -103,6 +103,8 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
     cli.output_handler.suppress_warnings = parsed.suppress_warnings
     cli.output_handler.disable_truncation = parsed.no_truncation
     cli.output_handler.column_width = parsed.column_width
+    cli.output_handler.single_table = parsed.single_table
+    cli.output_handler.tables = parsed.table
 
     if parsed.as_user and not skip_config:
         cli.config.set_user(parsed.as_user)

linodecli/api_request.py

@@ -360,11 +360,10 @@ def _handle_error(ctx, response):
             for error in resp_json["errors"]
         ]
         ctx.output_handler.print(
-            None,
             data,
+            ["field", "reason"],
             title="errors",
             to=sys.stderr,
-            columns=["field", "reason"],
         )
     sys.exit(1)
 

linodecli/arg_helpers.py

@@ -116,6 +116,17 @@ def register_args(parser):
         action="store_true",
         help="Skip retrying on common errors like timeouts.",
     )
+    parser.add_argument(
+        "--single-table",
+        action="store_true",
+        help="Disable printing multiple tables for complex API responses.",
+    )
+    parser.add_argument(
+        "--table",
+        type=str,
+        action="append",
+        help="The specific table(s) to print in output of a command.",
+    )
     parser.add_argument(
         "--column-width",
         type=int,

linodecli/baked/operation.py

@@ -319,7 +319,7 @@ def process_response_json(
             return
 
         json = self.response_model.fix_json(json)
-        handler.print(self.response_model, json)
+        handler.print_response(self.response_model, json)
 
     def _add_args_filter(self, parser):
         # build args for filtering

linodecli/baked/response.py

@@ -27,7 +27,7 @@ class OpenAPIResponseAttr:
     from it.
     """
 
-    def __init__(self, name, schema, prefix=None):
+    def __init__(self, name, schema, prefix=None, nested_list_depth=0):
         """
         :param name: The key that held this schema in the properties list, representing
                      its name in a response.
@@ -37,13 +37,19 @@ def __init__(self, name, schema, prefix=None):
         :param prefix: The json path style prefix (dot notation) to this schema
                        in the response object
         :type prefix: str
+        :param nested_list_depth: The number of nested lists this attribute is nested in.
+        :type: nested_list_depth: int
         """
         #: The name of this attribute, which is the full json path to it within the schema
         self.name = name if prefix is None else prefix + "." + name
 
         #: If this attribute is filterable in GET requests
         self.filterable = schema.extensions.get("linode-filterable")
 
+        #: The depth of this nested attribute in lists. This is necessary to prevent displaying
+        #: list nested items in normal tables.
+        self.nested_list_depth = nested_list_depth
+
         #: The description of this argument, for help display.  Only used for filterable attributes.
         self.description = (
             schema.description.split(".")[0] if schema.description else ""
@@ -90,8 +96,14 @@ def _get_value(self, model):
         """
         value = model
         for part in self.name.split("."):
-            if value is None or value == {}:
+            if (
+                value is None
+                or value == {}
+                or isinstance(value, list)
+                or part not in value
+            ):
                 return None
+
             value = value[part]
         return value
 
@@ -133,7 +145,7 @@ def get_string(self, model):
         return value
 
 
-def _parse_response_model(schema, prefix=None):
+def _parse_response_model(schema, prefix=None, nested_list_depth=0):
     """
     Recursively parses all properties of this schema to create a flattened set of
     OpenAPIResponseAttr objects that allow the CLI to display this response in a
@@ -142,18 +154,31 @@ def _parse_response_model(schema, prefix=None):
                    become a new OpenAPIResponseAttr instance, and this process is
                    recursive to include the properties of properties and so on.
     :type schema: openapi3.Schema
+    :param nested_list_depth: The number of nested lists this attribute is nested in.
+    :type: nested_list_depth: int
     :returns: The list of parsed OpenAPIResponseAttr objects representing this schema
     :rtype: List[OpenAPIResponseAttr]
     """
     attrs = []
 
     if schema.properties is not None:
         for k, v in schema.properties.items():
+            pref = prefix + "." + k if prefix else k
+
             if v.type == "object":
-                pref = prefix + "." + k if prefix else k
                 attrs += _parse_response_model(v, prefix=pref)
+            elif v.type == "array" and v.items.type == "object":
+                attrs += _parse_response_model(
+                    v.items,
+                    prefix=pref,
+                    nested_list_depth=nested_list_depth + 1,
+                )
             else:
-                attrs.append(OpenAPIResponseAttr(k, v, prefix=prefix))
+                attrs.append(
+                    OpenAPIResponseAttr(
+                        k, v, prefix=prefix, nested_list_depth=nested_list_depth
+                    )
+                )
 
     return attrs
 
@@ -189,6 +214,7 @@ def __init__(self, response):
             self.attrs = _parse_response_model(response.schema)
         self.rows = response.extensions.get("linode-cli-rows")
         self.nested_list = response.extensions.get("linode-cli-nested-list")
+        self.subtables = response.extensions.get("linode-cli-subtables")
 
     def fix_json(self, json):
         """

linodecli/cli.py

@@ -118,17 +118,6 @@ def handle_command(self, command, action, args):
         Given a command, action, and remaining kwargs, finds and executes the
         action
         """
-        if (command, action) in [
-            ("linodes", "ips-list"),
-            ("firewalls", "rules-list"),
-        ] and "--json" not in args:
-            print(
-                "This output contains a nested structure that may not properly "
-                + "be displayed by linode-cli.",
-                "A fix is currently on the roadmap but has not yet been implemented.",
-                "Please use --json for endpoints like this in the meantime.",
-                file=sys.stderr,
-            )
 
         try:
             operation = self.find_operation(command, action)