forked from QuTech-Delft/OpenQL
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
executable file
·314 lines (265 loc) · 12.8 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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
#!/usr/bin/env python3
import os, platform, shutil, sys, re
from setuptools import setup, Extension
from distutils.dir_util import copy_tree
from distutils import log
from distutils.command.clean import clean as _clean
from setuptools.command.build_ext import build_ext as _build_ext
from distutils.command.build import build as _build
from setuptools.command.install import install as _install
from distutils.command.bdist import bdist as _bdist
from wheel.bdist_wheel import bdist_wheel as _bdist_wheel
from distutils.command.sdist import sdist as _sdist
from setuptools.command.egg_info import egg_info as _egg_info
root_dir = os.getcwd() # root of the repository
src_dir = root_dir + os.sep + 'src' # C++ source directory
inc_dir = root_dir + os.sep + 'include' # C++ include directory
pysrc_dir = root_dir + os.sep + 'python' # Python source files
target_dir = root_dir + os.sep + 'pybuild' # python-specific build directory
build_dir = target_dir + os.sep + 'build' # directory for setuptools to dump various files into
dist_dir = target_dir + os.sep + 'dist' # wheel output directory
cbuild_dir = target_dir + os.sep + 'cbuild' # cmake build directory
prefix_dir = target_dir + os.sep + 'prefix' # cmake install prefix
srcmod_dir = pysrc_dir + os.sep + 'openql' # openql Python module directory, source files only
module_dir = target_dir + os.sep + 'openql' # openql Python module directory for editable install
# Copy the hand-written Python sources into the module directory that we're
# telling setuptools is our source directory, because setuptools insists on
# spamming output files into that directory. This is ugly, especially because
# it has to run before setup() is invoked, but seems to be more-or-less
# unavoidable to get editable installs to work.
if not os.path.exists(target_dir):
os.makedirs(target_dir)
copy_tree(srcmod_dir, module_dir)
def get_version(verbose=0):
""" Extract version information from source code """
matcher = re.compile('[\t ]*#define[\t ]+OPENQL_VERSION_STRING[\t ]+"(.*)"')
version = None
with open(os.path.join(inc_dir, 'ql', 'version.h'), 'r') as f:
for ln in f:
m = matcher.match(ln)
if m:
version = m.group(1)
break
if verbose:
print('get_version: %s' % version)
return version
def read(fname):
with open(os.path.join(os.path.dirname(__file__), fname)) as f:
return f.read()
class clean(_clean):
def run(self):
_clean.run(self)
if os.path.exists(target_dir):
shutil.rmtree(target_dir)
class build_ext(_build_ext):
def run(self):
from plumbum import local, FG, ProcessExecutionError
# If we were previously built in a different directory, nuke the cbuild
# dir to prevent inane CMake errors. This happens when the user does
# pip install . after building locally.
if os.path.exists(cbuild_dir + os.sep + 'CMakeCache.txt'):
with open(cbuild_dir + os.sep + 'CMakeCache.txt', 'r') as f:
for line in f.read().split('\n'):
line = line.split('#')[0].strip()
if not line:
continue
if line.startswith('OpenQL_BINARY_DIR:STATIC'):
config_dir = line.split('=', maxsplit=1)[1]
if os.path.realpath(config_dir) != os.path.realpath(cbuild_dir):
print('removing pybuild/cbuild to avoid CMakeCache error')
shutil.rmtree(cbuild_dir)
break
# Figure out how many parallel processes to build with.
if self.parallel:
nprocs = str(self.parallel)
else:
nprocs = os.environ.get('NPROCS', '1')
# Figure out how setuptools wants to name the extension file and where
# it wants to place it.
target = os.path.abspath(self.get_ext_fullpath('openql._openql'))
# Build the Python extension and "install" it where setuptools expects
# it.
if not os.path.exists(cbuild_dir):
os.makedirs(cbuild_dir)
with local.cwd(cbuild_dir):
build_type = os.environ.get('OPENQL_BUILD_TYPE', 'Release')
cmd = (local['cmake'][root_dir]
['-DOPENQL_BUILD_PYTHON=YES']
['-DCMAKE_INSTALL_PREFIX=' + prefix_dir]
['-DOPENQL_PYTHON_DIR=' + os.path.dirname(target)]
['-DOPENQL_PYTHON_EXT=' + os.path.basename(target)]
# Make sure CMake uses the Python installation corresponding
# with the the Python version we're building with now.
['-DPYTHON_EXECUTABLE=' + sys.executable]
# (ab)use static libs for the intermediate libraries to avoid
# dealing with R(UN)PATH nonsense on Linux/OSX as much as
# possible.
['-DBUILD_SHARED_LIBS=NO']
# Build type can be set using an environment variable.
['-DCMAKE_BUILD_TYPE=' + build_type]
# Do not include debug symbols in the wheels.
['-DOPENQL_DEBUG_SYMBOLS=OFF']
)
# If we're on Windows, we're probably building with MSVC. In that
# case, we might have to tell CMake whether we want to build for
# x86 or x64, but depending on how MSVC is configured, that same
# command-line option could also return an error. So we need to be
# careful here.
if platform.system() == 'Windows':
log.info('Trying to figure out bitness...')
# Figure out what CMake is doing by default.
if not os.path.exists('test-cmake-config'):
os.makedirs('test-cmake-config')
with local.cwd('test-cmake-config'):
local['cmake'][pysrc_dir + os.sep + 'compat' + os.sep + 'test-cmake-config'] & FG
with open('values.cfg', 'r') as f:
void_ptr_size, generator, *_ = f.read().split('\n')
cmake_is_64 = int(void_ptr_size.strip()) == 8
cmake_is_msvc = 'Visual Studio' in generator
msvc_is_fixed_to_64 = cmake_is_msvc and ('Win64' in generator or 'IA64' in generator)
# Figure out what Python needs.
python_is_64 = sys.maxsize > 2**32
log.info('Figured out the following things:')
log.info(' - Python is {}-bit'.format(64 if python_is_64 else 32))
log.info(' - CMake is building {}-bit by default'.format(64 if cmake_is_64 else 32))
log.info(' - CMake {} building using MSVC'.format('IS' if cmake_is_msvc else 'is NOT'))
log.info(' - MSVC {} fixed to 64-bit'.format('IS' if msvc_is_fixed_to_64 else 'is NOT'))
# If there's a mismatch, see what we can do.
if python_is_64 != cmake_is_64:
if msvc_is_fixed_to_64 and not python_is_64:
raise RuntimeError('MSVC is configured to build 64-bit binaries, but Python is 32-bit!')
if not cmake_is_msvc:
raise RuntimeError('Mismatch in 32-bit/64-bit between CMake defaults ({}) and Python install ({})!'.format(
'64-bit' if cmake_is_64 else '32-bit',
'64-bit' if python_is_64 else '32-bit'
))
# Looks like we're compiling with MSVC, and MSVC is merely
# defaulting to the wrong bitness, which means we should be
# able to change it with the -A flag.
if python_is_64:
cmd = cmd['-A']['x64']
else:
cmd = cmd['-A']['win32']
# Unitary decomposition can be disabled using an environment
# variable.
if 'OPENQL_DISABLE_UNITARY' in os.environ:
cmd = cmd['-DWITH_UNITARY_DECOMPOSITION=OFF']
# C++ tests can be enabled using an environment variable. They'll
# be run before the install.
if 'OPENQL_BUILD_TESTS' in os.environ:
cmd = cmd['-DOPENQL_BUILD_TESTS=ON']
# Run cmake configuration.
cmd & FG
# Do the build with the given number of parallel threads.
build_cmd = local['cmake']['--build']['.']['--config'][build_type]
cmd = build_cmd
if nprocs != '1':
try:
parallel_supported = tuple(local['cmake']('--version').split('\n')[0].split()[-1].split('.')) >= (3, 12)
except:
parallel_supported = False
if parallel_supported:
cmd = cmd['--parallel'][nprocs]
elif not sys.platform.startswith('win'):
cmd = cmd['--']['-j'][nprocs]
cmd & FG
# Run the C++ tests if requested.
if 'OPENQL_BUILD_TESTS' in os.environ:
cmd = build_cmd['--target']['test'] & FG
# Do the install.
try:
# install target for makefiles
build_cmd['--target']['install'] & FG
except ProcessExecutionError:
# install target for MSVC
build_cmd['--target']['INSTALL'] & FG
class build(_build):
def initialize_options(self):
_build.initialize_options(self)
self.build_base = os.path.relpath(build_dir)
def run(self):
# Make sure the extension is built before the Python module is "built",
# otherwise SWIG's generated module isn't included.
# See https://stackoverflow.com/questions/12491328
self.run_command('build_ext')
_build.run(self)
class install(_install):
def run(self):
# See https://stackoverflow.com/questions/12491328
self.run_command('build_ext')
_install.run(self)
class bdist(_bdist):
def finalize_options(self):
_bdist.finalize_options(self)
self.dist_dir = os.path.relpath(dist_dir)
class bdist_wheel(_bdist_wheel):
def run(self):
if platform.system() == "Darwin":
os.environ['MACOSX_DEPLOYMENT_TARGET'] = '10.10'
_bdist_wheel.run(self)
impl_tag, abi_tag, plat_tag = self.get_tag()
archive_basename = "{}-{}-{}-{}".format(self.wheel_dist_name, impl_tag, abi_tag, plat_tag)
wheel_path = os.path.join(self.dist_dir, archive_basename + '.whl')
if platform.system() == "Darwin":
from delocate.delocating import delocate_wheel
delocate_wheel(wheel_path)
class sdist(_sdist):
def finalize_options(self):
_sdist.finalize_options(self)
self.dist_dir = os.path.relpath(dist_dir)
class egg_info(_egg_info):
def initialize_options(self):
_egg_info.initialize_options(self)
self.egg_base = os.path.relpath(target_dir)
setup(
name='qutechopenql',
version=get_version(),
description='OpenQL Python Package',
long_description=read('README.md'),
long_description_content_type = 'text/markdown',
author='QuTech, TU Delft',
url='https://github.com/QuTech-Delft/OpenQL',
classifiers = [
'License :: OSI Approved :: Apache Software License',
'Operating System :: POSIX :: Linux',
'Operating System :: MacOS',
'Operating System :: Microsoft :: Windows',
'Programming Language :: Python :: 3 :: Only',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Topic :: Scientific/Engineering'
],
packages = ['openql'],
package_dir = {'': 'pybuild'},
# NOTE: the library build process is completely overridden to let CMake
# handle it; setuptools' implementation is horribly broken. This is here
# just to have the rest of setuptools understand that this is a Python
# module with an extension in it.
ext_modules = [
Extension('openql._openql', [])
],
cmdclass = {
'bdist': bdist,
'bdist_wheel': bdist_wheel,
'build_ext': build_ext,
'build': build,
'install': install,
'clean': clean,
'egg_info': egg_info,
'sdist': sdist,
},
setup_requires = [
'plumbum',
'delocate; platform_system == "Darwin"',
],
install_requires = [
'msvc-runtime; platform_system == "Windows"',
],
tests_require = [
'pytest', 'numpy'
],
zip_safe=False
)