iterative / shtab

↔️ Automagic shell tab completion for Python CLI applications
https://docs.iterative.ai/shtab
Other
366 stars 34 forks source link

Tabs after redirecting stdout do not complete files in bash #171

Open mauvilsa opened 3 months ago

mauvilsa commented 3 months ago

When working in shells it is quite common that a command outputs something to stdout an the user wants to redirect this to a file, for example:

ls > /tmp/list_of_files.txt

Using tab completion after the > redirection is very useful to navigate existing directories or complete files. This works out of the box for commands that don't have any tab completion, since anyway this no longer depends on the command.

Unfortunately, when an shtab completion script is activated, the completion after redirection no longer works. For instance take the following script:

from argparse import ArgumentParser
import shtab

parser = ArgumentParser()
parser.add_argument("--number", type=float)
shtab.add_argument_to(parser, "--shell-completion")
print(parser.parse_args())

The following are cases that work and don't work:

$ cli.py --n<TAB>
$ cli.py --number

$ cli.py > <TAB><TAB>
[BUG: does not complete anything]

$ cli.py >> <TAB><TAB>
[BUG: does not complete anything]

$ cli.py 2> <TAB><TAB>
[BUG: does not complete anything]

$ cli.py --number 1 &> <TAB><TAB>
[OK: completes files]

$ cli.py --number 1 2>&1 <TAB><TAB>
[OK: completes files]

$ cli.py --number 1 | <TAB><TAB>
[OK: completes commands]
mauvilsa commented 3 months ago

I would be willing to work on a fix. But probably only if I get some guidance since I don't really understand why it doesn't work or know how to debug.