Added support for autocompletion of arguments, intending to fix issue p…

…allets#241

click/_bashcomplete.py

@@ -2,8 +2,7 @@
 import re
 from .utils import echo
 from .parser import split_arg_string
-from .core import MultiCommand, Option
-
+from .core import MultiCommand, Option, Argument
 
 COMPLETION_SCRIPT = '''
 %(complete_func)s() {
@@ -61,6 +60,13 @@ def do_complete(cli, prog_name):
             choices.extend(param.secondary_opts)
     elif isinstance(ctx.command, MultiCommand):
         choices.extend(ctx.command.list_commands(ctx))
+    else:
+        for param in ctx.command.params:
+            if isinstance(param, Argument):
+                try:
+                    choices.extend(param.autocompletion)
+                except AttributeError:
+                    pass
 
     for item in choices:
         if item.startswith(incomplete):

click/core.py

@@ -1676,6 +1676,8 @@ def __init__(self, param_decls, required=None, **attrs):
                 required = False
             else:
                 required = attrs.get('nargs', 1) > 0
+        if attrs.get('autocompletion') is not None:
+            self.autocompletion =  attrs.pop('autocompletion')
         Parameter.__init__(self, param_decls, required=required, **attrs)
         if self.default is not None and self.nargs < 0:
             raise TypeError('nargs=-1 in combination with a default value '

docs/bashcomplete.rst

@@ -29,6 +29,16 @@ least a dash has been provided.  Example::
     clone    commit   copy     delete   setuser
     $ repo clone -<TAB><TAB>
     --deep     --help     --rev      --shallow  -r
+	
+Additionally, custom suggestions can be given to an argument with the ``autocomplete`` parameter as a list of strings.  Example::
+
+.. click:example::
+
+    @cli.command()
+	@click.argument("name", type=click.STRING, autocompletion=["John", "Simon", "Doe"])
+	def cmd1(name):
+        click.echo('Name: %s' % name)
+
 
 Activation
 ----------

examples/bashcompletion/README

@@ -0,0 +1,12 @@
+$ bashcompletion
+
+  bashcompletion is a simple example of an application that
+  tries to autocomplete commands, arguments and options.
+
+  This example requires Click 2.0 or higher.
+
+Usage:
+
+  $ pip install --editable .
+  $ eval "$(_BASHCOMPLETION_COMPLETE=source bashcompletion)"
+  $ bashcompletion --help

examples/bashcompletion/bashcompletion.py

@@ -0,0 +1,21 @@
+import click
+
+@click.group()
+def cli():
+    pass
+
+@cli.command()
+@click.argument("name", type=click.STRING, autocompletion=["John", "Simon", "Doe"])
+@click.option('--debug/--no-debug', default=False)
+@click.option('-f', default=False)
+def cmd1():
+    pass
+
+@cli.command()
+def cmd2():
+    pass
+
+@cli.command()
+def cmd3():
+    pass
+

examples/bashcompletion/setup.py

@@ -0,0 +1,15 @@
+from setuptools import setup
+
+setup(
+    name='click-example-bashcompletion',
+    version='1.0',
+    py_modules=['bashcompletion'],
+    include_package_data=True,
+    install_requires=[
+        'click',
+    ],
+    entry_points='''
+        [console_scripts]
+        bashcompletion=bashcompletion:cli
+    ''',
+)