Adding support --order and --order_by for list operations

linodecli/api_request.py

@@ -150,6 +150,19 @@ def _build_filter_header(
         if p.name in parsed_args_dict:
             del parsed_args_dict[p.name]
 
+    # check for order_by and order
+    order_by, order = None, None
+    if parsed_args_dict["order_by"] is not None:
+        order_by = parsed_args_dict["order_by"]
+        order = (
+            "asc"
+            if parsed_args_dict["order"] is None
+            else parsed_args_dict["order"]
+        )
+
+    del parsed_args_dict["order_by"]
+    del parsed_args_dict["order"]
+
     # The "+and" list to be used in the filter header
     filter_list = []
 
@@ -162,7 +175,13 @@ def _build_filter_header(
         filter_list.extend(new_filters)
 
     if len(filter_list) > 0:
-        return json.dumps({"+and": filter_list})
+        if order_by is None:
+            return json.dumps({"+and": filter_list})
+        return json.dumps(
+            {"+and": filter_list, "+order_by": order_by, "+order": order}
+        )
+    if order_by is not None:
+        return json.dumps({"+order_by": order_by, "+order": order})
 
     return None
 

linodecli/baked/operation.py

@@ -6,6 +6,7 @@
 import json
 import platform
 import re
+import sys
 from getpass import getpass
 from os import environ, path
 
@@ -315,8 +316,10 @@ def parse_args(
 
         if self.method == "get":
             # build args for filtering
+            filterable_args = []
             for attr in self.response_model.attrs:
                 if attr.filterable:
+                    filterable_args.append(attr.name)
                     expected_type = TYPES[attr.datatype]
                     if expected_type == list:
                         parser.add_argument(
@@ -333,6 +336,21 @@ def parse_args(
                             metavar=attr.name,
                         )
 
+            # Add --order_by and --order argument
+            parser.add_argument(
+                "--order_by",
+                choices=filterable_args,
+                help="Attribute to order the results by - must be filterable.",
+                required="--order" in sys.argv,
+            )
+
+            parser.add_argument(
+                "--order",
+                choices=["asc", "desc"],
+                default="asc",
+                help="Either “asc” or “desc”. Defaults to “asc”. Requires +order_by",
+            )
+
         elif self.method in ("post", "put"):
             # build args for body JSON
             for arg in self.args:

tests/unit/test_api_request.py

@@ -109,6 +109,8 @@ def test_build_filter_header(self, list_operation):
             SimpleNamespace(
                 filterable_result="bar",
                 filterable_list_result=["foo", "bar"],
+                order_by=None,
+                order=None,
             ),
         )