Bash completion example: unexpected keyword "autocompletion"

[charlesreid1]

The stock bash completion example here appears to be broken.

Here's my steps to reproduce in a virtualenv:

virtualenv vp
source vp/bin/activate
wget https://raw.githubusercontent.com/pallets/click/master/examples/bashcompletion/setup.py
wget https://raw.githubusercontent.com/pallets/click/master/examples/bashcompletion/bashcompletion.py

Now start following the instructions on the readme:

pip install -e .
eval "$(_BASHCOMPLETION_COMPLETE=source bashcompletion)"

Upon execution of the last statement, however, I see a problem:

$ eval "$(_BASHCOMPLETION_COMPLETE=source bashcompletion)"
Traceback (most recent call last):
  File "/temp/py/vp/bin/bashcompletion", line 11, in <module>
    load_entry_point('click-example-bashcompletion', 'console_scripts', 'bashcompletion')()
  File "/temp/py/vp/lib/python3.6/site-packages/pkg_resources/__init__.py", line 480, in load_entry_point
    return get_distribution(dist).load_entry_point(group, name)
  File "/temp/py/vp/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2693, in load_entry_point
    return ep.load()
  File "/temp/py/vp/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2324, in load
    return self.resolve()
  File "/temp/py/vp/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2330, in resolve
    module = __import__(self.module_name, fromlist=['__name__'], level=0)
  File "/temp/py/bashcompletion.py", line 17, in <module>
    @click.argument("envvar", type=click.STRING, autocompletion=get_env_vars)
  File "/temp/py/vp/lib/python3.6/site-packages/click/decorators.py", line 151, in decorator
    _param_memo(f, ArgumentClass(param_decls, **attrs))
  File "/temp/py/vp/lib/python3.6/site-packages/click/core.py", line 1699, in __init__
    Parameter.__init__(self, param_decls, required=required, **attrs)
TypeError: __init__() got an unexpected keyword argument 'autocompletion'

This seems to be related to the autocompletion kwarg used to decorate the cmd1() and subcmd() methods:

@cli.command()
@click.argument("envvar", type=click.STRING, autocompletion=get_env_vars)
def cmd1(envvar):
    click.echo('Environment variable: %s' % envvar)
    click.echo('Value: %s' % os.environ[envvar])

@group.command()
@click.argument("user", type=click.STRING, autocompletion=list_users)
def subcmd(user):
    click.echo('Chosen user is %s' % user)

In fact, the problem is that the version of click I have does not include bash autocompletion!

$ grep "autocompletion" vp/lib/python3.6/site-packages/click/core.py
$ 

(compare to current source).

I have click version 6.7 installed,

$ python --version
Python 3.6.4

$ python -c 'import click; print(click.__version__)'
6.7

The example readme states

This example requires Click 2.0 or higher.

I'm a little confused about why bash completion is missing from Click 6.7 when it was added in 2.0!

[dawranliou]

It appears that the autocompletion feature was broken Click version 6.7. However, it's now fixed in the latest master branch since 8ac004f.

I suppose the fix would come out as part of the 7.0 release

[JosiahDub]

I checked 6.6 and 6.0 and there's no mention of autocomplete. I don't think it's ever been included in a release.

[dawranliou]

Oh right. Agree, it never appeared in the Change Log.

[JosiahDub]

This feature will be added in 7.0 or later.