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
|
#!/usr/bin/env python3
"""
Implements a custom build_ext replacement, which handles the
full extension module build process, from api_gen to C compilation and
linking.
"""
import copy
import sys
import sysconfig
import os
import os.path as op
import platform
from pathlib import Path
from Cython import Tempita as tempita
from setuptools import Extension
from setuptools.command.build_ext import build_ext
import api_gen
from setup_configure import BuildConfig
# set flavour to 'pre_h5py_suf' to enable alternative builds e.g. _debian_h5py_mpi
flavour=''
def localpath(*args):
return op.abspath(op.join(op.dirname(__file__), *args))
MODULES = ['defs', '_errors', '_objects', '_proxy', 'h5fd', 'h5z',
'h5', 'h5i', 'h5r', 'utils', '_selector',
'_conv', 'h5t', 'h5s',
'h5p',
'h5d', 'h5a', 'h5f', 'h5g',
'h5l', 'h5o',
'h5ds', 'h5ac',
'h5pl']
MODULES_NUMPY2_ONLY = ['_npystrings']
ALL_MODULES = MODULES + MODULES_NUMPY2_ONLY + ["api_types_ext", "api_types_hdf5"]
COMPILER_SETTINGS = {
'libraries' : ['hdf5', 'hdf5_hl'],
'include_dirs' : [localpath('lzf')],
'library_dirs' : [],
'define_macros' : [('H5_USE_110_API', None),
# The definition should imply the one below, but CI on
# Ubuntu 20.04 still gets H5Rdereference1 for some reason
('H5Rdereference_vers', 2),
('NPY_NO_DEPRECATED_API', 0),
]
}
EXTRA_SRC = {'h5z': [ localpath("lzf/lzf_filter.c") ]}
# Set the environment variable H5PY_SYSTEM_LZF=1 if we want to
# use the system lzf library
if os.environ.get('H5PY_SYSTEM_LZF', '0') == '1':
EXTRA_LIBRARIES = {
'h5z': [ 'lzf' ]
}
COMPILER_SETTINGS['include_dirs'].append('/usr/include/liblzf')
else:
COMPILER_SETTINGS['include_dirs'] += [localpath('lzf/lzf')]
EXTRA_SRC['h5z'] += [localpath("lzf/lzf/lzf_c.c"),
localpath("lzf/lzf/lzf_d.c")]
EXTRA_LIBRARIES = {}
if sys.platform.startswith('win'):
COMPILER_SETTINGS['include_dirs'].append(localpath('windows'))
COMPILER_SETTINGS['define_macros'].extend([
('_HDF5USEDLL_', None),
('H5_BUILT_AS_DYNAMIC_LIB', None)
])
class h5py_build_ext(build_ext):
"""
Custom setuptools command which encapsulates api_gen pre-building,
Cython building, and C compilation.
Also handles making the Extension modules, since we can't rely on
NumPy being present in the main body of the setup script.
"""
@classmethod
def _make_extensions(cls, config, templ_config):
""" Produce a list of Extension instances which can be passed to
cythonize().
This is the point at which custom directories, MPI options, etc.
enter the build process.
"""
import numpy
settings = COMPILER_SETTINGS.copy()
settings['include_dirs'][:0] = config.hdf5_includedirs
settings['library_dirs'][:0] = config.hdf5_libdirs
settings['define_macros'].extend(config.hdf5_define_macros)
if config.msmpi:
settings['include_dirs'].extend(config.msmpi_inc_dirs)
settings['library_dirs'].extend(config.msmpi_lib_dirs)
settings['libraries'].append('msmpi')
try:
numpy_includes = numpy.get_include()
except AttributeError:
# if numpy is not installed get the headers from the .egg directory
import numpy.core
numpy_includes = os.path.join(os.path.dirname(numpy.core.__file__), 'include')
settings['include_dirs'] += [numpy_includes]
if config.mpi:
import mpi4py
settings['include_dirs'] += [mpi4py.get_include()]
# TODO: should this only be done on UNIX?
#if os.name != 'nt':
#settings['runtime_library_dirs'] = settings['library_dirs']
for module in ALL_MODULES:
raw_path = Path(localpath("h5py", flavour)).joinpath(module).resolve()
for ext in ['.pyx', '.pxd', '.pxi']:
if not (templ := raw_path.with_suffix(f'.templ{ext}')).exists():
continue
if (target := raw_path.with_suffix(ext)).exists():
current_text = target.read_text('utf-8')
else:
current_text = ""
new_text = tempita.sub(templ.read_text(), **templ_config)
if new_text != current_text:
target.write_text(new_text, 'utf-8')
settings['define_macros'].append(('NPY_TARGET_VERSION', 'NPY_1_21_API_VERSION'))
extensions = [cls._make_extension(m, settings) for m in MODULES]
if int(numpy.__version__.split('.')[0]) >= 2:
# Enable NumPy 2.0 C API for modules that require it.
# NUMPY2_MODULES will not be importable when NumPy 1.x is installed.
settings['define_macros'].append(('NPY_TARGET_VERSION', 'NPY_2_0_API_VERSION'))
extensions.extend(cls._make_extension(m, settings) for m in MODULES_NUMPY2_ONLY)
return extensions
@staticmethod
def _make_extension(module, settings):
sources = [localpath('h5py', flavour, module+'.pyx')] + EXTRA_SRC.get(module, [])
settings = copy.deepcopy(settings)
settings['libraries'] += EXTRA_LIBRARIES.get(module, [])
if flavour:
h5py_module='h5py'+'.'+flavour+'.'+module
else:
h5py_module='h5py'+'.'+module
return Extension(h5py_module, sources, **settings)
def run(self):
""" Distutils calls this method to run the command """
from Cython import __version__ as cython_version
from Cython.Build import cythonize
import numpy
complex256_support = hasattr(numpy, 'complex256')
# This allows ccache to recognise the files when pip builds in a temp
# directory. It speeds up repeatedly running tests through tox with
# ccache configured (CC="ccache gcc"). It should have no effect if
# ccache is not in use.
os.environ['CCACHE_BASEDIR'] = op.dirname(op.abspath(__file__))
os.environ['CCACHE_NOHASHDIR'] = '1'
# Get configuration from environment variables
config = BuildConfig.from_env()
config.summarise()
if config.hdf5_version < (1, 10, 7) or config.hdf5_version == (1, 12, 0):
raise Exception(
f"This version of h5py requires HDF5 >= 1.10.7 and != 1.12.0 (got version "
f"{config.hdf5_version} from environment variable or library)"
)
# Refresh low-level defs if missing or stale
print("Executing api_gen rebuild of defs")
api_gen.run(flavour=flavour)
templ_config = {
"MPI": bool(config.mpi),
"ROS3": bool(config.ros3),
"HDF5_VERSION": config.hdf5_version,
"DIRECT_VFD": bool(config.direct_vfd),
"VOL_MIN_HDF5_VERSION": (1, 11, 5),
"COMPLEX256_SUPPORT": complex256_support,
"NUMPY_BUILD_VERSION": numpy.__version__,
"NUMPY_BUILD_VERSION_TUPLE": tuple(int(x) for x in numpy.__version__.split('.')[:3]),
"CYTHON_BUILD_VERSION": cython_version,
"PLATFORM_SYSTEM": platform.system(),
"OBJECTS_USE_LOCKING": True,
"OBJECTS_DEBUG_ID": False,
"FREE_THREADING": sysconfig.get_config_var("Py_GIL_DISABLED") == 1,
}
# Run Cython
print("Executing cythonize()")
self.extensions = self.distribution.ext_modules = cythonize(
self._make_extensions(config, templ_config),
force=config.changed() or self.force,
language_level=3
)
# Perform the build
self.swig_opts = None # workaround https://github.com/pypa/setuptools/pull/5083
self.finalize_options()
super().run()
# Record the configuration we built
config.record_built()
|
