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
|
#############################################################################
##
## Copyright (C) 2019 The Qt Company Ltd.
## Contact: https://www.qt.io/licensing/
##
## This file is part of Qt for Python.
##
## $QT_BEGIN_LICENSE:LGPL$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see https://www.qt.io/terms-conditions. For further
## information use the contact form at https://www.qt.io/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 3 as published by the Free Software
## Foundation and appearing in the file LICENSE.LGPL3 included in the
## packaging of this file. Please review the following information to
## ensure the GNU Lesser General Public License version 3 requirements
## will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 2.0 or (at your option) the GNU General
## Public license version 3 or any later version approved by the KDE Free
## Qt Foundation. The licenses are as published by the Free Software
## Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
## included in the packaging of this file. Please review the following
## information to ensure the GNU General Public License requirements will
## be met: https://www.gnu.org/licenses/gpl-2.0.html and
## https://www.gnu.org/licenses/gpl-3.0.html.
##
## $QT_END_LICENSE$
##
#############################################################################
from __future__ import print_function, absolute_import
"""
layout.py
The signature module now has the capability to configure
differently formatted versions of signatures. The default
layout is known from the "__signature__" attribute.
The function "get_signature(ob, modifier=None)" produces the same
signatures by default. By passing different modifiers, you
can select different layouts.
This module configures the different layouts which can be used.
It also implements them in this file. The configurations are
used literally as strings like "signature", "existence", etc.
"""
from textwrap import dedent
from shibokensupport.signature import inspect, typing
from shibokensupport.signature.mapping import ellipsis
from shibokensupport.signature.lib.tool import SimpleNamespace
class SignatureLayout(SimpleNamespace):
"""
Configure a signature.
The layout of signatures can have different layouts which are
controlled by keyword arguments:
definition=True Determines if self will generated.
defaults=True
ellipsis=False Replaces defaults by "...".
return_annotation=True
parameter_names=True False removes names before ":".
"""
allowed_keys = SimpleNamespace(definition=True,
defaults=True,
ellipsis=False,
return_annotation=True,
parameter_names=True)
allowed_values = True, False
def __init__(self, **kwds):
args = SimpleNamespace(**self.allowed_keys.__dict__)
args.__dict__.update(kwds)
self.__dict__.update(args.__dict__)
err_keys = list(set(self.__dict__) - set(self.allowed_keys.__dict__))
if err_keys:
self._attributeerror(err_keys)
err_values = list(set(self.__dict__.values()) - set(self.allowed_values))
if err_values:
self._valueerror(err_values)
def __setattr__(self, key, value):
if key not in self.allowed_keys.__dict__:
self._attributeerror([key])
if value not in self.allowed_values:
self._valueerror([value])
self.__dict__[key] = value
def _attributeerror(self, err_keys):
err_keys = ", ".join(err_keys)
allowed_keys = ", ".join(self.allowed_keys.__dict__.keys())
raise AttributeError(dedent("""\
Not allowed: '{err_keys}'.
The only allowed keywords are '{allowed_keys}'.
""".format(**locals())))
def _valueerror(self, err_values):
err_values = ", ".join(map(str, err_values))
allowed_values = ", ".join(map(str, self.allowed_values))
raise ValueError(dedent("""\
Not allowed: '{err_values}'.
The only allowed values are '{allowed_values}'.
""".format(**locals())))
# The following names are used literally in this module.
# This way, we avoid the dict hashing problem.
signature = SignatureLayout()
existence = SignatureLayout(definition=False,
defaults=False,
return_annotation=False,
parameter_names=False)
hintingstub = SignatureLayout(ellipsis=True)
typeerror = SignatureLayout(definition=False,
return_annotation=False,
parameter_names=False)
def define_nameless_parameter():
"""
Create Nameless Parameters
A nameless parameter has a reduced string representation.
This is done by cloning the parameter type and overwriting its
__str__ method. The inner structure is still a valid parameter.
"""
def __str__(self):
# for Python 2, we must change self to be an instance of P
klass = self.__class__
self.__class__ = P
txt = P.__str__(self)
self.__class__ = klass
txt = txt[txt.index(":") + 1:].strip() if ":" in txt else txt
return txt
P = inspect.Parameter
newname = "NamelessParameter"
bases = P.__bases__
body = dict(P.__dict__) # get rid of mappingproxy
if "__slots__" in body:
# __slots__ would create duplicates
for name in body["__slots__"]:
del body[name]
body["__str__"] = __str__
return type(newname, bases, body)
NamelessParameter = define_nameless_parameter()
"""
Note on the "Optional" feature:
When an annotation has a default value that is None, then the
type has to be wrapped into "typing.Optional".
Note that only the None value creates an Optional expression,
because the None leaves the domain of the variable.
Defaults like integer values are ignored: They stay in the domain.
That information would be lost when we use the "..." convention.
Note that the typing module has the remarkable expansion
Optional[T] is Variant[T, NoneType]
We want to avoid that when generating the .pyi file.
This is done by a regex in generate_pyi.py .
The following would work in Python 3, but this is a version-dependent
hack that also won't work in Python 2 and would be _very_ complex.
"""
# import sys
# if sys.version_info[0] == 3:
# class hugo(list):pass
# typing._normalize_alias["hugo"] = "Optional"
# Optional = typing._alias(hugo, typing.T, inst=False)
# else:
# Optional = typing.Optional
def make_signature_nameless(signature):
"""
Make a Signature Nameless
We use an existing signature and change the type of its parameters.
The signature looks different, but is totally intact.
"""
for key in signature.parameters.keys():
signature.parameters[key].__class__ = NamelessParameter
_POSITIONAL_ONLY = inspect._POSITIONAL_ONLY
_POSITIONAL_OR_KEYWORD = inspect._POSITIONAL_OR_KEYWORD
_VAR_POSITIONAL = inspect._VAR_POSITIONAL
_KEYWORD_ONLY = inspect._KEYWORD_ONLY
_VAR_KEYWORD = inspect._VAR_KEYWORD
_empty = inspect._empty
def create_signature(props, key):
if not props:
# empty signatures string
return
if isinstance(props["multi"], list):
# multi sig: call recursively
return list(create_signature(elem, key)
for elem in props["multi"])
if type(key) is tuple:
sig_kind, modifier = key
else:
sig_kind, modifier = key, "signature"
layout = globals()[modifier] # lookup of the modifier in this module
if not isinstance(layout, SignatureLayout):
raise SystemError("Modifiers must be names of a SignatureLayout "
"instance")
# this is the basic layout of a signature
varnames = props["varnames"]
if layout.definition:
# PYSIDE-1328: We no longer use info from the sig_kind which is
# more complex for multiple signatures. We now get `self` from the
# parser.
pass
else:
if "self" in varnames[:1]:
varnames = varnames[1:]
# calculate the modifications
defaults = props["defaults"][:]
if not layout.defaults:
defaults = ()
annotations = props["annotations"].copy()
if not layout.return_annotation and "return" in annotations:
del annotations["return"]
# Build a signature.
kind = inspect._POSITIONAL_OR_KEYWORD
params = []
for idx, name in enumerate(varnames):
if name.startswith("**"):
kind = _VAR_KEYWORD
elif name.startswith("*"):
kind = _VAR_POSITIONAL
ann = annotations.get(name, _empty)
if ann == "self":
ann = _empty
name = name.lstrip("*")
defpos = idx - len(varnames) + len(defaults)
default = defaults[defpos] if defpos >= 0 else _empty
if default is None:
ann = typing.Optional[ann]
if default is not _empty and layout.ellipsis:
default = ellipsis
param = inspect.Parameter(name, kind, annotation=ann, default=default)
params.append(param)
if kind == _VAR_POSITIONAL:
kind = _KEYWORD_ONLY
sig = inspect.Signature(params,
return_annotation=annotations.get('return', _empty),
__validate_parameters__=False)
# the special case of nameless parameters
if not layout.parameter_names:
make_signature_nameless(sig)
return sig
# end of file
|
