AddonManager: fails to install Python dependencies when using AppImage

[quartzar]

Is there an existing issue for this?

• I have searched the existing issues

Problem description

When attempting to install an addon that requires the installation of a Python dependency (in the below case - pypresence), the dependency installation fails with the following message:

Failed to execute pip, which may be missing from your Python installation. 
Please ensure your system has pip installed and try again. The failed command was: 

/usr/bin/python3 -m pip --version

Continue with installation of FreecadDiscordPresence anyway?

Clicking "Continue" leads to an indefinite "Installing addon" pop-up, and pip eventually ends up timing out.

For avoidance of doubt, when running /usr/bin/python3 -m pip --version via a terminal I get this output:

❯ /usr/bin/python3 -m pip --version
pip 24.0 from /usr/lib/python3/dist-packages/pip (python 3.12)

Full version info

OS: Ubuntu 24.04.2 LTS (KDE/plasma/xcb)
Architecture: x86_64
Version: 1.0.0.39109 (Git) Conda AppImage
Build type: Release
Branch: (HEAD detached at 1.0.0)
Hash: 2fcc5317fe3aee96ca73475986a577719fc78e20
Python 3.11.9, Qt 5.15.13, Coin 4.0.3, Vtk 9.2.6, OCC 7.7.2
Locale: English/United Kingdom (en_GB)
Stylesheet/Theme/QtStyle: FreeCAD Dark.qss/FreeCAD Dark/Fusion

Subproject(s) affected?

Addon Manager

Anything else?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Syres916]

As a workaround you can try this as a macro (I assume pypresence is what you require in this instance):

module_to_install = "pypresence"
import os
import FreeCAD
import addonmanager_utilities as utils
vendor_path = utils.get_pip_target_directory()
args = ["install", "--disable-pip-version-check", "--target", vendor_path, module_to_install]
appimage = os.getenv("APPIMAGE")  
if appimage:
    python_exe = App.getHomePath() + "bin/python"
else:
    if hasattr(utils, "get_python_exe"):
        python_exe = utils.get_python_exe()
    else:
        from freecad.utils import get_python_exe
        python_exe = get_python_exe()
cmd = [python_exe, "-m", "pip"]
cmd.extend(args)
result = None
try:
    result = utils.run_interruptable_subprocess(cmd)
    FreeCAD.Console.PrintMessage("Install/Upgrade of " + module_to_install + " finished\n")
except:
    text = "Error trying to Install/Upgrade " + module_to_install + ". Please ensure pip is installed on your system and the module exists for this version of Python"
    FreeCAD.Console.PrintError(text + "\n")

[maxwxyz]

Which add-on was this?

[quartzar]

Thank you @Syres916, that worked.

@maxwxyz apologies, I didn't specify the add-on because the error came from the Python dependency - the add-on itself installs just fine. It was DiscordPresence.

Worth noting that I did not have this issue with the daily build from the Ubuntu PPA (though of course that is not an AppImage).

[maxwxyz]

@adrianinsaval any idea about this issue?

[Syres916]

@maxwxyz currently in the AddonManager, there's a specific check for Snap builds but there isn't a check for AppImage builds, the fact that my suggested code worked for @quartzar means https://github.com/FreeCAD/FreeCAD/blob/main/src/Mod/AddonManager/addonmanager_utilities.py#L555-L569 needs updating with the AppImage check after Snap but before 'standard' builds. I'll put a PR together and see whether @chennes agrees.

[chennes]

That snap code is actually wrong, I'm changing it now, so I can just add the appimage fix when I do that.

[chennes]

@Syres916 do you know if on the appimage pip is automatically adding the --user option? That's what was really broken on the Snap. If so, then the fix would look like:

def remove_target_option(args: List[str]) -> List[str]:
    # The Snap pip automatically adds the --user option, which is not compatible with the
    # --target option, so we have to remove --target and its argument, if present
    index = args.index("--target")
    if index:
        del args[index:index+1]  # The --target option and its argument
    return args

def create_pip_call(args: List[str]) -> List[str]:
    """Choose the correct mechanism for calling pip on each platform. It currently supports
    either `python -m pip` (most environments) or `pip` (Snap packages). Returns a list
    of arguments suitable for passing directly to subprocess.Popen and related functions."""
    snap_package = os.getenv("SNAP_REVISION")
    appimage = os.getenv("APPIMAGE")
    if snap_package:
        args = remove_target_option(args)
        call_args = ["pip", "--disable-pip-version-check"]
        call_args.extend(args)
    elif appimage:
        args = remove_target_option(args)
        python_exe = fci.DataPaths.home_dir + "bin/python"
        call_args = [python_exe, "-m", "pip", "--disable-pip-version-check"]
        call_args.extend(args)
    else:
        python_exe = get_python_exe()
        if not python_exe:
            raise RuntimeError("Could not locate Python executable on this system")
        call_args = [python_exe, "-m", "pip", "--disable-pip-version-check"]
        call_args.extend(args)
    return call_args

[Syres916]

@Syres916 do you know if on the appimage pip is automatically adding the --user option?

I believe not, using the 1.0 AppImage from mid November, the output of cmd and result don't have the --user switch.

The code above looks correct in that Python should be /tmp/.mount_Freexxxxxx/usr/bin/python

[chennes]

I'm not sure the option is actually visible in the snap, we just get an error about it when running. Can you try your last fix attempt, but add some random --target option to see if it runs? so pip install --target /home/whatever some_package?

[Syres916]

Still not seeing anything whether it can't create a folder or it can so it sounds Snap specific.

[chennes]

Great, thanks!