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
|
# Copyright (c) 2020, 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.
from argparse import SUPPRESS
from warnings import simplefilter
from ..argument_parser import ArgumentParser
from ..code_generator import (set_globals, parse, generateCode,
generateExtracts, generateAPI, generateXML, generateTypeHints)
from ..exceptions import handle_exception, UserException
from ..module import resolve_abi_version
from ..version import SIP_VERSION, SIP_VERSION_STR
def main():
""" Create the bindings for a C/C++ library. """
# Parse the command line.
parser = ArgumentParser(
"Generate Python extension modules for C/C++ libraries.",
fromfile_prefix_chars='@')
parser.add_argument('specification',
help="the name of the specification file [default stdin]",
metavar="FILE", nargs='?')
parser.add_argument('-a', dest='api_extract',
help="the name of the QScintilla API file [default not generated]",
metavar="FILE")
parser.add_argument('--abi-version', dest='abi_version',
help="the ABI version", metavar="VERSION")
parser.add_argument('-B', dest='backstops', action='append',
help="add <TAG> to the list of timeline backstops",
metavar="TAG")
parser.add_argument('-c', dest='sources_dir',
help="the name of the code directory [default not generated]",
metavar="DIR")
parser.add_argument('-D', dest='py_debug', action='store_true',
default=False,
help="generate code for a debug build of Python")
parser.add_argument('-e', dest='exceptions', action='store_true',
default=False,
help="enable support for exceptions [default disabled]")
parser.add_argument('-f', dest='warnings_are_errors', action='store_true',
default=False,
help="warnings are handled as errors")
parser.add_argument('-g', dest='release_gil', action='store_true',
default=False,
help="always release and reacquire the GIL [default only when "
"specified]")
parser.add_argument('-I', dest='include_dirs', action='append',
help="add <DIR> to the list of directories to search when "
"importing or including .sip files",
metavar="DIR")
parser.add_argument('-j', dest='parts', type=int, default=0,
help="split the generated code into <FILES> files [default 1 per "
"class]",
metavar="FILES")
parser.add_argument('-m', dest='xml_extract', help=SUPPRESS)
parser.add_argument('-n', dest='sip_module',
help="the fully qualified name of the sip module",
metavar="NAME")
parser.add_argument('-o', dest='docstrings', action='store_true',
default=False,
help="enable the automatic generation of docstrings [default "
"disabled]")
parser.add_argument('-P', dest='protected_is_public', action='store_true',
default=False,
help="enable the protected/public hack [default disabled]")
parser.add_argument('-r', dest='tracing', action='store_true',
default=False,
help="generate code with tracing enabled [default disabled]")
parser.add_argument('-s', dest='source_suffix',
help="the suffix to use for C or C++ source files [default \".c\" "
"or \".cpp\"]",
metavar="SUFFIX")
parser.add_argument('-t', dest='tags', action='append',
help="add <TAG> to the list of versions/platforms to generate "
"code for",
metavar="TAG")
parser.add_argument('-w', dest='warnings', action='store_true',
default=False, help="enable warning messages [default disabled]")
parser.add_argument('-x', dest='disabled_features', action='append',
help="add <FEATURE> to the list of disabled features",
metavar="FEATURE")
parser.add_argument('-X', dest='extracts', action='append',
help="add <ID:FILE> to the list of extracts to generate",
metavar="ID:FILE")
parser.add_argument('-y', dest='pyi_extract',
help="the name of the .pyi stub file [default not generated]",
metavar="FILE")
args = parser.parse_args()
# Configure the handling of warnings.
if args.warnings:
if args.warnings_are_errors:
simplefilter('error', FutureWarning)
simplefilter('error', UserWarning)
else:
# Note that we don't suppress FutureWarnings.
simplefilter('ignore', UserWarning)
try:
sip5(args.specification, sip_module=args.sip_module,
abi_version=args.abi_version, sources_dir=args.sources_dir,
include_dirs=args.include_dirs, tags=args.tags,
backstops=args.backstops,
disabled_features=args.disabled_features,
exceptions=args.exceptions, parts=args.parts,
source_suffix=args.source_suffix, docstrings=args.docstrings,
protected_is_public=args.protected_is_public,
py_debug=args.py_debug, release_gil=args.release_gil,
tracing=args.tracing, extracts=args.extracts,
pyi_extract=args.pyi_extract, api_extract=args.api_extract,
xml_extract=args.xml_extract)
except Exception as e:
handle_exception(e)
return 0
def sip5(specification, *, sip_module, abi_version, sources_dir, include_dirs,
tags, backstops, disabled_features, exceptions, parts, source_suffix,
docstrings, protected_is_public, py_debug, release_gil, tracing,
extracts, pyi_extract, api_extract, xml_extract):
""" Create the bindings for a C/C++ library. """
# The code generator requires the name of the sip module.
if sources_dir is not None and sip_module is None:
raise UserException("the name of the sip module must be given")
# Check the ABI version.
abi_major, abi_minor = resolve_abi_version(abi_version).split('.')
# Set the globals.
set_globals(SIP_VERSION, SIP_VERSION_STR, int(abi_major), int(abi_minor),
UserException, include_dirs)
# Parse the input file.
pt, _, _, _, tags, disabled_features = parse(specification,
(xml_extract is None), tags, backstops, disabled_features,
protected_is_public)
# Generate the bindings.
if sources_dir is not None:
generateCode(pt, sources_dir, source_suffix, exceptions, tracing,
release_gil, parts, tags, disabled_features, docstrings,
py_debug, sip_module)
# Generate any extracts.
generateExtracts(pt, extracts)
# Generate the API file.
if api_extract is not None:
generateAPI(pt, api_extract)
# Generate the type hints file.
if pyi_extract is not None:
generateTypeHints(pt, pyi_extract)
# Generate the XML file.
if xml_extract is not None:
generateXML(pt, xml_extract)
|
