Extract pagination parameters to common decorator

This helps us avoid duplicating some stuff nearly identically, at the
loss of a tiny bit of detail in the parameter help strings.

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

Author: stephenfin

git_pw/bundle.py

@@ -13,6 +13,7 @@
 LOG = logging.getLogger(__name__)
 
 _list_headers = ('ID', 'Name', 'Owner', 'Public')
+_sort_fields = ('id', '-id', 'name', '-name')
 
 
 def _get_bundle(bundle_id):
@@ -117,14 +118,7 @@ def _format_patch(patch):
 @click.option('--owner', metavar='OWNER', multiple=True,
               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,
-              help='Page to retrieve bundles from. This is influenced by the '
-              'size of LIMIT.')
-@click.option('--sort', metavar='FIELD', default='name', type=click.Choice(
-                  ['id', '-id', 'name', '-name']),
-              help='Sort output on given field.')
+@utils.pagination_options(sort_fields=_sort_fields, default_sort='name')
 @utils.format_options(headers=_list_headers)
 @click.argument('name', required=False)
 @api.validate_multiple_filter_support

git_pw/patch.py

@@ -15,6 +15,7 @@
 
 _list_headers = ('ID', 'Date', 'Name', 'Submitter', 'State', 'Archived',
                  'Delegate')
+_sort_fields = ('id', '-id', 'name', '-name', 'date', '-date')
 
 
 @click.command(name='apply', context_settings=dict(
@@ -194,14 +195,7 @@ def update_cmd(patch_ids, commit_ref, state, delegate, archived, fmt):
               'email or username.')
 @click.option('--archived', default=False, is_flag=True,
               help='Include patches that are archived.')
-@click.option('--limit', metavar='LIMIT', type=click.INT,
-              help='Maximum number of patches to show.')
-@click.option('--page', metavar='PAGE', type=click.INT,
-              help='Page to retrieve patches from. This is influenced by the '
-              'size of LIMIT.')
-@click.option('--sort', metavar='FIELD', default='-date', type=click.Choice(
-                  ['id', '-id', 'name', '-name', 'date', '-date']),
-              help='Sort output on given field.')
+@utils.pagination_options(sort_fields=_sort_fields, default_sort='-date')
 @utils.format_options(headers=_list_headers)
 @click.argument('name', required=False)
 @api.validate_multiple_filter_support

git_pw/series.py

@@ -14,6 +14,7 @@
 LOG = logging.getLogger(__name__)
 
 _list_headers = ('ID', 'Date', 'Name', 'Version', 'Submitter')
+_sort_fields = ('id', '-id', 'name', '-name', 'date', '-date')
 
 
 @click.command(name='apply', context_settings=dict(
@@ -104,14 +105,7 @@ def _format_submission(submission):
 @click.option('--submitter', metavar='SUBMITTER', multiple=True,
               help='Show only series by these submitters. Should be an '
               '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,
-              help='Page to retrieve series from. This is influenced by the '
-              'size of LIMIT.')
-@click.option('--sort', metavar='FIELD', default='-date', type=click.Choice(
-                  ['id', '-id', 'name', '-name', 'date', '-date']),
-              help='Sort output on given field.')
+@utils.pagination_options(sort_fields=_sort_fields, default_sort='-date')
 @utils.format_options(headers=_list_headers)
 @click.argument('name', required=False)
 @api.validate_multiple_filter_support

git_pw/utils.py

@@ -149,6 +149,24 @@ def echo(output, headers, fmt):
     click.echo(_tabulate(output, headers, fmt))
 
 
+def pagination_options(sort_fields, default_sort):
+    """Shared pagination options."""
+
+    def _pagination_options(f):
+        f = click.option('--limit', metavar='LIMIT', type=click.INT,
+                         help='Maximum number of items to show.')(f)
+        f = click.option('--page', metavar='PAGE', type=click.INT,
+                         help='Page to retrieve items from. This is '
+                         'influenced by the size of LIMIT.')(f)
+        f = click.option('--sort', metavar='FIELD', default=default_sort,
+                         type=click.Choice(sort_fields),
+                         help='Sort output on given field.')(f)
+
+        return f
+
+    return _pagination_options
+
+
 def format_options(original_function=None, headers=None):
     """Shared output format options."""