Add support for filtering by user/submitter ID

This was already sort of supported with the v1.1 API but now it's
official.

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

Author: stephenfin

git_pw/bundle.py

@@ -114,8 +114,8 @@ def _format_patch(patch):
 
 @click.command(name='list')
 @click.option('--owner', metavar='OWNER', multiple=True,
-              help='Show only bundles with these owners. Should be an email '
-              'or name. Private bundles of other users will not be shown.')
+              help='Show only bundles with these owners. Should be an email, '
+              'name or ID. Private bundles of other users will not be shown.')
 @click.option('--limit', metavar='LIMIT', type=click.INT,
               help='Maximum number of bundles to show.')
 @click.option('--page', metavar='PAGE', type=click.INT,
@@ -138,7 +138,7 @@ def list_cmd(owner, limit, page, sort, name):
 
     for own in owner:
         # we support server-side filtering by username (but not email) in 1.1
-        if api.version() >= (1, 1) and '@' not in own:
+        if (api.version() >= (1, 1) and '@' not in own) or own.isdigit():
             params.append(('owner', own))
         else:
             users = api.index('users', [('q', own)])

git_pw/patch.py

@@ -185,7 +185,7 @@ def update_cmd(patch_ids, commit_ref, state, delegate, archived):
               'are instance dependant.')
 @click.option('--submitter', metavar='SUBMITTER', multiple=True,
               help='Show only patches by these submitters. Should be an '
-              'email or name.')
+              'email, name or ID.')
 @click.option('--delegate', metavar='DELEGATE', multiple=True,
               help='Show only patches by these delegates. Should be an '
               'email or username.')
@@ -217,7 +217,7 @@ def list_cmd(state, submitter, delegate, archived, limit, page, sort, name):
 
     for subm in submitter:
         # we support server-side filtering by email (but not name) in 1.1
-        if api.version() >= (1, 1) and '@' in subm:
+        if (api.version() >= (1, 1) and '@' in subm) or subm.isdigit():
             params.append(('submitter', subm))
         else:
             people = api.index('people', [('q', subm)])
@@ -232,7 +232,7 @@ def list_cmd(state, submitter, delegate, archived, limit, page, sort, name):
 
     for delg in delegate:
         # we support server-side filtering by username (but not email) in 1.1
-        if api.version() >= (1, 1) and '@' not in delg:
+        if (api.version() >= (1, 1) and '@' not in delg) or delg.isdigit():
             params.append(('delegate', delg))
         else:
             users = api.index('users', [('q', delg)])

git_pw/series.py

@@ -102,7 +102,7 @@ def _format_submission(submission):
 @click.command(name='list')
 @click.option('--submitter', metavar='SUBMITTER', multiple=True,
               help='Show only series by these submitters. Should be an '
-              'email or name.')
+              'email, name or ID.')
 @click.option('--limit', metavar='LIMIT', type=click.INT,
               help='Maximum number of series to show.')
 @click.option('--page', metavar='PAGE', type=click.INT,
@@ -125,7 +125,7 @@ def list_cmd(submitter, limit, page, sort, name):
 
     for subm in submitter:
         # we support server-side filtering by email (but not name) in 1.1
-        if api.version() >= (1, 1) and '@' in subm:
+        if (api.version() >= (1, 1) and '@' in subm) or subm.isdigit():
             params.append(('submitter', subm))
         else:
             people = api.index('people', [('q', subm)])

releasenotes/notes/filter-item-list-by-user-id-4f4e7d6dc402093b.yaml

@@ -0,0 +1,8 @@
+---
+features:
+  - |
+    It is now possible to filter patches, bundles and series and the IDs of
+    users that submitted or are delegated to the item in question. For
+    example::
+
+        $ git pw patch list --submitter 1

tests/test_bundle.py

@@ -220,15 +220,15 @@ def test_list_with_filters(self, mock_index, mock_version):
 
         runner = CLIRunner()
         result = runner.invoke(bundle.list_cmd, [
-            '--owner', 'john.doe', '--limit', 1, '--page', 1,
+            '--owner', 'john.doe', '--owner', '2', '--limit', 1, '--page', 1,
             '--sort', '-name', 'test'])
 
         assert result.exit_code == 0, result
         calls = [
             mock.call('users', [('q', 'john.doe')]),
             mock.call('bundles', [
-                ('owner', 1), ('q', 'test'), ('page', 1), ('per_page', 1),
-                ('order', '-name')])]
+                ('owner', 1), ('owner', '2'), ('q', 'test'), ('page', 1),
+                ('per_page', 1), ('order', '-name')])]
 
         mock_index.assert_has_calls(calls)
 

tests/test_patch.py

@@ -321,17 +321,19 @@ def test_list_with_filters(self, mock_index, mock_version):
         runner = CLIRunner()
         result = runner.invoke(patch.list_cmd, [
             '--state', 'new', '--submitter', 'john@example.com',
-            '--delegate', 'doe@example.com', '--archived',
+            '--submitter', '2', '--delegate', 'doe@example.com',
+            '--delegate', '2', '--archived',
             '--limit', 1, '--page', 1, '--sort', '-name', 'test'])
 
         assert result.exit_code == 0, result
         calls = [
             mock.call('people', [('q', 'john@example.com')]),
             mock.call('users', [('q', 'doe@example.com')]),
             mock.call('patches', [
-                ('state', 'new'), ('submitter', 1), ('delegate', 1),
-                ('q', 'test'), ('archived', 'true'), ('page', 1),
-                ('per_page', 1), ('order', '-name')])]
+                ('state', 'new'), ('submitter', 1), ('submitter', '2'),
+                ('delegate', 1), ('delegate', '2'), ('q', 'test'),
+                ('archived', 'true'), ('page', 1), ('per_page', 1),
+                ('order', '-name')])]
 
         mock_index.assert_has_calls(calls)
 

tests/test_series.py

@@ -175,15 +175,15 @@ def test_list_with_filters(self, mock_index, mock_version):
 
         runner = CLIRunner()
         result = runner.invoke(series.list_cmd, [
-            '--submitter', 'john@example.com', '--limit', 1, '--page', 1,
-            '--sort', '-name', 'test'])
+            '--submitter', 'john@example.com', '--submitter', '2',
+            '--limit', 1, '--page', 1, '--sort', '-name', 'test'])
 
         assert result.exit_code == 0, result
         calls = [
             mock.call('people', [('q', 'john@example.com')]),
             mock.call('series', [
-                ('submitter', 1), ('q', 'test'), ('page', 1), ('per_page', 1),
-                ('order', '-name')])]
+                ('submitter', 1), ('submitter', '2'), ('q', 'test'),
+                ('page', 1), ('per_page', 1), ('order', '-name')])]
 
         mock_index.assert_has_calls(calls)