Merge pull request #162 from j-bennet/j-bennet/yaml-formatter

[WIP] Use yaml to format hierarchical info.

Author: j-bennet

.travis.yml

@@ -19,7 +19,7 @@ before_install:
   - docker --version
 
 install:
-  - pip install pip==9.0
+  - pip install pip==9.0.1
   - pip install -r requirements-dev.txt
   - pip install codecov
   - pip install -e .

changelog.rst

@@ -1,3 +1,8 @@
+Upcoming
+========
+
+* Use ``ruamel.yaml`` to format hierarchical info.
+
 0.10
 ====
 

setup.py

@@ -23,7 +23,8 @@
         'py-pretty>=0.1',
         'configobj>=5.0.6',
         'pexpect>=3.3',
-        'fuzzyfinder>=1.0.0'
+        'fuzzyfinder>=1.0.0',
+        'ruamel.yaml>=0.15.72',
     ],
     extras_require={
         'testing': [

tests/test_formatter.py

@@ -128,7 +128,7 @@ def test_dict_data_formatting():
         }
     }
 
-    lines = format_struct(data, spaces=2)
+    lines = format_struct(data, indent=2)
 
     print('\n')
     for line in lines:
@@ -183,7 +183,7 @@ def test_info_data_formatting():
         'SystemTime': '2015-04-29T04:58:07.548655766Z'
     }
 
-    lines = format_struct(data, spaces=2)
+    lines = format_struct(data, indent=2)
 
     print('\n')
     for line in lines:

wharfee/client.py

@@ -258,8 +258,7 @@ def version(self, *_):
 
         try:
             verdict = self.instance.version()
-            result = [(k, verdict[k]) for k in sorted(verdict.keys())]
-            return result
+            return verdict
         except ConnectionError as ex:
             raise DockerPermissionException(ex)
 
@@ -268,10 +267,8 @@ def info(self, *_):
         Return the system info. Equivalent of docker info.
         :return: list of tuples
         """
-
-        rdict = self.instance.info()
-        result = [(k, rdict[k]) for k in sorted(rdict.keys())]
-        return result
+        info_dict = self.instance.info()
+        return info_dict
 
     def inspect(self, *args, **_):
         """

wharfee/formatter.py

@@ -12,6 +12,12 @@
 from pygments import highlight
 from pygments.lexers.data import JsonLexer
 from pygments.formatters.terminal import TerminalFormatter
+from ruamel.yaml import YAML
+
+try:
+    from StringIO import StringIO
+except ImportError:
+    from io import StringIO
 
 # Python 3 has no 'basestring' or 'long' type we're checking for.
 try:
@@ -181,13 +187,12 @@ def format_data(command, data):
     if command and command in DATA_FILTERS:
         data = DATA_FILTERS[command](data)
 
+    if isinstance(data, dict):
+        return format_struct(data)
     if isinstance(data, list) and len(data) > 0:
         if isinstance(data[0], tuple):
-            if is_plain_lists(data):
-                text = tabulate(data)
-                return text.split('\n')
-            else:
-                return format_struct(data)
+            text = tabulate(data)
+            return text.split('\n')
         elif isinstance(data[0], dict):
             if data[0].keys() == ['Id']:
                 # Sometimes our 'quiet' output is a list of dicts but
@@ -211,46 +216,13 @@ def format_data(command, data):
     return data
 
 
-def format_struct(data, spaces=4, indent=0, lines=None):
-
-    if lines is None:
-        lines = []
-
-    if isinstance(data, dict):
-        data = [(k, data[k]) for k in sorted(data.keys())]
-
-    def item_to_line(current_item, current_line, is_last_item, current_list):
-        """ Helper to add item to end of line """
-        if len(current_line) == 0:
-            current_indent = ' ' * (indent * spaces)
-            current_line = current_indent
-
-        current_line += '{0}'.format(current_item)
-
-        if is_last_item:
-            current_list.append(current_line)
-            current_line = ''
-        else:
-            current_line += ': '
-        return current_line, current_list
-
-    for row in data:
-        line = ''
-        l = len(row)
-        for i in range(l):
-            if isinstance(row[i], dict):
-                lines.append(line)
-                lines = format_struct(row[i], spaces, indent + 1, lines)
-            elif isinstance(row[i], list):
-                if is_plain_list(row[i]):
-                    item = flatten_list(row[i])
-                    line, lines = item_to_line(item, line, i == (l - 1), lines)
-                else:
-                    lines.append(line)
-                    lines = format_struct(row[i], spaces, indent + 1, lines)
-            else:
-                line, lines = item_to_line(row[i], line, i == (l - 1), lines)
-
+def format_struct(data, indent=4):
+    output = StringIO()
+    yaml = YAML()
+    yaml.default_flow_style = False
+    yaml.indent = indent
+    yaml.dump(data, stream=output)
+    lines = output.getvalue().split('\n')
     return lines