Add auto-complete of '--state' argument

Patchwork provides some defaults and it's likely most deployments are
using these or some combination thereof. Start providing a default
selection but allow people to override this if they need to.

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

Author: stephenfin

README.rst

@@ -102,6 +102,15 @@ username/password combination:
 ``pw.password``
   The password for your Patchwork account.
 
+The following settings are **optional** and may need to be set depending on
+your Patchwork instance's configuration:
+
+``pw.states``
+  The states that can be applied to a patch using the ``git pw patch update``
+  command. Should be provided in slug form (``changes-requested`` instead of
+  ``Changes Requested``). Only required if your Patchwork instance uses
+  non-default states.
+
 You can set these settings using the ``git config`` command. This should be
 done in the repo in which you intend to apply patches. For example, to
 configure the Patchwork project, run:

git_pw/config.py

@@ -7,11 +7,6 @@
 from git_pw import utils
 
 LOG = logging.getLogger(__name__)
-# TODO(stephenfin): We should eventually download and store these
-# automagically
-DEFAULT_STATES = [
-    'new', 'under-review', 'accepted', 'rejected', 'rfc', 'not-applicable',
-    'changes-requested', 'awaiting-upstream', 'superseded', 'deferred']
 
 
 class Config(object):
@@ -21,7 +16,10 @@ def __init__(self):
 
     def __getattribute__(self, name):
         # attempt to use any attributes first
-        value = object.__getattribute__(self, name)
+        try:
+            value = super(Config, self).__getattribute__(name)
+        except AttributeError:
+            value = None
         if value:
             LOG.debug("Retrieved '{}' setting from cache".format(name))
             return value

git_pw/patch.py

@@ -10,13 +10,19 @@
 import click
 
 from git_pw import api
+from git_pw import config
 from git_pw import utils
 
+CONF = config.CONF
 LOG = logging.getLogger(__name__)
 
-_list_headers = ('ID', 'Date', 'Name', 'Submitter', 'State', 'Archived',
-                 'Delegate')
-_sort_fields = ('id', '-id', 'name', '-name', 'date', '-date')
+_list_headers = (
+    'ID', 'Date', 'Name', 'Submitter', 'State', 'Archived', 'Delegate')
+_sort_fields = (
+    'id', '-id', 'name', '-name', 'date', '-date')
+_default_states = (
+    'new', 'under-review', 'accepted', 'rejected', 'rfc', 'not-applicable',
+    'changes-requested', 'awaiting-upstream', 'superseded', 'deferred')
 
 
 @click.command(name='apply', context_settings=dict(
@@ -135,13 +141,18 @@ def show_cmd(fmt, patch_id):
     _show_patch(patch, fmt)
 
 
+def _get_states():
+    return CONF.states.split(',') if CONF.states else _default_states
+
+
 @click.command(name='update')
 @click.argument('patch_ids', type=click.INT, nargs=-1, required=True)
 @click.option('--commit-ref', metavar='COMMIT_REF',
               help='Set the patch commit reference hash')
-@click.option('--state', metavar='STATE',
-              help='Set the patch state. Should be a slugified representation '
-              'of a state. The available states are instance dependant.')
+@click.option('--state', metavar='STATE', type=click.Choice(_get_states()),
+              help="Set the patch state. Should be a slugified representation "
+              "of a state. The available states are instance dependant and "
+              "can be configured using 'git config pw.states'.")
 @click.option('--delegate', metavar='DELEGATE',
               help='Set the patch delegate. Should be unique user identifier: '
               'either a username or a user\'s email address.')

man/git-pw-bundle-apply.1

@@ -1,4 +1,4 @@
-.TH "GIT-PW BUNDLE APPLY" "1" "21-Sep-2019" "1.7.0" "git-pw bundle apply Manual"
+.TH "GIT-PW BUNDLE APPLY" "1" "08-Dec-2019" "1.8.0" "git-pw bundle apply Manual"
 .SH NAME
 git-pw\-bundle\-apply \- Apply bundle.
 .SH SYNOPSIS

man/git-pw-bundle-download.1

@@ -1,4 +1,4 @@
-.TH "GIT-PW BUNDLE DOWNLOAD" "1" "21-Sep-2019" "1.7.0" "git-pw bundle download Manual"
+.TH "GIT-PW BUNDLE DOWNLOAD" "1" "08-Dec-2019" "1.8.0" "git-pw bundle download Manual"
 .SH NAME
 git-pw\-bundle\-download \- Download bundle in mbox format.
 .SH SYNOPSIS

man/git-pw-bundle-list.1

@@ -1,4 +1,4 @@
-.TH "GIT-PW BUNDLE LIST" "1" "21-Sep-2019" "1.7.0" "git-pw bundle list Manual"
+.TH "GIT-PW BUNDLE LIST" "1" "08-Dec-2019" "1.8.0" "git-pw bundle list Manual"
 .SH NAME
 git-pw\-bundle\-list \- List bundles.
 .SH SYNOPSIS

man/git-pw-bundle-show.1

@@ -1,4 +1,4 @@
-.TH "GIT-PW BUNDLE SHOW" "1" "21-Sep-2019" "1.7.0" "git-pw bundle show Manual"
+.TH "GIT-PW BUNDLE SHOW" "1" "08-Dec-2019" "1.8.0" "git-pw bundle show Manual"
 .SH NAME
 git-pw\-bundle\-show \- Show information about bundle.
 .SH SYNOPSIS

man/git-pw-bundle.1

@@ -1,4 +1,4 @@
-.TH "GIT-PW BUNDLE" "1" "21-Sep-2019" "1.7.0" "git-pw bundle Manual"
+.TH "GIT-PW BUNDLE" "1" "08-Dec-2019" "1.8.0" "git-pw bundle Manual"
 .SH NAME
 git-pw\-bundle \- Interact with bundles.
 .SH SYNOPSIS

man/git-pw-patch-apply.1

@@ -1,4 +1,4 @@
-.TH "GIT-PW PATCH APPLY" "1" "21-Sep-2019" "1.7.0" "git-pw patch apply Manual"
+.TH "GIT-PW PATCH APPLY" "1" "08-Dec-2019" "1.8.0" "git-pw patch apply Manual"
 .SH NAME
 git-pw\-patch\-apply \- Apply patch.
 .SH SYNOPSIS

man/git-pw-patch-download.1

@@ -1,4 +1,4 @@
-.TH "GIT-PW PATCH DOWNLOAD" "1" "21-Sep-2019" "1.7.0" "git-pw patch download Manual"
+.TH "GIT-PW PATCH DOWNLOAD" "1" "08-Dec-2019" "1.8.0" "git-pw patch download Manual"
 .SH NAME
 git-pw\-patch\-download \- Download patch in diff or mbox format.
 .SH SYNOPSIS