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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
"""Python code generator for a given schema salad definition."""
from typing import IO, Any, Dict, List, MutableMapping, MutableSequence, Union
from pkg_resources import resource_stream
from six import itervalues, iteritems
from six.moves import cStringIO
from typing_extensions import Text # pylint: disable=unused-import
# move to a regular typing import when Python 3.3-3.6 is no longer supported
from . import schema
from .codegen_base import CodeGenBase, TypeDef
from .schema import shortname
class PythonCodeGen(CodeGenBase):
"""Generation of Python code for a given Schema Salad definition."""
def __init__(self, out):
# type: (IO[str]) -> None
super(PythonCodeGen, self).__init__()
self.out = out
self.current_class_is_abstract = False
self.serializer = cStringIO()
self.idfield = u""
@staticmethod
def safe_name(name): # type: (Text) -> Text
avn = schema.avro_name(name)
if avn in ("class", "in"):
# reserved words
avn = avn+"_"
return avn
def prologue(self):
# type: () -> None
self.out.write("""#
# This file was autogenerated using schema-salad-tool --codegen=python
# The code itself is released under the Apache 2.0 license and the help text is
# subject to the license of the original schema.
#
""")
stream = resource_stream(__name__, 'sourceline.py')
self.out.write(stream.read().decode("UTF-8"))
stream.close()
self.out.write("\n\n")
stream = resource_stream(__name__, 'python_codegen_support.py')
self.out.write(stream.read().decode("UTF-8"))
stream.close()
self.out.write("\n\n")
for primative in itervalues(self.prims):
self.declare_type(primative)
def begin_class(self, # pylint: disable=too-many-arguments
classname, # type: Text
extends, # type: MutableSequence[Text]
doc, # type: Text
abstract, # type: bool
field_names, # type: MutableSequence[Text]
idfield # type: Text
): # type: (...) -> None
classname = self.safe_name(classname)
if extends:
ext = ", ".join(self.safe_name(e) for e in extends)
else:
ext = "Savable"
self.out.write("class %s(%s):\n" % (self.safe_name(classname), ext))
if doc:
self.out.write(' """\n')
self.out.write(str(doc))
self.out.write('\n """\n')
self.serializer = cStringIO()
self.current_class_is_abstract = abstract
if self.current_class_is_abstract:
self.out.write(" pass\n\n")
return
self.out.write(
""" def __init__(self, _doc, baseuri, loadingOptions, docRoot=None):
doc = copy.copy(_doc)
if hasattr(_doc, 'lc'):
doc.lc.data = _doc.lc.data
doc.lc.filename = _doc.lc.filename
errors = []
self.loadingOptions = loadingOptions
""")
self.idfield = idfield
self.serializer.write("""
def save(self, top=False, base_url="", relative_uris=True):
r = {}
for ef in self.extension_fields:
r[prefix_url(ef, self.loadingOptions.vocab)] = self.extension_fields[ef]
""")
if "class" in field_names:
self.out.write("""
if doc.get('class') != '{class_}':
raise ValidationException("Not a {class_}")
""".format(class_=classname))
self.serializer.write("""
r['class'] = '{class_}'
""".format(class_=classname))
def end_class(self, classname, field_names):
# type: (Text, List[Text]) -> None
if self.current_class_is_abstract:
return
self.out.write("""
self.extension_fields = {{}}
for k in doc.keys():
if k not in self.attrs:
if ":" in k:
ex = expand_url(k, u"", loadingOptions, scoped_id=False, vocab_term=False)
self.extension_fields[ex] = doc[k]
else:
errors.append(SourceLine(doc, k, str).makeError("invalid field `%s`, expected one of: {attrstr}" % (k)))
break
if errors:
raise ValidationException(\"Trying '{class_}'\\n\"+\"\\n\".join(errors))
""".
format(attrstr=", ".join(["`%s`" % f for f in field_names]),
class_=self.safe_name(classname)))
self.serializer.write("""
if top and self.loadingOptions.namespaces:
r["$namespaces"] = self.loadingOptions.namespaces
""")
self.serializer.write(" return r\n\n")
self.serializer.write(" attrs = frozenset({attrs})\n".format(attrs=field_names))
self.out.write(self.serializer.getvalue())
self.out.write("\n\n")
prims = {
u"http://www.w3.org/2001/XMLSchema#string": TypeDef(
"strtype", "_PrimitiveLoader((str, six.text_type))"),
u"http://www.w3.org/2001/XMLSchema#int": TypeDef(
"inttype", "_PrimitiveLoader(int)"),
u"http://www.w3.org/2001/XMLSchema#long": TypeDef(
"inttype", "_PrimitiveLoader(int)"),
u"http://www.w3.org/2001/XMLSchema#float": TypeDef(
"floattype", "_PrimitiveLoader(float)"),
u"http://www.w3.org/2001/XMLSchema#double": TypeDef(
"floattype", "_PrimitiveLoader(float)"),
u"http://www.w3.org/2001/XMLSchema#boolean": TypeDef(
"booltype", "_PrimitiveLoader(bool)"),
u"https://w3id.org/cwl/salad#null": TypeDef(
"None_type", "_PrimitiveLoader(type(None))"),
u"https://w3id.org/cwl/salad#Any": TypeDef("Any_type", "_AnyLoader()")
}
def type_loader(self, type_declaration):
# type: (Union[List[Any], Dict[Text, Any], Text]) -> TypeDef
if isinstance(type_declaration, MutableSequence):
sub = [self.type_loader(i) for i in type_declaration]
return self.declare_type(
TypeDef("union_of_%s" % "_or_".join(s.name for s in sub),
"_UnionLoader((%s,))" % (", ".join(s.name for s in sub))))
if isinstance(type_declaration, MutableMapping):
if type_declaration["type"] in ("array", "https://w3id.org/cwl/salad#array"):
i = self.type_loader(type_declaration["items"])
return self.declare_type(
TypeDef("array_of_%s" % i.name,
"_ArrayLoader(%s)" % i.name))
if type_declaration["type"] in ("enum", "https://w3id.org/cwl/salad#enum"):
for sym in type_declaration["symbols"]:
self.add_vocab(shortname(sym), sym)
return self.declare_type(
TypeDef(self.safe_name(type_declaration["name"])+"Loader",
'_EnumLoader(("%s",))' % ('", "'.join(
self.safe_name(sym) for
sym in type_declaration["symbols"]))))
if type_declaration["type"] in ("record", "https://w3id.org/cwl/salad#record"):
return self.declare_type(
TypeDef(self.safe_name(type_declaration["name"])+"Loader",
"_RecordLoader(%s)" % self.safe_name(type_declaration["name"])))
raise Exception("wft %s" % type_declaration["type"])
if type_declaration in self.prims:
return self.prims[type_declaration]
return self.collected_types[self.safe_name(type_declaration)+"Loader"]
def declare_id_field(self, name, fieldtype, doc, optional):
# type: (Text, TypeDef, Text, bool) -> None
if self.current_class_is_abstract:
return
self.declare_field(name, fieldtype, doc, True)
if optional:
opt = """self.{safename} = "_:" + str(uuid.uuid4())""".format(
safename=self.safe_name(name))
else:
opt = """raise ValidationException("Missing {fieldname}")""".format(
fieldname=shortname(name))
self.out.write("""
if self.{safename} is None:
if docRoot is not None:
self.{safename} = docRoot
else:
{opt}
baseuri = self.{safename}
""".
format(safename=self.safe_name(name),
fieldname=shortname(name),
opt=opt))
def declare_field(self, name, fieldtype, doc, optional):
# type: (Text, TypeDef, Text, bool) -> None
if self.current_class_is_abstract:
return
if shortname(name) == "class":
return
if optional:
self.out.write(" if '{fieldname}' in doc:\n".format(fieldname=shortname(name)))
spc = " "
else:
spc = ""
self.out.write("""{spc} try:
{spc} self.{safename} = load_field(doc.get('{fieldname}'), {fieldtype}, baseuri, loadingOptions)
{spc} except ValidationException as e:
{spc} errors.append(SourceLine(doc, '{fieldname}', str).makeError(\"the `{fieldname}` field is not valid because:\\n\"+str(e)))
""".
format(safename=self.safe_name(name),
fieldname=shortname(name),
fieldtype=fieldtype.name,
spc=spc))
if optional:
self.out.write(""" else:
self.{safename} = None
""".format(safename=self.safe_name(name)))
self.out.write("\n")
if name == self.idfield or not self.idfield:
baseurl = 'base_url'
else:
baseurl = "self.%s" % self.safe_name(self.idfield)
if fieldtype.is_uri:
self.serializer.write("""
if self.{safename} is not None:
u = save_relative_uri(self.{safename}, {baseurl}, {scoped_id}, {ref_scope}, relative_uris)
if u:
r['{fieldname}'] = u
""".
format(safename=self.safe_name(name),
fieldname=shortname(name).strip(),
baseurl=baseurl,
scoped_id=fieldtype.scoped_id,
ref_scope=fieldtype.ref_scope))
else:
self.serializer.write("""
if self.{safename} is not None:
r['{fieldname}'] = save(self.{safename}, top=False, base_url={baseurl}, relative_uris=relative_uris)
""".
format(safename=self.safe_name(name),
fieldname=shortname(name),
baseurl=baseurl))
def uri_loader(self, inner, scoped_id, vocab_term, ref_scope):
# type: (TypeDef, bool, bool, Union[int, None]) -> TypeDef
return self.declare_type(
TypeDef("uri_%s_%s_%s_%s" % (inner.name, scoped_id, vocab_term, ref_scope),
"_URILoader(%s, %s, %s, %s)" % (inner.name, scoped_id,
vocab_term, ref_scope),
is_uri=True, scoped_id=scoped_id, ref_scope=ref_scope))
def idmap_loader(self, field, inner, map_subject, map_predicate):
# type: (Text, TypeDef, Text, Union[Text, None]) -> TypeDef
return self.declare_type(
TypeDef("idmap_%s_%s" % (self.safe_name(field), inner.name),
"_IdMapLoader(%s, '%s', '%s')" % (inner.name, map_subject,
map_predicate)))
def typedsl_loader(self, inner, ref_scope):
# type: (TypeDef, Union[int, None]) -> TypeDef
return self.declare_type(
TypeDef("typedsl_%s_%s" % (inner.name, ref_scope),
"_TypeDSLLoader(%s, %s)" % (inner.name, ref_scope)))
def epilogue(self, root_loader):
# type: (TypeDef) -> None
self.out.write("_vocab = {\n")
for k in sorted(self.vocab.keys()):
self.out.write(" \"%s\": \"%s\",\n" % (k, self.vocab[k]))
self.out.write("}\n")
self.out.write("_rvocab = {\n")
for k in sorted(self.vocab.keys()):
self.out.write(" \"%s\": \"%s\",\n" % (self.vocab[k], k))
self.out.write("}\n\n")
for _, collected_type in iteritems(self.collected_types):
self.out.write("%s = %s\n" % (collected_type.name, collected_type.init))
self.out.write("\n\n")
self.out.write("""
def load_document(doc, baseuri=None, loadingOptions=None):
if baseuri is None:
baseuri = file_uri(os.getcwd()) + "/"
if loadingOptions is None:
loadingOptions = LoadingOptions()
return _document_load(%s, doc, baseuri, loadingOptions)
""" % root_loader.name)
|
