Get pytest autocompletion in zshell

Question

This question may be better suited for superuser — if that’s the case let me know and I’ll shift it.

I use zsh and frequently run pytest from the command line. A very common situation is that I need to run a specific test (or a subtest of a class).

The former looks something like

pytest test/test_foo_file.py::test_foo_function

and the latter something like

pytest test/test_foo_file.py::FooClassTest::test_specific_functionality

It’s kind of a pain to write out the entire exact class and test name, and this seems like something ripe for autocompletion or fuzzysearching of some kind. I’ve been unable to achieve this with what I’ve found researching — does anyone have any recommendations?

Let me know if I can be more specific in any way.

Asked By: Peter Dolan

||

Source

Answer 1

Disclaimer: I am not a zsh user, but the approach is pretty much similar to the customizing of bash completions:

Create a custom completion file, e.g.

$ mkdir ~/.zsh-completions
$ touch ~/.zsh-completions/_pytest

Inside ~/.zsh-completions/_pytest, write the completion function:

#compdef pytest

_pytest_complete() {
    local curcontext="$curcontext" state line
    typeset -A opt_args
    compadd "$@" $( pytest --collect-only -q | head -n -2)
}

_pytest_complete "$@"

Adjust .zshrc to include custom completions, e.g.

fpath=(~/.zsh-completions $fpath)
autoload -U compinit
compinit
zstyle ':completion:*' menu select=2

Restart the shell. Now you should get the single tests selection on tab completion:

The crucial command here is

$ pytest --collect-only -q | head -n -2

which collects the tests in current directory and lists their names ready to be passed as command line arguments.

Answered By: hoefling

Answer 2

Like others in the comments, I have noticed that pytest --collect-only -q takes a long time to load.

As an alternative, I wrote my own pytest function collector which is much faster.

#compdef pytest

function quick_collect_pytests {
    RES=$(rg "^def (test_.*)(" --no-heading)

    IFS=$'n'
    for res in $RES; do
      echo $res | awk '{
        if (match($0, /(.*test_.*):def (.*)(/, groups)) {
          print groups[1] "::" groups[2]
        }
      }'
    done
}

_pytest_complete() {
    local curcontext="$curcontext" state line
    typeset -A opt_args
    compadd "$@" $( quick_collect_pytests)
}
_pytest_complete "$@"

Feel free to give it a go and let me know if you see any potential improvements.

Answered By: Yann Hoffmann

Get pytest autocompletion in zshell

Question:

Answers: