Skip to content

Improve messages and behaviour when detecting unhappy installation paths #516

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: dev
Choose a base branch
from
Open

Improve messages and behaviour when detecting unhappy installation paths #516

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
34 changes: 26 additions & 8 deletions khiops/core/internals/runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1076,12 +1076,31 @@ def _initialize_khiops_version(self):
error_msg += f"\nstderr: {stderr}" if stderr else ""
raise KhiopsRuntimeError(error_msg)

# Khiops core version
self._khiops_version = KhiopsVersion(khiops_version_str)

# Warn if the khiops version does not match the Khiops Python library version
# Note: Currently the check is very strict. It may be loosened in the future
# (major.minor.patch must be the same)
# Library version
compatible_khiops_version = khiops.get_compatible_khiops_version()

operating_system = platform.system()
installation_method = _infer_khiops_installation_method()

# Fail immediately if the major versions differ
# Note: the installation status will not show at all
if self.khiops_version.major != compatible_khiops_version.major:
raise KhiopsRuntimeError(
f"Major version '{self.khiops_version.major}' of the Khiops "
"executables does not match the Khiops Python library major version "
f"'{compatible_khiops_version.major}'. "
"To avoid any compatibility error, "
"please update either the Khiops "
f"executables package for your '{operating_system}' operating "
"system, or the Khiops Python library, "
f"according to your '{installation_method}' environment. "
"See https://khiops.org for more information.",
)

# Warn if the khiops version does not match the Khiops Python library version
# KhiopsVersion implements the equality operator, which however also
# takes pre-release tags into account.
# The restriction here does not apply to pre-release tags
Expand All @@ -1094,8 +1113,6 @@ def _initialize_khiops_version(self):
compatible_khiops_version.minor,
compatible_khiops_version.patch,
):
operating_system = platform.system()
installation_method = _infer_khiops_installation_method()
warnings.warn(
f"Version '{self._khiops_version}' of the Khiops executables "
"does not match the Khiops Python library version "
Expand Down Expand Up @@ -1160,8 +1177,9 @@ def _detect_library_installation_incompatibilities(self, library_root_dir):
f"Khiops Python library installation path '{library_root_dir}' "
"does not match the current Conda environment "
f"'{os.environ['CONDA_PREFIX']}'. "
"Please install the Khiops Python library "
"in the current Conda environment. "
"Either deactivate the current Conda environment "
"or use the Khiops Python library "
"belonging to the current Conda environment. "
"Go to https://khiops.org for instructions.\n"
)
error_list.append(error)
Expand All @@ -1172,7 +1190,7 @@ def _detect_library_installation_incompatibilities(self, library_root_dir):
f"Khiops binary path '{self.khiops_path}' "
"does not match the current Conda environment "
f"'{os.environ['CONDA_PREFIX']}'. "
"Please install the Khiops binary "
"We recommend installing the Khiops binary "
"in the current Conda environment. "
"Go to https://khiops.org for instructions.\n"
)
Expand Down
Loading