Custom zsh autocomplete

autocompleteoh-my-zshzsh

I'd like to write a zsh completion for pytest.

Where do I Start? I'm using oh-my-zsh.

in .zshrc:

fpath=($HOME/.mycompletions $fpath)
autoload -U compinit && compinit -u

in $HOME/.mycompletions/_pytest:

#compdef pytest

_pytest()
{
    cur="${COMP_WORDS[COMP_CWORD]}"
    COMPREPLY=(`pytestcomplete ${cur} 2>/dev/null`)
}
complete -o nospace -F _pytest py.test

Is this correct so far?

Now I "only" need to write the pytestcomplete script.

What should the Return values Look like? How can I hand over to the script which parts have been completed?

I.e. if a user does py.test<TAB> it should complete files first.
If one does py.test tests/my.test.py<TAB> it should complete class names.
If one does py.test tests/my.test.py::TestClass<TAB> it should complete method names.

To get the info out of pytest, one would use --collect-only. The only problem at the moment is the back and forth between zsh and the completion script.

And can this be done like this or do I need to write a oh-my-zsh plugin?

Best Answer

You don't need to write your own completion function for that. You can simply re-use pytest's Bash completion:

Install argcomplete:
```
pip install argcomplete
```

Add the following to your .zshrc:

autoload -Uz bashcompinit && bashcompinit
eval "$(register-python-argcomplete pytest)"

Restart your shell.
Done!

Related Solutions

Zsh autocomplete directory

Not exactly what you asked but I use s to run scripts. So for example if I have a file ~/Scripts/run-stuff.sh I can type s run-stuff.sh and it will run the script. It will also do tab-completion of the script name. The only thing it doesn't do is handle sub-directories in the scripts directory.

# Completion for s (scripts)
_s_comp() {
    if [ $OS = "mac" ]; then
        local LS=gls;
    else
        local LS=ls;
    fi
    reply=(`$LS --ignore-backups $HOME/Scripts/`);
}

compctl -K _s_comp s

It's possible that you may also need an alias like alias s="$HOME/Scripts

Edit: note that this will work regardless of what directory you are currently in.

Bash – Custom autocomplete: deal with spaces in filenames

Believe it might be better to use compgen instead of find in this case.

You probably already have a completion script with system. Try e.g.

locate bash_completion

On Debian variants this is probably:

/usr/share/bash-completion/bash_completion

where you find e.g. _filedir. So the simplest way then would be something in the direction of:

*)
    pushd "/some/path" >/dev/null
    _filedir
    popd >/dev/null

If that is not an option this could be a starter:

_comp_by_path()
{
    local opt cur dir
    local IFS=$'\n' x tmp
    local -a tokens

    opt="$1"
    cur="$2"
    dir="$3"

    # Enter target directory
    pushd "$dir" >/dev/null

    # Get directories, filtered against current
    [[ "$opt" != "-f" ]] && \
    x=$( compgen -d -- "$cur" ) &&
    while read -r tmp; do
        tokens+=( "$tmp" )
    done <<< "$x"

    # Get files, filtered against current
    [[ "$opt" != "-d" ]] && \
    x=$( compgen -f -- "$cur" ) &&
    while read -r tmp; do
        tokens+=( "$tmp" )
    done <<< "$x"

    # If anything found
    if [[ ${#tokens[@]} -ne 0 ]]; then
        # Make sure escaping is OK
        compopt -o filenames 2>/dev/null
        COMPREPLY+=( "${tokens[@]}" )
    fi

    # Go back
    popd >/dev/null
}

_GetOptMyCommand()
{
    local cur

    COMPREPLY=()
    cur="${COMP_WORDS[COMP_CWORD]}"

    case "$cur" in
    -*)
        COMPREPLY=( $( compgen -W "-h -l --help --list --" -- "$cur" ) );;
    *)
        _comp_by_path "any" "$cur" "/some/path"
    esac
}

complete -F _GetOptMyCommand my_command

A variant using find could be something in direction of this:

_zaso()
{
    local dir="$1"

    pushd "$dir" >/dev/null
    find * -maxdepth 0 2>/dev/null
    popd >/dev/null
}

_comp_with_find()
{
    local cur dir      
    local IFS=$'\n'

    cur="$1"
    dir="$2"

    compopt -o filenames 2>/dev/null
    COMPREPLY=( $( compgen -W "$(_zaso "$dir")" -- "$cur" ) );
}

Also note that printf in Bash has a %q option. So to generate quoted strings this is an option to play with:

find * -maxdepth 0 2>/dev/null && \
while read -r tmp; do
    printf "%q\n" "$tmp"
done <<< "$x"

Also not that file names can have newline characters in which a lot of this will break. Have not found a way to use \0 with compgen.

Best Answer

Related Solutions

Zsh autocomplete directory

Bash – Custom autocomplete: deal with spaces in filenames

Related Question