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
|
# Copyright (c) 2019, Riverbank Computing Limited
# All rights reserved.
#
# This copy of SIP is licensed for use under the terms of the SIP License
# Agreement. See the file LICENSE for more details.
#
# This copy of SIP may also used under the terms of the GNU General Public
# License v2 or v3 as published by the Free Software Foundation which can be
# found in the files LICENSE-GPL2 and LICENSE-GPL3 included in this package.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
import os
import shutil
import subprocess
import sys
from ..version import SIP_VERSION, SIP_VERSION_STR
from .abi_version import (get_module_source_dir, get_sip_module_version,
resolve_abi_version)
def module(sip_module, abi_version, project, sdist, setup_cfg, sip_h, sip_rst,
target_dir):
""" Create the various elements of a sip module. """
# Provide some defaults.
abi_version = resolve_abi_version(abi_version)
if project is None:
project = sip_module.replace('.', '_')
# Create the patches.
patches = _create_patches(sip_module, abi_version, project)
# The names of generated files.
sdist_dir = project + '-' + patches['@SIP_MODULE_VERSION@']
sip_h_fn = 'sip.h'
sip_rst_fn = 'sip.rst'
if target_dir:
sdist_dir = os.path.join(target_dir, sdist_dir)
sip_h_fn = os.path.join(target_dir, sip_h_fn)
sip_rst_fn = os.path.join(target_dir, sip_rst_fn)
# Generate the required files.
if sdist:
_create_sdist(sdist_dir, abi_version, patches, setup_cfg)
if sip_h:
_create_sip_file(sip_h_fn, abi_version, patches)
if sip_rst:
_create_sip_file(sip_rst_fn, abi_version, patches)
def copy_sip_h(abi_version, target_dir, sip_module=''):
""" Copy the sip.h file. """
patches = _create_patches(sip_module, abi_version)
_install_source_file('sip.h', get_module_source_dir(abi_version),
target_dir, patches)
def copy_nonshared_sources(abi_version, target_dir):
""" Copy the module sources as a non-shared module. """
# Copy the patched sip.h.
copy_sip_h(abi_version, target_dir)
# Copy the remaining source code.
module_source_dir = get_module_source_dir(abi_version)
sources = []
for fn in os.listdir(module_source_dir):
if fn.endswith('.c') or fn.endswith('.cpp') or fn.endswith('.h'):
src_fn = os.path.join(module_source_dir, fn)
dst_fn = os.path.join(target_dir, fn)
shutil.copyfile(src_fn, dst_fn)
if not fn.endswith('.h'):
sources.append(dst_fn)
return sources
def _create_patches(sip_module, abi_version, project=''):
""" Return a dict of the patches. """
sip_module_parts = sip_module.split('.')
sip_module_package_name = '.'.join(sip_module_parts[:-1])
sip_module_name = sip_module_parts[-1]
abi_major, abi_minor = abi_version.split('.')
# We special case this because this should be the only package requiring
# the support.
legacy = (sip_module == 'PyQt5.sip')
return {
# The public patches are those that might be needed in setup.cfg or any
# automatically generated user documentation.
'@SIP_MODULE_FQ_NAME@': sip_module,
'@SIP_MODULE_PROJECT_NAME@': project,
'@SIP_MODULE_PACKAGE_NAME@': sip_module_package_name,
'@SIP_MODULE_VERSION@': get_sip_module_version(abi_version),
# For DRY.
'@SIP_ABI_MAJOR_VERSION@': abi_major,
'@SIP_ABI_MINOR_VERSION@': abi_minor,
# These are internal to sip.h.
'@_SIP_MODULE_FQ_NAME@': sip_module,
'@_SIP_MODULE_NAME@': sip_module_name,
'@_SIP_MODULE_SHARED@': '1' if sip_module else '0',
'@_SIP_MODULE_ENTRY@': 'PyInit_' + sip_module_name,
'@_SIP_MODULE_LEGACY@': "1" if legacy else "0",
'@_SIP_VERSION@': hex(SIP_VERSION),
'@_SIP_VERSION_STR@': SIP_VERSION_STR
}
def _create_sdist(sdist_dir, abi_version, patches, setup_cfg):
""" Create the sdist. """
# Remove any existing source directory.
shutil.rmtree(sdist_dir, ignore_errors=True)
os.mkdir(sdist_dir)
# The source directory doesn't have sub-directories.
module_source_dir = get_module_source_dir(abi_version)
for name in os.listdir(module_source_dir):
if name in ('sip.pyi', 'sip.rst.in'):
continue
if name != 'MANIFEST.in' and name.endswith('.in'):
name = name[:-3]
# Don't install the default README if we are not using the default
# setup.cfg.
if name != 'README' or setup_cfg is None:
_install_source_file(name, module_source_dir, sdist_dir,
patches)
else:
shutil.copy(os.path.join(module_source_dir, name), sdist_dir)
# Overwrite setup.cfg is required.
if setup_cfg is not None:
setup_cfg_text = _install_source_file(setup_cfg, module_source_dir,
os.path.join(sdist_dir, 'setup.cfg'), patches)
# If the user's setup.cfg mentions sip.pyi then assume it is needed.
if 'sip.pyi' in setup_cfg_text:
shutil.copy(os.path.join(module_source_dir, 'sip.pyi'), sdist_dir)
# Create the sdist file using setuptools. This means any user supplied
# setup.cfg should be handled correctly.
saved_cwd = os.getcwd()
os.chdir(sdist_dir)
subprocess.run(
[sys.executable, 'setup.py', '--quiet', 'sdist', '--dist-dir',
'..'])
os.chdir(saved_cwd)
# Tidy up.
shutil.rmtree(sdist_dir)
def _create_sip_file(sip_file_fn, abi_version, patches):
""" Create a patched file from the module source directory. """
dname, fname = os.path.split(os.path.abspath(sip_file_fn))
_install_source_file(fname, get_module_source_dir(abi_version), dname,
patches)
def _install_source_file(name, module_source_dir, target_dir, patches):
""" Install a source file in a target directory and return a copy of the
contents of the file.
"""
return _install_file(os.path.join(module_source_dir, name) + '.in',
os.path.join(target_dir, name), patches)
def _install_file(name_in, name_out, patches):
""" Install a file and return a copy of its contents. """
# Read the file.
with open(name_in) as f:
data = f.read()
# Patch the file.
for patch_name, patch in patches.items():
data = data.replace(patch_name, patch)
# Write the file.
with open(name_out, 'w') as f:
f.write(data)
return data
|
