forked from mathiasrichter/shapiro
-
Notifications
You must be signed in to change notification settings - Fork 0
/
shapiro_render.py
332 lines (313 loc) · 13.9 KB
/
shapiro_render.py
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
332
from liquid import Environment
from liquid import Mode
from liquid import StrictUndefined
from liquid import FileSystemLoader
from urllib.parse import urlparse
from urllib.error import HTTPError
from shapiro_model import (
RdfClass,
RdfProperty,
SemanticModel,
SemanticModelElement,
ShaclConstraint,
ShaclProperty,
NodeShape,
)
from shapiro_util import NotFoundException, ConflictingPropertyException, prune_iri, get_logger
import markdown as md
import multiline
from typing import List
log = get_logger("SHAPIRO_RENDER")
def url(value: str) -> str:
url = urlparse(value)
if url.scheme != "" and url.scheme is not None:
return '<a href="' + value + '" target="blank">' + prune_iri(value) + "</a>"
return value
class JsonSchemaRenderer:
def __init__(self, template_path: str = "./templates"):
self.env = Environment(
tolerance=Mode.STRICT,
undefined=StrictUndefined,
loader=FileSystemLoader(template_path),
)
def convert_shacl_constraints(
self, shacl_constraints: List[ShaclConstraint]
) -> List[dict]:
constraints = []
for c in shacl_constraints:
name = c.get_json_schema_name()
if name is not None:
constraints.append(
{
"name": name,
"needs_quotes": c.needs_quotes(),
"value": c.value,
}
)
return constraints
def get_data_for_shape(self, shape: NodeShape) -> dict:
properties = (
[]
) # list of dicts with all information for each property, including constraints
shacl_props = shape.get_shacl_properties()
shacl_props = shacl_props + shape.get_inherited_shacl_properties()
for p in shacl_props:
name = p.get_json_schema_name()
jstype = p.get_json_schema_type()
type = None
format = None
if jstype is not None:
type = jstype[0]
format = jstype[1]
prop = {
"iri": p.get_iri(),
"type": type,
"format": format,
"is_object": p.is_object_reference(),
"is_array": p.is_array(),
"name": p.get_json_schema_name(),
"description": p.get_json_schema_comment(),
"is_required": p.is_required(),
}
prop["array_item_constraints"] = self.convert_shacl_constraints(
p.get_json_schema_array_item_constraints()
)
prop["array_item_constraint_count"] = len(prop["array_item_constraints"])
prop["constraints"] = []
for d1 in self.convert_shacl_constraints(p.get_constraints()):
is_array_item_constraint = False
for d2 in prop["array_item_constraints"]:
if d1["name"] == d2["name"] and d1["value"] == d2["value"]:
is_array_item_constraint = True
if not is_array_item_constraint and not (
p.is_array() == False
and (d1["name"] == "maxItems" or d1["name"] == "minItems")
):
prop["constraints"].append(d1)
prop["constraint_count"] = len(prop["constraints"])
if self.is_conflict(properties, prop) == False:
properties.append(prop)
else:
msg = "Cannot produce well-formed JSON-SCHEMA: The SHACL property for {} defined in shape {} conflicts with another SHACL property for the same {} defined in another shape.".format(prop["name"], list(map(lambda s:s.iri, p.get_nodeshapes())), prop["name"])
log.error(msg)
raise ConflictingPropertyException(msg)
return properties
def is_conflict(self, properties:List[dict], property:dict):
# check if the specified property is already in the list of properties
# this can happen if different nodeshapes with the same targetclass
# define SHACL property constraints on the same properties of the shared targetclass.
for p in properties:
if p["iri"] == property["iri"]:
return True
return False
def render_nodeshape(self, shape_iri: str) -> str:
log.info("Rendering JSON-SCHEMA for {}".format(shape_iri))
s = SemanticModel(shape_iri)
shape_list = s.get_node_shapes()
shapes = list(filter(lambda s: s.iri == shape_iri, shape_list))
content = None
if len(shapes) == 0 or len(shapes) > 1:
log.warn("{} shape(s) found for iri '{}'".format(len(shapes), shape_iri))
content = self.env.get_template("render_model.jsonschema").render(
shape_iri=shape_iri,
shape_label=s.label,
shape_description=s.comment,
properties=[],
required=[],
required_count=0,
)
else:
shape = shapes[0]
properties = self.get_data_for_shape(shape)
required = list(filter(lambda p: p["is_required"] == True, properties))
content = self.env.get_template("render_model.jsonschema").render(
shape_iri=shape_iri,
shape_label=shape.label, # TODO: use target class label if shape label is empty
shape_description=shape.get_json_schema_comment(),
properties=properties,
required=required,
required_count=len(required),
)
d = multiline.loads(
content, multiline=True
) # this ensures template generated valid JSON...
return multiline.dumps(
d, indent=5
) # ...and we can return properly formatted JSON (while keeping the template code readable)
class HtmlRenderer:
def __init__(self, template_path: str = "./templates"):
self.queries = []
self.env = Environment(
tolerance=Mode.STRICT,
undefined=StrictUndefined,
loader=FileSystemLoader(template_path),
)
self.env.add_filter("prune", prune_iri)
self.env.add_filter("url", url)
self.env.add_filter("markdown", md.markdown)
def render_page(self, base_url: str, content: str) -> str:
return self.env.get_template("render_page.html").render(
url=base_url, content=content
)
def render_model(self, base_url: str, model_iri: str) -> str:
log.info("HTML rendering model at {}".format(model_iri))
s = SemanticModel(model_iri)
class_list = s.get_classes()
shape_list = s.get_node_shapes()
prop_list = s.get_properties()
model_details = s.get_model_details()
model_details_keys = list(model_details.keys())
model_details_keys.sort(key=lambda k: prune_iri(k, True))
model_details_names = {}
for k in model_details_keys:
model_details_names[k] = prune_iri(k, True)
model_details_count = len(model_details_keys)
instances = s.get_instances()
instance_count = len(instances)
instance_classes = {}
for i in instances:
instance_classes[i.iri] = i.get_classes()
content = self.env.get_template("render_model.html").render(
url=base_url,
model=s,
model_details=model_details,
model_details_count=model_details_count,
model_details_keys=model_details_keys,
model_details_names=model_details_names,
classes=class_list,
class_count=len(class_list),
shapes=shape_list,
shape_count=len(shape_list),
properties=prop_list,
property_count=len(prop_list),
instance_count=instance_count,
instances=instances,
instance_classes=instance_classes,
)
return self.render_page(base_url, content)
def render_model_element(self, base_url: str, iri: str) -> str:
log.info("HTML rendering model element at {}".format(iri))
s = SemanticModel(iri)
content = ""
for t in s.get_types_of_instance(iri):
if t == s.RDFS_CLASS or t == s.OWL_CLASS:
content += self.render_class(base_url, s)
elif t == s.RDFS_PROPERTY or t == s.RDF_PROPERTY:
content += self.render_property(base_url, s)
elif t == s.SHACL_NODESHAPE:
content += self.render_nodeshape(base_url, s)
elif t == s.SHACL_PROPERTY:
content += self.render_shacl_property(base_url, s)
elif s.is_instance(iri):
content += self.render_instance(base_url, s)
if content == "" or content is None:
msg = "Cannot render HTML for {} (element not found, or type of element could not be determined)".format(
iri
)
log.error(msg)
raise NotFoundException(msg)
log.info("HTML rendering full page for model element at {}".format(iri))
return self.render_page(base_url, content)
def render_class(self, base_url: str, model: SemanticModel) -> str:
log.info("HTML rendering class at {}".format(model.iri))
for c in model.get_classes():
if c.iri == model.iri:
prop_types = {}
for p in c.get_properties():
prop_types[p.iri] = []
for t in p.get_property_type():
prop_types[p.iri].append(t)
instances = c.get_instances()
instance_count = len(instances)
return self.env.get_template("render_class.html").render(
url=base_url,
model=model,
model_iri=c.iri[0 : c.iri.rfind("/")],
the_class=c,
types=c.get_types(),
properties=c.get_properties(),
prop_count=len(c.get_properties()),
prop_types=prop_types,
superclasses=c.get_superclasses(),
shapes=c.get_nodeshapes(),
instances=instances,
instance_count=instance_count,
)
def render_instance(self, base_url: str, model: SemanticModel) -> str:
log.info("HTML rendering instance at {}".format(model.iri))
for i in model.get_instances():
if i.iri == model.iri:
return self.env.get_template("render_instance.html").render(
url=base_url,
model_iri=i.iri[0 : i.iri.rfind("/")],
instance=i,
classes=i.get_classes(),
)
def render_property(self, base_url: str, model: SemanticModel) -> str:
log.info("HTML rendering property at {}".format(model.iri))
for p in model.get_properties():
if p.iri == model.iri:
shacl_props = p.get_shacl_properties()
prop_shapes = {}
prop_constraints = {}
for sp in shacl_props:
prop_shapes[sp.iri] = list(
map(lambda n: n.iri, sp.get_nodeshapes())
)
prop_constraints[sp.iri] = sp.get_constraints()
return self.env.get_template("render_property.html").render(
url=base_url,
model=model,
model_iri=p.iri[0 : p.iri.rfind("/")],
property=p,
types=p.get_types(),
classes=p.get_classes(),
prop_type=p.get_property_type(),
superprop=p.get_superproperties(),
shacl_props=shacl_props,
shacl_prop_count=len(shacl_props),
shacl_prop_shapes=prop_shapes,
shacl_prop_constraints=prop_constraints,
)
def render_nodeshape(self, base_url: str, model: SemanticModel) -> str:
log.info("HTML rendering nodeshape at {}".format(model.iri))
for n in model.get_node_shapes():
if n.iri == model.iri:
shacl_props = n.get_shacl_properties()
prop_shapes = {}
prop_constraints = {}
for sp in shacl_props:
prop_shapes[sp.iri] = list(
map(lambda n: n.iri, sp.get_nodeshapes())
)
prop_constraints[sp.iri] = sp.get_constraints()
return self.env.get_template("render_shape.html").render(
url=base_url,
model=model,
model_iri=n.iri[0 : n.iri.rfind("/")],
shape=n,
types=n.get_types(),
classes=n.get_classes(),
shacl_props=shacl_props,
shacl_prop_count=len(shacl_props),
shacl_prop_shapes=prop_shapes,
shacl_prop_constraints=prop_constraints,
)
def render_shacl_property(self, base_url: str, model: SemanticModel) -> str:
log.info("HTML rendering SHACL property at {}".format(model.iri))
shacl_props = model.get_shacl_properties()
for sp in shacl_props:
if sp.iri == model.iri:
prop_shapes = sp.get_nodeshapes()
prop_constraints = sp.get_constraints()
constraint_count = len(prop_constraints)
return self.env.get_template("render_shacl_property.html").render(
url=base_url,
model=model,
model_iri=sp.iri[0 : sp.iri.rfind("/")],
property=sp,
types=sp.get_types(),
shapes=prop_shapes,
constraints=prop_constraints,
constraint_count=constraint_count,
)