Argcomplete-like tab completion

[con-f-use]

A feature I would very much like to see is tab completion as in e.g. provided by argcomplete for argparse.

E.g. for the usage string Usage: myprog.py (add | delete) <item>, the used would only have to type ./myprog.py de and press TAB to complete this to ./myprog.py delete.

[keleshev]

There is a package like that somewhere, I remember, but I don't remember its name and searching for docopt complete on PyPI does not yield results.

[BurntSushi]

There is tool bundled with docopt.rs: https://github.com/docopt/docopt.rs#tab-completion-support --- But I haven't gotten around to distributing binaries yet, so you'd have to install Rust and compile it. But then you should be able to use it with any Docopt implementation.

[con-f-use]

Oh wow, and once again, you just have to ask and the internet gives... It seems to work.

As much as I appreciate this tool, eventually there should be native support for tab completion in docopt. The simple reason being, if I were to ship my application, I would have to include Rust, cargo and build the tab completion tool on the target system. All that with no guaratee that it works and a lot of overhead.

[keleshev]

@con-f-use try this: https://pypi.python.org/pypi/infi.docopt_completion/0.2.5

[con-f-use]

Thank you two! After closer inspection, I found a few quirks with both and reported them. I, however, like docopt.rs's meachanism better. That is mainly because it has fewer and more tollerable bugs and it generates the completions on the fly, every time when requested. That allows for commands and options changing dynamically, e.g. by config-file. So the docopt_wordlist from docopt.rs should suit most needs. Still annoying that you can't install it with pip or something similar, I hope you get around to distribution binaries soon.

[con-f-use]

On a usability note, maybe docopt_wordlist should be incorporated directly into the docopt module as a hidden option. What I mean is a script using docopt with:
Usage: myscript FILE [--port | --poster | --potential]
Could be called with:
./script.py --__word-list__ "script.py foobar --po"
Where --__word-list__ is a hidden option. When run with the option and the cword arument (here foobar --po), the script will spit out the possible completions for --po*, namely:
--port --potential --poster
That hidden option can den be used in a Bash completion script.

I think such predictions should be generated fairly readily once you have
pattern = parse_pattern(formal_usage(DocoptExit.usage), options)
All of the inforation is in there. I didn't look close enough on how these nested pattern variable is constructed and what it would take to parse it, but a quick print pattern shows that all the options and their "either", "required", "takes argument", (etc.) status is in there.

[casperdcl]

If you just need a docstring to argparse module (based on docopt syntax but with a couple of extensions)... I have implemented a module called argopt (https://pypi.python.org/pypi/argopt#usage or https://github.com/casperdcl/argopt#usage)...