Skip to content

Suppress a warning when 'uv' is used instead of 'pip' #618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tramora wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −21
Open

Suppress a warning when 'uv' is used instead of 'pip' #618

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 24 additions & 21 deletions khiops/core/internals/runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,12 +244,12 @@ def _infer_khiops_installation_method(trace=False):
it was not activated previously nor during the execution
and thus the CONDA_PREFIX environment variable is undefined
and the path to the `bin` directory inside the conda environment is not in PATH
- 'pip' environment containing binaries, shared libraries and the Python libraries
can either be:
- system-wide (strongly discouraged)
- 'pip-uv' environment containing binaries, shared libraries and
the Python libraries can either be:
- system-wide (strongly discouraged) -- applicable for 'pip' only
- or in the Python folder inside the home directory of the user
(a.k.a. "User site")
- or in a classical virtual environment (highly encouraged)
(a.k.a. "User site") -- applicable for 'pip' only
- or in a classical virtual environment (highly encouraged) -- for 'pip' and 'uv'

"""
# We are in a Conda environment if
Expand Down Expand Up @@ -279,10 +279,10 @@ def _infer_khiops_installation_method(trace=False):
):
installation_method = "conda-based"
else:
installation_method = "pip"
installation_method = "pip-uv"
if trace:
print(f"Installation method: '{installation_method}'")
assert installation_method in ("conda", "conda-based", "pip")
assert installation_method in ("conda", "conda-based", "pip-uv")
return installation_method


Expand All @@ -301,7 +301,7 @@ def _get_current_library_installer():
Returns
-------
str
installer name among : 'pip', 'conda' or 'unknown'
installer name among : 'pip', 'uv', 'conda' or 'unknown'
"""

try:
Expand All @@ -323,12 +323,12 @@ def _get_current_library_installer():
warnings.warn(
"The python library metadata exists ('khiops-*.dist-info') "
"but seems corrupted as no INSTALLER file can be found. "
"Please re-install using the same tool ('conda' or 'pip').",
"Please re-install using the same tool ('conda', 'pip' or 'uv').",
stacklevel=3,
)
return "unknown"
except PackageNotFoundError:
# The python library is not installed via standard tools like conda, pip...
# The python library is not installed via standard tools like conda, pip, uv
return "unknown"


Expand Down Expand Up @@ -968,7 +968,7 @@ def _initialize_khiops_environment(self):
# In an activated conda environment, khiops_env is in PATH.
case "conda":
khiops_env_path = self._infer_khiops_env_from_path(installation_method)
case "pip":
case "pip-uv":
# Ensure the binary dependency is still installed.
try:
distribution("khiops-core")
Expand All @@ -978,12 +978,12 @@ def _initialize_khiops_environment(self):
"Re-install the Khiops Python library to automatically install "
"Khiops. Go to https://khiops.org for more information.\n"
) from exc
# On Windows, determine the Scripts directory where pip placed
# On Windows, determine the Scripts directory where pip or uv placed
# khiops_env.cmd.
# If this library is installed under the user site-packages
# directory, khiops-core (and its khiops_env.cmd) was also installed
# there with `pip install --user`, so use the user Scripts directory.
# Otherwise use the standard Scripts directory (venv or system-wide
# Otherwise, use the standard Scripts directory (venv or system-wide
# install). This avoids an ambiguous search and mirrors how pip
# resolves scripts.
if platform.system() == "Windows":
Expand All @@ -1000,7 +1000,7 @@ def _initialize_khiops_environment(self):
"Make sure you have installed Khiops properly. "
"Go to https://khiops.org for more information."
)
# On UNIX, pip places khiops_env in the bin directory,
# On UNIX, pip or uv places khiops_env in the bin directory,
# which is in PATH.
else:
khiops_env_path = self._infer_khiops_env_from_path(
Expand Down Expand Up @@ -1053,7 +1053,10 @@ def _initialize_khiops_environment(self):
# "KHIOPS_MPI_DLL_PATH" (containing the Intel MPI Library)
# must be added to "PATH" otherwise Khiops wouldn't find it
# and fail immediately
elif installation_method == "pip" and var_name == "KHIOPS_MPI_DLL_PATH":
elif (
installation_method == "pip-uv"
and var_name == "KHIOPS_MPI_DLL_PATH"
):
os.environ["PATH"] = os.pathsep.join(
[var_value, os.environ.get("PATH")]
)
Expand Down Expand Up @@ -1192,7 +1195,7 @@ def _detect_library_installation_incompatibilities(self, library_root_dir_path):
"Go to https://khiops.org for instructions.\n"
)
error_list.append(error)
# 'pip', 'conda-based' or borderline installations
# 'pip-uv', 'conda-based' or borderline installations
else:

# ensure a known installer was used otherwise unexpected issues can occur
Expand All @@ -1203,19 +1206,19 @@ def _detect_library_installation_incompatibilities(self, library_root_dir_path):
if caught_warnings is not None:
# caught_warnings contains a list of WarningMessage
warning_list.extend([w.message for w in caught_warnings])
if current_library_installer not in ("conda", "pip"):
if current_library_installer not in ("conda", "pip", "uv"):
warning = (
"Khiops Python library "
"was not installed with 'conda' or 'pip' "
"was not installed with 'conda', 'pip' or 'uv' "
f"but with '{current_library_installer}' installer. "
"This will probably lead to unexpected errors. "
"Go to https://khiops.org for instructions to re-install it.\n"
)
warning_list.append(warning)

# we consider only the 'pip' and 'conda-based' installations here
# we consider only the 'pip-uv' and 'conda-based' installations here
# - 'conda-based' installation (similar to a non-activated virtual env)
# - 'pip' installation under a virtual env
# - 'pip' or 'uv' installation under a virtual env
# - User site 'pip' installation (without virtual env)
# - system-wide 'pip' installation (without virtual env)...
# (an empty string means a borderline installation was found,
Expand All @@ -1242,7 +1245,7 @@ def _detect_library_installation_incompatibilities(self, library_root_dir_path):
and
# Under Windows, there are two cases :
# for conda-based installations python is inside 'base_dir'
# for 'pip' installations (within a virtual env)
# for 'pip-uv' installations (within a virtual env)
# python is inside 'base_dir'/Scripts
base_dir_path
not in (
Expand Down
Loading