23.2: Unable to add zsh completion as documented

[mostpinkest]

Description

Attempting to follow the steps in the documentation for adding zsh shell completion raises an error regarding the use of compadd outside of a completion function. This seems to be new with 23.2 and added in #11417.

Expected behavior

As in previous versions, following the documented steps should successfully add completion for pip.

pip version

23.2

Python version

3.11.4

OS

macOS 12.6.8

How to Reproduce

As documented:

1. Execute python -m pip completion --zsh >> ~/.zprofile or add eval "pip completion --zsh" to .zprofile or .zshrc
2. Start a new shell

Output

From startup:

/dev/fd/16:compadd:4: can only be called from completion function

Code of Conduct

• I agree to follow the PSF Code of Conduct.

[sbidoul]

@Freed-Wu as author of the mentioned pr what do you think of this issue?

[Freed-Wu]

Try:

$ python -m pip completion --zsh | tail -n+3 | tee /usr/share/zsh/site-functions/_pip
#compdef -P pip[0-9.]#
compadd $( COMP_WORDS="$words[*]" \
           COMP_CWORD=$((CURRENT-1)) \
           PIP_AUTO_COMPLETE=1 $words[1] 2>/dev/null )
# pip zsh completion end

[Freed-Wu]

A better solution is https://github.com/pallets/click/pull/2544/files

[Freed-Wu]

I will create a new PR to refer https://github.com/pallets/click/pull/2544/files to make python -m pip completion --zsh > ~/.zprofile work.

[shimamizu]

I'm still battling this issue, I updated click but still no luck. Are there still other merges pending to fix this? @Freed-Wu

[mweaver-ozette]

Still seeing same issue here

% eval "`pip completion --zsh`"
compadd: can only be called from completion function
% pip --version
pip 23.2.1 from /usr/local/lib/python3.8/dist-packages/pip (python 3.8)
% lsb_release -ds
Ubuntu 20.04.6 LTS

[mweaver-ozette]

Still seeing same issue here

Nvm, I see this isn't merged.

My workaround, following freed's commit. In case it's useful to anyone until this fix gets released:

In .zshrc:
source ~/tmp/pip-completions.sh,
where ~/tmp/pip-completion.sh contains

# From
# https://github.com/Freed-Wu/pip/commit/9491f0a426b48b28c7e10d19c70a0536d969e94f
#compdef -P pip[0-9.]#
__pip() {{
            compadd $( COMP_WORDS="$words[*]" \
                       COMP_CWORD=$((CURRENT-1)) \
                       PIP_AUTO_COMPLETE=1 $words[1] 2>/dev/null )
        }}
if [[ $zsh_eval_context[-1] == loadautofunc ]]; then
    # autoload from fpath, call function directly
    __pip "$@"
else
    # eval/source/. command, register function for later
    compdef __pip -P pip
    compdef __pip -P pip3
fi

[henry0312]

A sly workaround would be pip install pip==23.1.2 😇

[Freed-Wu]

I'm still battling this issue, I updated click but still no luck

It's not related to click. I just copy some code from them.

My workaround, following freed's commit.

You are right.

$ man zshall | sed -n '10311p'
              If  the  #compdef line contains one of the options -p or -P, the words following are taken to be patterns.  The function will be called when com‐

#compdef __pip -P 'pip[0-9.]#' call zsh to complete pip, pip3, pip3.11, etc by function __pip(). It should be better than your

    compdef __pip -P pip
    compdef __pip -P pip3