65 lines
2.5 KiB
Python
65 lines
2.5 KiB
Python
# coding: utf-8
|
|
"""Find the path to xgboost dynamic library files."""
|
|
|
|
import os
|
|
import platform
|
|
from typing import List
|
|
import sys
|
|
|
|
|
|
class XGBoostLibraryNotFound(Exception):
|
|
"""Error thrown by when xgboost is not found"""
|
|
|
|
|
|
def find_lib_path() -> List[str]:
|
|
"""Find the path to xgboost dynamic library files.
|
|
|
|
Returns
|
|
-------
|
|
lib_path
|
|
List of all found library path to xgboost
|
|
"""
|
|
curr_path = os.path.dirname(os.path.abspath(os.path.expanduser(__file__)))
|
|
dll_path = [
|
|
# normal, after installation `lib` is copied into Python package tree.
|
|
os.path.join(curr_path, 'lib'),
|
|
# editable installation, no copying is performed.
|
|
os.path.join(curr_path, os.path.pardir, os.path.pardir, 'lib'),
|
|
# use libxgboost from a system prefix, if available. This should be the last
|
|
# option.
|
|
os.path.join(sys.prefix, 'lib'),
|
|
]
|
|
|
|
if sys.platform == 'win32':
|
|
if platform.architecture()[0] == '64bit':
|
|
dll_path.append(
|
|
os.path.join(curr_path, '../../windows/x64/Release/'))
|
|
# hack for pip installation when copy all parent source
|
|
# directory here
|
|
dll_path.append(os.path.join(curr_path, './windows/x64/Release/'))
|
|
else:
|
|
dll_path.append(os.path.join(curr_path, '../../windows/Release/'))
|
|
# hack for pip installation when copy all parent source
|
|
# directory here
|
|
dll_path.append(os.path.join(curr_path, './windows/Release/'))
|
|
dll_path = [os.path.join(p, 'xgboost.dll') for p in dll_path]
|
|
elif sys.platform.startswith(('linux', 'freebsd', 'emscripten')):
|
|
dll_path = [os.path.join(p, 'libxgboost.so') for p in dll_path]
|
|
elif sys.platform == 'darwin':
|
|
dll_path = [os.path.join(p, 'libxgboost.dylib') for p in dll_path]
|
|
elif sys.platform == 'cygwin':
|
|
dll_path = [os.path.join(p, 'cygxgboost.dll') for p in dll_path]
|
|
|
|
lib_path = [p for p in dll_path if os.path.exists(p) and os.path.isfile(p)]
|
|
|
|
# XGBOOST_BUILD_DOC is defined by sphinx conf.
|
|
if not lib_path and not os.environ.get('XGBOOST_BUILD_DOC', False):
|
|
link = 'https://xgboost.readthedocs.io/en/latest/build.html'
|
|
msg = 'Cannot find XGBoost Library in the candidate path. ' + \
|
|
'List of candidates:\n- ' + ('\n- '.join(dll_path)) + \
|
|
'\nXGBoost Python package path: ' + curr_path + \
|
|
'\nsys.prefix: ' + sys.prefix + \
|
|
'\nSee: ' + link + ' for installing XGBoost.'
|
|
raise XGBoostLibraryNotFound(msg)
|
|
return lib_path
|