/usr/share/doc/python-optcomplete/README is in python-optcomplete 1.2-13.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 | =======================================================
optcomplete: Shell Completion Self-Generator for Python
=======================================================
.. contents:: Table of Contents
Description
===========
This Python module aims at providing almost automatically shell completion for
any Python program that already uses the ``optparse`` module.
Motivation
----------
This module aims at placing the shell completion routine and the option parsing
code in a single location: in the program itself.
The logic is that since a program already knows about its options, and in Python
we have a standard module to specify them programmatically since Python-2.3
(``optparse``), the program itself is in the best position to suggest
completions for an incomplete command-line to a shell that invokes it.
Traditionally, this has been done by writing shell-specific descriptions
*separate* from the programs themselves, such as the `Bash Programmable
Completion <http://freshmeat.net/projects/bashcompletion/>`_ project. This
approach requires maintaining the shell completion functions up-to-date with the
programs.
During development of this proof-of-concept, we were interested in finding if
the programs could not describe their completion routines themselves, using the
well-specified completion protocol in bash. Similar completion routines could
be easily written for other shells and we could extend this module to them.
Documentation
=============
``optcomplete`` consists of a simple module `optcomplete.py
<lib/python/optcomplete.py>`_ which you should install somewhere in your
PYTHONPATH.
To add simple support to a program which already uses ``optparse``, simply add
the following code after the optparse declarations, *before* calling the
``parse_args()`` function on your options parser::
import optcomplete
optcomplete.autocomplete(parser)
Optionally, you can pass a completer as a second argument (see module code).
You also need to `source a Bash function <etc/optcomplete.bash>`_ and then to
tell Bash to trigger optcomplete completion for the specific programs that use
it::
complete -F _optcomplete <program>
More examples:
- `Examples --- sample example output <doc/sample-output.html>`_;
- `A note about conditionals <doc/conditional.html>`_;
- `Simple test program speaks for itself <bin/optcomplete-simple>`_;
- `Test program with subcommands <bin/optcomplete-commands>`_;
- `CHANGES <CHANGES>`_
- `TODO <TODO>`_
Download
========
- `Download </downloads/optcomplete/>`_
Copyright and License
=====================
Copyright (C) 2001-2004 Martin Blais. All Rights Reserved.
This code is distributed under the `BSD License <COPYING>`_.
Author
======
Martin Blais <blais@furius.ca>
|