-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
setup.py
233 lines (189 loc) · 7.71 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# -*- coding: utf-8 -*-
""" Vowpal Wabbit python setup module """
import distutils.dir_util
import os
import platform
import sys
from codecs import open
from distutils.command.clean import clean as _clean
from distutils.sysconfig import get_python_inc
from setuptools import setup, Extension, find_packages, Distribution as _distribution
from setuptools.command.build_ext import build_ext as _build_ext
from setuptools.command.sdist import sdist as _sdist
from setuptools.command.install_lib import install_lib as _install_lib
from shutil import rmtree
import multiprocessing
system = platform.system()
version_info = sys.version_info
here = os.path.abspath(os.path.dirname(__file__))
pkg_path = os.path.join(here, "python")
class Distribution(_distribution):
global_options = _distribution.global_options
global_options += [
("enable-boost-cmake", None, "Enable boost-cmake"),
(
"cmake-options=",
None,
"Additional semicolon-separated cmake setup options list",
),
("cmake-generator=", None, "CMake generator to use"),
("debug", None, "Debug build"),
]
if system == "Windows":
global_options += [
("vcpkg-root=", None, "Path to vcpkg root. For Windows only"),
]
def __init__(self, attrs=None):
self.vcpkg_root = None
self.enable_boost_cmake = None
self.cmake_options = None
self.cmake_generator = None
self.debug = False
_distribution.__init__(self, attrs)
class CMakeExtension(Extension):
def __init__(self, name):
# don't invoke the original build_ext for this special extension
Extension.__init__(self, name, sources=[])
class BuildPyLibVWBindingsModule(_build_ext):
def run(self):
for ext in self.extensions:
self.build_cmake(ext)
_build_ext.run(self)
def build_cmake(self, ext):
# Make build directory
distutils.dir_util.mkpath(self.build_temp)
# Ensure lib output directory is made
lib_output_dir = os.path.join(
here, os.path.dirname(self.get_ext_fullpath(ext.name))
)
distutils.dir_util.mkpath(lib_output_dir)
# example of cmake args
config = "Debug" if self.distribution.debug else "Release"
cmake_args = [
"-DCMAKE_BUILD_TYPE=" + config,
"-DPY_VERSION=" + "{v[0]}.{v[1]}".format(v=version_info),
"-DBUILD_PYTHON=On",
"-DBUILD_TESTING=Off",
"-DWARNINGS=Off",
"-DVW_FEAT_CB_GRAPH_FEEDBACK=On",
"-DSTD_INV_SQRT=On",
]
# This doesn't work as expected for Python3.6 and 3.7 on Windows.
# See bug: https://bugs.python.org/issue39825
if system == "Windows" and sys.version_info.minor < 8:
from distutils import sysconfig as distutils_sysconfig
required_shared_lib_suffix = distutils_sysconfig.get_config_var(
"EXT_SUFFIX"
)
else:
import sysconfig
required_shared_lib_suffix = sysconfig.get_config_var("EXT_SUFFIX")
if required_shared_lib_suffix is not None:
cmake_args += [
"-DVW_PYTHON_SHARED_LIB_SUFFIX={}".format(required_shared_lib_suffix)
]
if self.distribution.enable_boost_cmake is None:
# Add this flag as default since testing indicates its safe.
# But add a way to disable it in case it becomes a problem
cmake_args += ["-DBoost_NO_BOOST_CMAKE=ON"]
if self.distribution.cmake_options is not None:
argslist = self.distribution.cmake_options.split(";")
cmake_args += argslist
# If we are being installed in a conda environment then use the dependencies from there.
if "CONDA_PREFIX" in os.environ:
cmake_args.append(
"-DCMAKE_PREFIX_PATH={}".format(os.environ["CONDA_PREFIX"])
)
cmake_args.append("-DPython_INCLUDE_DIR={}".format(get_python_inc()))
# example of build args
build_args = ["--config", config]
cmake_generator = self.distribution.cmake_generator
if system == "Windows":
cmake_args += [
"-DCMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG=" + str(lib_output_dir),
"-DCMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE=" + str(lib_output_dir),
]
if cmake_generator is None:
cmake_generator = "Visual Studio 15 2017 Win64"
build_args += ["--target", "pylibvw"]
if self.distribution.vcpkg_root is not None:
# add the vcpkg toolchain if its provided
abs_vcpkg_path = os.path.abspath(self.distribution.vcpkg_root)
vcpkg_toolchain = os.path.join(
abs_vcpkg_path, "scripts", "buildsystems", "vcpkg.cmake"
)
cmake_args += ["-DCMAKE_TOOLCHAIN_FILE=" + vcpkg_toolchain]
else:
cmake_args += [
"-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=" + str(lib_output_dir),
]
build_args += [
"--",
"-j{}".format(multiprocessing.cpu_count()),
# Build the pylibvw target
"pylibvw",
]
if cmake_generator is not None:
cmake_args += ["-G", cmake_generator]
if cmake_generator == "Visual Studio 16 2019":
# The VS2019 generator now uses the -A option to select the toolchain's architecture
cmake_args += ["-Ax64"]
os.chdir(str(self.build_temp))
self.spawn(["cmake"] + cmake_args + [str(here)])
if not self.dry_run:
self.spawn(["cmake", "--build", "."] + build_args)
os.chdir(str(here))
class Clean(_clean):
"""Clean up after building python package directories"""
def run(self):
rmtree(os.path.join(here, "dist"), ignore_errors=True)
rmtree(os.path.join(here, "build"), ignore_errors=True)
rmtree(os.path.join(here, "vowpalwabbit.egg-info"), ignore_errors=True)
_clean.run(self)
class Sdist(_sdist):
def run(self):
_sdist.run(self)
class InstallLib(_install_lib):
def build(self):
_install_lib.build(self)
# Get the long description from the README file
with open(os.path.join(pkg_path, "README.rst"), encoding="utf-8") as f:
long_description = f.read()
# Get the current version for the python package from the configure.ac file
config_path = os.path.join(here, "version.txt")
with open(config_path, encoding="utf-8") as f:
version = f.readline().strip()
setup(
name="vowpalwabbit",
version=version,
python_requires=">=3.6",
description="Vowpal Wabbit Python package",
long_description_content_type="text/x-rst",
long_description=long_description,
url="https://github.com/VowpalWabbit/vowpal_wabbit",
author="Scott Graham",
author_email="scott.d.graham@gmail.com",
license="BSD 3-Clause License",
classifiers=[
"Development Status :: 4 - Beta",
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Information Analysis",
"License :: OSI Approved :: BSD License",
"Programming Language :: Python :: 3",
],
keywords="fast machine learning online classification regression",
package_dir={"": os.path.relpath(pkg_path)},
packages=find_packages(where=pkg_path),
platforms="any",
zip_safe=False,
include_package_data=True,
ext_modules=[CMakeExtension("pylibvw")],
distclass=Distribution,
cmdclass={
"build_ext": BuildPyLibVWBindingsModule,
"clean": Clean,
"sdist": Sdist,
"install_lib": InstallLib,
},
)