utils: Add support for 'yaml' formatter

This is helpful in environments where limited horizontal space is
available.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Author: stephenfin

README.rst

@@ -47,14 +47,14 @@ dependencies.  On Fedora, run:
 .. code-block:: bash
 
    $ sudo dnf install python3-requests python3-click python3-pbr \
-       python3-arrow python3-tabulate
+       python3-arrow python3-tabulate python3-yaml
 
 On Ubuntu, run:
 
 .. code-block:: bash
 
    $ sudo apt-get install python3-requests python3-click python3-pbr \
-       python3-arrow python3-tabulate
+       python3-arrow python3-tabulate python3-yaml
 
 Once dependencies are installed, clone this repo and run ``setup.py``:
 

git_pw/patch.py

@@ -278,8 +278,10 @@ def list_cmd(states, submitters, delegates, hashes, archived, limit, page,
             patch.get('id'),
             arrow.get(patch.get('date')).humanize(),
             utils.trim(patch.get('name')),
-            '%s (%s)' % (patch.get('submitter').get('name'),
-                         patch.get('submitter').get('email')),
+            '%s (%s)' % (
+                patch.get('submitter').get('name'),
+                patch.get('submitter').get('email'),
+            ),
             patch.get('state'),
             'yes' if patch.get('archived') else 'no',
             (patch.get('delegate') or {}).get('username', ''),

git_pw/utils.py

@@ -12,6 +12,7 @@
 
 import click
 from tabulate import tabulate
+import yaml
 
 LOG = logging.getLogger(__name__)
 
@@ -92,8 +93,14 @@ def _tabulate(
         for item in output:
             writer.writerow([ensure_str(i) for i in item])
         return result.getvalue()
-
-    LOG.error('pw.format must be one of: table, simple, csv')
+    elif fmt == 'yaml':
+        data = [
+            {headers[i].lower(): entry[i] for i in range(len(headers))}
+            for entry in output
+        ]
+        return yaml.dump(data, default_flow_style=False)
+
+    LOG.error('pw.format must be one of: table, simple, csv, yaml')
     sys.exit(1)
 
 
@@ -210,7 +217,7 @@ def _format_options(f):
             '-f',
             'fmt',
             default=None,
-            type=click.Choice(['simple', 'table', 'csv']),
+            type=click.Choice(['simple', 'table', 'csv', 'yaml']),
             help=(
                 "Output format. Defaults to the value of "
                 "'git config pw.format' else 'table'."

releasenotes/notes/add-yaml-format-support-5cd6b9028e6d2d8e.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    The ``-f`` / ``--format`` option used for many ``list`` commands now
+    supports a new option: ``yaml``. This can be useful in environments where
+    limited horizontal space is available.

requirements.txt

@@ -2,3 +2,4 @@ click>=6.0,<9.0
 requests>2.0,<3.0
 tabulate>=0.8
 arrow>=0.10
+PyYAML>=5.1

tests/test_utils.py

@@ -7,6 +7,7 @@
 import os
 
 import mock
+import yaml
 
 from git_pw import utils
 
@@ -120,6 +121,23 @@ def test_tabulate_csv(mock_tabulate):
     """)
 
 
+@mock.patch.object(yaml, 'dump')
+def test_tabulate_yaml(mock_dump):
+    output, headers, result = _test_tabulate('yaml')
+
+    mock_dump.assert_called_once_with(
+        [{
+            'col1': b'foo',
+            'colb': 'bar',
+            'coliii': u'baz',
+            'colx': '😀',
+            'coly': None,
+            'colz': 1,
+        }],
+        default_flow_style=False,
+    )
+
+
 @mock.patch.object(utils, 'git_config', return_value='simple')
 @mock.patch.object(utils, 'tabulate')
 def test_tabulate_git_config(mock_tabulate, mock_git_config):