Detect "unhappy" installation states

[tramora]

• Warn when the version tuple (major, minor, patch) of Khiops does not match the Khiops Python library one
• Fix the types of the returned objects in _build_status_message
• Detect when the library is installed by something else than conda in a conda environment
• Detect when the conda execution environment does not match the installation one

---

TODO Before Asking for a Review

• [ X] Rebase your branch to the latest version of dev (or main for release PRs)
• Make sure all CI workflows are green
• When adding a public feature/fix: Update the Unreleased section of CHANGELOG.md (no date)
• Self-Review: Review "Files Changed" tab and fix any problems you find
• API Docs (only if there are changes in docstrings, rst files or samples):
  • Check the docs build without warning: see the log of the API Docs workflow
  • Check that your changes render well in HTML: download the API Docs artifact and open index.html
  • If there are any problems it is faster to iterate by building locally the API Docs

[popescu-v]

A few comments. The main point of these comments is that the unhappy installation paths are:

• partial installations:
  • the Python lib is present, but the binaries are missing;
• hybrid installations:
  • the binaries are installed in a Conda env (via the khiops-core package), but the Python lib is installed via Pip;
  • the binaries are installed system-wide, but the Python lib is installed in a Conda env (e.g. the khiops-core package has been uninstalled by the user);
  • the binaries are installed system-wide and the Python package is installed via Pip, but their versions are not compatible at the major.minor.patch level.
  • the binaries and the Python package are installed in a Conda env, but the binaries package got updated, alone, to a future, incompatible version (the Python lib package kept the initial version).

The following are not necessarily "unhappy" IMHO:

• fully-compatible binary + pip installation, run from within a Conda environment (with no binaries or Python library installed in that Conda environment);
• [with less certainty?] fully-compatible full Conda installation inside a Conda env, run from a virtualenv that is activated inside that Conda env (that is, in a shell where the Conda env is also activated), with no Khiops Python library installed in that virtualenv.

[popescu-v]

Perhaps perform a 3-times check of "happy path":

1. Check that Python executable path matches khiops __file__;
2. If so, then check that khiops __file__ also matches (relevant part of) CONDA_PREFIX if defined;
3. If so, then check that Khiops executable path matches (relevant part of) CONDA_PREFIX ?

Any else is an unhappy path, if CONDA_PREFIX is defined.

[tramora]

Perhaps perform a 3-times check of "happy path":

1. Check that Python executable path matches khiops `__file__`;

After a few attempts it seems that this check is pointless and a big hassle. Pointless because if a wrong python interpreter is used it wouldn't find the correct library (and digging programmatically from the python library for the python executable will lead to the sys.executable). A big hassle because of the OS specificities ('Scripts' folder for Windows instead of 'bin' for example)

2. If so, then check that khiops `__file__` also matches (relevant part of) `CONDA_PREFIX` if defined;

Indeed. This check is performed.

3. If so, then check that Khiops executable path matches (relevant part of) `CONDA_PREFIX` ?

Indeed. This check is performed.

Any else is an unhappy path, if CONDA_PREFIX is defined.

[popescu-v]

Perhaps perform a 3-times check of "happy path":

1. Check that Python executable path matches khiops `__file__`;

After a few attempts it seems that this check is pointless and a big hassle. Pointless because if a wrong python interpreter is used it wouldn't find the correct library (and digging programmatically from the python library for the python executable will lead to the sys.executable). A big hassle because of the OS specificities ('Scripts' folder for Windows instead of 'bin' for example)

Wouldn't this accommodate both Windows and Linux: khiops.__file__.startswith(str(pathlib.Path(sys.executable).parents[1]))?
Because otherwise, how do we make sure, if not in a Conda env, that we don't launch a Virtualenv-based Python which imports a system-wide installed Khiops?

2. If so, then check that khiops `__file__` also matches (relevant part of) `CONDA_PREFIX` if defined;

Indeed. This check is performed.

3. If so, then check that Khiops executable path matches (relevant part of) `CONDA_PREFIX` ?

Indeed. This check is performed.

Any else is an unhappy path, if CONDA_PREFIX is defined.

[popescu-v]

Add warning on Windows system-wide MPI precedence over Conda MPI: https://github.com/conda-forge/msmpi-feedstock/blob/32bc89b1b104dd158a12b161ae2384d5a8a5642c/recipe/activate.bat#L7

[tramora]

Add warning on Windows system-wide MPI precedence over Conda MPI: https://github.com/conda-forge/msmpi-feedstock/blob/32bc89b1b104dd158a12b161ae2384d5a8a5642c/recipe/activate.bat#L7

This case is addressed now

[popescu-v]

Also, add support for pip install --user (intermediate between global, system-wide install, and in-virtualenv install).

[tramora]

Also, add support for pip install --user (intermediate between global, system-wide install, and in-virtualenv install).

This "User site" installation is handled now (as an happy path). As a consequence, api docs build does not require any longer a virtual env. Thus, this specific modification in the api-docs.yml was reverted

[popescu-v]

Technically, LGTM.
See however a few minor comments (nice to have fixed IMHO).
Also update commit message line:
"- Detect installation incompatibilities in a system-wide pip installation" to
"- Detect installation incompatibilities in a system-wide or user-site pip installation"

[popescu-v]

Add specific user warning if installation type is "unknown" because package metadata is missing (see https://github.com/KhiopsML/khiops-python/pull/402/files#r2284574608 ).

[tramora]

Add specific user warning if installation type is "unknown" because package metadata is missing (see https://github.com/KhiopsML/khiops-python/pull/402/files#r2284574608 ).

Warning added

[tramora]

Technically, LGTM. See however a few minor comments (nice to have fixed IMHO). Also update commit message line: "- Detect installation incompatibilities in a system-wide pip installation" to "- Detect installation incompatibilities in a system-wide or user-site pip installation"

Commit message updated

[popescu-v]

LGTM. The full tests pass; all workflows pass. Can be merged after rebase on dev IMHO.