Add support for configurable output columns

Add a '--column' option to all list commands. This allows users to
configure what columns are output. How this works is currently quite
dumb but that can be improved in the future.

Signed-off-by: Stephen Finucane <[email protected]>
Closes: #29

Author: stephenfin

git_pw/api.py

@@ -284,6 +284,9 @@ def new_func(ctx, *args, **kwargs):
             if not param.multiple:
                 continue
 
+            if param.name in ('headers'):
+                continue
+
             value = list(kwargs[param.name] or [])
             if value and len(value) > 1 and value != param.default:
                 msg = ('The `--%s` filter was specified multiple times. '

git_pw/bundle.py

@@ -12,6 +12,8 @@
 
 LOG = logging.getLogger(__name__)
 
+_list_headers = ('ID', 'Name', 'Owner', 'Public')
+
 
 def _get_bundle(bundle_id):
     """Fetch bundle by ID or name.
@@ -123,10 +125,10 @@ def _format_patch(patch):
 @click.option('--sort', metavar='FIELD', default='name', type=click.Choice(
                   ['id', '-id', 'name', '-name']),
               help='Sort output on given field.')
-@utils.format_options
+@utils.format_options(headers=_list_headers)
 @click.argument('name', required=False)
 @api.validate_multiple_filter_support
-def list_cmd(owner, limit, page, sort, fmt, name):
+def list_cmd(owner, limit, page, sort, fmt, headers, name):
     """List bundles.
 
     List bundles on the Patchwork instance.
@@ -154,13 +156,21 @@ def list_cmd(owner, limit, page, sort, fmt, name):
 
     # Format and print output
 
-    headers = ['ID', 'Name', 'Owner', 'Public']
+    output = []
+
+    for bundle in bundles:
+        item = [
+            bundle.get('id'),
+            utils.trim(bundle.get('name') or ''),
+            bundle.get('owner').get('username'),
+            'yes' if bundle.get('public') else 'no',
+        ]
+
+        output.append([])
+        for idx, header in enumerate(_list_headers):
+            if header not in headers:
+                continue
 
-    output = [[
-        bundle.get('id'),
-        utils.trim(bundle.get('name') or ''),
-        bundle.get('owner').get('username'),
-        'yes' if bundle.get('public') else 'no',
-    ] for bundle in bundles]
+            output[-1].append(item[idx])
 
     utils.echo_via_pager(output, headers, fmt=fmt)

git_pw/patch.py

@@ -13,6 +13,9 @@
 
 LOG = logging.getLogger(__name__)
 
+_list_headers = ('ID', 'Date', 'Name', 'Submitter', 'State', 'Archived',
+                 'Delegate')
+
 
 @click.command(name='apply', context_settings=dict(
     ignore_unknown_options=True,
@@ -199,11 +202,11 @@ def update_cmd(patch_ids, commit_ref, state, delegate, archived, fmt):
 @click.option('--sort', metavar='FIELD', default='-date', type=click.Choice(
                   ['id', '-id', 'name', '-name', 'date', '-date']),
               help='Sort output on given field.')
-@utils.format_options
+@utils.format_options(headers=_list_headers)
 @click.argument('name', required=False)
 @api.validate_multiple_filter_support
 def list_cmd(state, submitter, delegate, archived, limit, page, sort, fmt,
-             name):
+             headers, name):
     """List patches.
 
     List patches on the Patchwork instance.
@@ -243,19 +246,25 @@ def list_cmd(state, submitter, delegate, archived, limit, page, sort, fmt,
 
     # Format and print output
 
-    headers = ['ID', 'Date', 'Name', 'Submitter', 'State', 'Archived',
-               'Delegate']
-
-    output = [[
-        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')),
-        patch.get('state'),
-        'yes' if patch.get('archived') else 'no',
-        (patch.get('delegate').get('username')
-         if patch.get('delegate') else ''),
-    ] for patch in patches]
+    output = []
+
+    for patch in patches:
+        item = [
+            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')),
+            patch.get('state'),
+            'yes' if patch.get('archived') else 'no',
+            (patch.get('delegate') or {}).get('username', ''),
+        ]
+
+        output.append([])
+        for idx, header in enumerate(_list_headers):
+            if header not in headers:
+                continue
+
+            output[-1].append(item[idx])
 
     utils.echo_via_pager(output, headers, fmt=fmt)

git_pw/series.py

@@ -13,6 +13,8 @@
 
 LOG = logging.getLogger(__name__)
 
+_list_headers = ('ID', 'Date', 'Name', 'Version', 'Submitter')
+
 
 @click.command(name='apply', context_settings=dict(
     ignore_unknown_options=True,
@@ -110,10 +112,10 @@ def _format_submission(submission):
 @click.option('--sort', metavar='FIELD', default='-date', type=click.Choice(
                   ['id', '-id', 'name', '-name', 'date', '-date']),
               help='Sort output on given field.')
-@utils.format_options
+@utils.format_options(headers=_list_headers)
 @click.argument('name', required=False)
 @api.validate_multiple_filter_support
-def list_cmd(submitter, limit, page, sort, fmt, name):
+def list_cmd(submitter, limit, page, sort, fmt, headers, name):
     """List series.
 
     List series on the Patchwork instance.
@@ -141,15 +143,23 @@ def list_cmd(submitter, limit, page, sort, fmt, name):
 
     # Format and print output
 
-    headers = ['ID', 'Date', 'Name', 'Version', 'Submitter']
+    output = []
+
+    for series_ in series:
+        item = [
+            series_.get('id'),
+            arrow.get(series_.get('date')).humanize(),
+            utils.trim(series_.get('name') or ''),
+            series_.get('version'),
+            '%s (%s)' % (series_.get('submitter').get('name'),
+                         series_.get('submitter').get('email'))
+        ]
+
+        output.append([])
+        for idx, header in enumerate(_list_headers):
+            if header not in headers:
+                continue
 
-    output = [[
-        series_.get('id'),
-        arrow.get(series_.get('date')).humanize(),
-        utils.trim(series_.get('name') or ''),
-        series_.get('version'),
-        '%s (%s)' % (series_.get('submitter').get('name'),
-                     series_.get('submitter').get('email'))
-    ] for series_ in series]
+            output[-1].append(item[idx])
 
     utils.echo_via_pager(output, headers, fmt=fmt)

git_pw/utils.py

@@ -149,11 +149,23 @@ def echo(output, headers, fmt):
     click.echo(_tabulate(output, headers, fmt))
 
 
-def format_options(f):
+def format_options(original_function=None, headers=None):
     """Shared output format options."""
-    f = click.option('--format', '-f', 'fmt', envvar='PW_FORMAT',
-                     default=None,
-                     type=click.Choice(['simple', 'table', 'csv']),
-                     help='Output format. Defaults to table.')(f)
 
-    return f
+    def _format_options(f):
+        f = click.option('--format', '-f', 'fmt', envvar='PW_FORMAT',
+                         default=None,
+                         type=click.Choice(['simple', 'table', 'csv']),
+                         help='Output format. Defaults to table.')(f)
+
+        if headers:
+            f = click.option('--column', '-c', 'headers', metavar='COLUMN',
+                             multiple=True, default=headers,
+                             type=click.Choice(headers),
+                             help='Columns to be included in output.')(f)
+        return f
+
+    if original_function:
+        return _format_options(original_function)
+
+    return _format_options

releasenotes/notes/issue-29-884269fdf35f64b2.yaml

@@ -7,3 +7,7 @@ features:
     - ``table`` (default)
     - ``simple`` (a version of table with less markup)
     - ``csv`` (comma-separated output)
+  - |
+    All list comands now take a ``--column``/``-c`` parameter, which can be
+    used to control what columns are output. This can be specified multiples
+    times. All columns are output by default.

tests/test_bundle.py

@@ -216,11 +216,11 @@ def test_list_with_formatting(self, mock_echo, mock_index, mock_version):
 
         runner = CLIRunner()
         result = runner.invoke(bundle.list_cmd, [
-            '--format', 'simple'])
+            '--format', 'simple', '--column', 'ID', '--column', 'Name'])
 
         assert result.exit_code == 0, result
 
-        mock_echo.assert_called_once_with(mock.ANY, mock.ANY,
+        mock_echo.assert_called_once_with(mock.ANY, ('ID', 'Name'),
                                           fmt='simple')
 
     def test_list_with_filters(self, mock_echo, mock_index, mock_version):

tests/test_patch.py

@@ -313,11 +313,11 @@ def test_list_with_formatting(self, mock_echo, mock_index, mock_version):
 
         runner = CLIRunner()
         result = runner.invoke(patch.list_cmd, [
-            '--format', 'simple'])
+            '--format', 'simple', '--column', 'ID', '--column', 'Name'])
 
         assert result.exit_code == 0, result
 
-        mock_echo.assert_called_once_with(mock.ANY, mock.ANY,
+        mock_echo.assert_called_once_with(mock.ANY, ('ID', 'Name'),
                                           fmt='simple')
 
     def test_list_with_filters(self, mock_echo, mock_index, mock_version):

tests/test_series.py

@@ -171,11 +171,11 @@ def test_list_with_formatting(self, mock_echo, mock_index, mock_version):
 
         runner = CLIRunner()
         result = runner.invoke(series.list_cmd, [
-            '--format', 'simple'])
+            '--format', 'simple', '--column', 'ID', '--column', 'Name'])
 
         assert result.exit_code == 0, result
 
-        mock_echo.assert_called_once_with(mock.ANY, mock.ANY,
+        mock_echo.assert_called_once_with(mock.ANY, ('ID', 'Name'),
                                           fmt='simple')
 
     def test_list_with_filters(self, mock_echo, mock_index, mock_version):