global bash completion breaks completion for some PHP scripts

[hroncok]

Hello,

in Fedora, we got a report from the PHP maintainer that globally installed argcomplete bash completion interferes with completion of some PHP scripts.

To reproduce with pip-installed argcomplete, you need to have some PHP scripts installed. E.g. pie on Fedora 41:

$ podman run --rm -ti fedora:41 /usr/bin/bash
...
# dnf -y install bash-completion pip pie
...
# bash          # this is needed to make bash-completion of pie work
# pie lis[tab]  # completes to: pie list

# pip install argcomplete
...
Successfully installed argcomplete-3.6.2
...
# activate-global-python-argcomplete
...
# exit
# bash
# pie lis[tab]  # completes to nothing

[hroncok]

The assumption is that the problem is in here:

argcomplete/argcomplete/bash_completion.d/_python-argcomplete

Lines 196 to 198 in ab03e8a

	elif __python_argcomplete_run "${interpreter[@]}" -m argcomplete._check_console_script "$SCRIPT_NAME"; then
	ARGCOMPLETE=1
	fi

As php -m argcomplete._check_console_script pie exits with 0.

[remicollet]

Checking if interpreter is python is a possible fix (but I don't know a lot about other possible python interpreters, and I'm not a bash_completion expert)

            elif "${interpreter[@]}" --version 2>/dev/null | grep -qi python \
                && __python_argcomplete_run "${interpreter[@]}" -m argcomplete._check_console_script "$SCRIPT_NAME"; then

[hroncok]

A similar check already exists in

argcomplete/argcomplete/bash_completion.d/_python-argcomplete

Line 154 in ab03e8a

if [[ "$executable" == python* ]] || [[ "$executable" == pypy* ]]; then

but this is in an elif branch of that check. Adding that grep would effectively mean that it never happens.

[hroncok]

I don't really understand what is the purpose of the elif branch -- scripts with non-Python shebangs using argcomplete?

[hroncok]

Adding that grep would effectively mean that it never happens.

Actually, I was wrong, executable != interpreter. Sorry about that.

[hroncok]

A check for the interpreter's name seems to work.

Not sure if running the interper with --version and grepping it for python (as suggested by @remicollet) is better or worse.

--- a/argcomplete/bash_completion.d/_python-argcomplete
+++ b/argcomplete/bash_completion.d/_python-argcomplete
@@ -193,7 +193,8 @@ _python_argcomplete_global() {
             if (__python_argcomplete_scan_head_noerr "$SCRIPT_NAME" easy_install \
                 && "${interpreter[@]}" "$(__python_argcomplete_which python-argcomplete-check-easy-install-script)" "$SCRIPT_NAME") >/dev/null 2>&1; then
                 ARGCOMPLETE=1
-            elif __python_argcomplete_run "${interpreter[@]}" -m argcomplete._check_console_script "$SCRIPT_NAME"; then
+            elif ([[ "${interpreter[@]}" == *python* ]] || [[ "${interpreter[@]}" == *pypy* ]])\
+                && __python_argcomplete_run "${interpreter[@]}" -m argcomplete._check_console_script "$SCRIPT_NAME"; then
                 ARGCOMPLETE=1
             fi
         fi

[remicollet]

Not sure if running the interper with --version and prepping it for python (as suggested by @remicollet) is better or worse.

Not calling the interper, only checking its name (so your proposal), will be faster

[kislyuk]

Thanks @hroncok, I think I understand the issue and will apply your patch shortly.

[hroncok]

I can send a PR if you want.

[kislyuk]

I would love that, please go ahead.

[hroncok]

#536