Implement natural sort for table output (#28)

Author: René Moser

CHANGELOG.md

@@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file.
 
 - cloudscale-sdk updated to 0.5.0.
 - Add option `--detach` for volumes to detach.
+- Add natural sort for table output.
 
 ## v1.0.1 (2020-10-09)
 

cloudscale_cli/commands/__init__.py

@@ -2,8 +2,9 @@
 import time
 import click
 import jmespath
+from natsort import natsorted, ns
 from cloudscale import Cloudscale, CloudscaleApiException
-from ..util import to_table, to_pretty_json, tags_to_dict
+from ..util import to_table, to_pretty_json, tags_to_dict, format_json
 
 if sys.stdout.isatty():
     from yaspin import yaspin as Spinner
@@ -38,6 +39,9 @@ def __init__(self, cloud_resource_name=None, api_token=None, profile=None, debug
         # Alternate key to look for the resource as 'name'
         self.resource_name_key = 'name'
 
+        # Usually we want to sort the table by the key used as name
+        self.resource_table_sort_key = None
+
         self.response_transform_json = None
 
     def get_client_resource(self):
@@ -49,7 +53,16 @@ def _format_output(self, response):
         else:
             if isinstance(response, dict):
                 response = [response]
-            return to_table(response, self.headers, self.response_transform_json)
+
+            if response:
+                response = format_json(response, self.response_transform_json)
+                sort_by_key = self.resource_table_sort_key or self.resource_name_key
+                if sort_by_key:
+                    if 'zone' in self.headers:
+                        response = natsorted(response, key=lambda x: (x['zone'], x[sort_by_key]), alg=ns.IGNORECASE)
+                    else:
+                        response = natsorted(response, key=lambda x: x[sort_by_key], alg=ns.IGNORECASE)
+            return to_table(response, self.headers)
 
     def cmd_list(self, filter_tag=None, filter_json=None, action=None, delete=False, force=False, wait=False):
         if action and delete:

cloudscale_cli/commands/region.py

@@ -8,6 +8,7 @@ def region(ctx):
         'slug',
         'zones',
     ]
+    ctx.obj.resource_table_sort_key = 'slug'
 
 @click.option('--filter-json')
 @region.command("list")

cloudscale_cli/commands/server_group.py

@@ -12,6 +12,16 @@ def server_group(ctx):
         'tags',
         'uuid',
     ]
+    ctx.obj.response_transform_json = '''
+        [].{
+            "name": name,
+            "type": type,
+            "servers": servers,
+            "zone": zone.slug,
+            "tags": tags,
+            "uuid": uuid
+            }
+    '''
 
 @click.option('--filter-tag')
 @click.option('--filter-json')

cloudscale_cli/commands/subnet.py

@@ -13,6 +13,7 @@ def subnet(ctx):
         'tags',
     ]
     ctx.obj.resource_name_key = None
+    ctx.obj.resource_table_sort_key = 'cidr'
 
 @click.option('--filter-tag')
 @click.option('--filter-json')

cloudscale_cli/commands/volume.py

@@ -14,6 +14,16 @@ def volume(ctx):
         'server_uuids',
         'uuid',
     ]
+    ctx.obj.response_transform_json = '''
+        [].{
+            "name": name,
+            "type": type,
+            "tags": tags,
+            "server_uuids": server_uuids,
+            "zone": zone.slug,
+            "uuid": uuid
+            }
+    '''
 
 @click.option('--filter-tag')
 @click.option('--filter-json')

cloudscale_cli/util.py

@@ -1,9 +1,9 @@
 import json
+import jmespath
 from click import Group
 from collections import OrderedDict
 from tabulate import tabulate
 from pygments import highlight, lexers, formatters
-import jmespath
 
 
 class OrderedGroup(Group):
@@ -19,14 +19,16 @@ def list_commands(self, ctx):
         return sorted(self.commands.keys())
 
 
+def format_json(data: list, format_json: str = None) -> list:
+    if format_json:
+        data = jmespath.search(format_json, data)
+    return data
+
 def to_table(data: list, headers: list, format_json: str = None) -> str:
     '''
     Turn a list into a table
     '''
 
-    if format_json:
-        data = jmespath.search(format_json, data)
-
     formated_headers = []
 
     cols = list()

requirements.txt

@@ -4,3 +4,4 @@ tabulate
 pygments
 jmespath
 yaspin
+natsort