forked from schemaorg/schemaorg
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.py
executable file
·1441 lines (1228 loc) · 49.3 KB
/
api.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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
import logging
logging.basicConfig(level=logging.INFO) # dev_appserver.py --log_level debug .
log = logging.getLogger(__name__)
import os
import os.path
import glob
import re
import threading
import parsers
import datetime, time
from google.appengine.ext import ndb
loader_instance = False
import apirdflib
#from apirdflib import rdfGetTargets, rdfGetSources
from apimarkdown import Markdown
def getInstanceId(short=False):
ret = ""
if "INSTANCE_ID" in os.environ:
ret = os.environ["INSTANCE_ID"]
if short:
ret = ret[len(ret)-6:]
return ret
schemasInitialized = False
extensionsLoaded = False
extensionLoadErrors = ""
#INTESTHARNESS used to flag we are in a test harness - not called by webApp so somethings will work different!
#setInTestHarness(True) should be called from test suites.
INTESTHARNESS = False
def setInTestHarness(val):
global INTESTHARNESS
INTESTHARNESS = val
if val:
storestate = False
else:
storestate = True
enablePageStore(storestate)
def getInTestHarness():
global INTESTHARNESS
return INTESTHARNESS
if not getInTestHarness():
from google.appengine.api import memcache
AllLayersList = []
def setAllLayersList(val):
global AllLayersList
AllLayersList = val
#Copy it into apirdflib
apirdflib.allLayersList = val
def getAllLayersList():
global AllLayersList
return AllLayersList
EVERYLAYER = "!EVERYLAYER!"
sitename = "schema.org"
sitemode = "mainsite" # whitespaced list for CSS tags,
# e.g. "mainsite testsite", "extensionsite" when off expected domains
DYNALOAD = True # permits read_schemas to be re-invoked live.
#JINJA_ENVIRONMENT = jinja2.Environment(
# loader=jinja2.FileSystemLoader(os.path.join(os.path.dirname(__file__), 'templates')),
# extensions=['jinja2.ext.autoescape'], autoescape=True)
NDBPAGESTORE = True #True - uses NDB shared (accross instances) store for page cache - False uses in memory local cache
debugging = False
def getMasterStore():
return apirdflib.STORE
def getQueryGraph():
return apirdflib.queryGraph()
# Core API: we have a single schema graph built from triples and units.
NodeIDMap = {}
ext_re = re.compile(r'([^\w,])+')
all_layers = {}
all_terms = {}
# Utility declaration of W3C Initial Context
# From http://www.w3.org/2011/rdfa-context/rdfa-1.1
# and http://www.w3.org/2013/json-ld-context/rdfa11
# Enables all these prefixes without explicit declaration when
# using schema.org's JSON-LD context file.
#
namespaces = """ "schema": "http://schema.org/",
"cat": "http://www.w3.org/ns/dcat#",
"cc": "http://creativecommons.org/ns#",
"cnt": "http://www.w3.org/2008/content#",
"ctag": "http://commontag.org/ns#",
"dc": "http://purl.org/dc/terms/",
"dcat": "http://www.w3.org/ns/dcat#",
"dcterms": "http://purl.org/dc/terms/",
"describedby": "http://www.w3.org/2007/05/powder-s#describedby",
"earl": "http://www.w3.org/ns/earl#",
"foaf": "http://xmlns.com/foaf/0.1/",
"gldp": "http://www.w3.org/ns/people#",
"gr": "http://purl.org/goodrelations/v1#",
"grddl": "http://www.w3.org/2003/g/data-view#",
"ht": "http://www.w3.org/2006/http#",
"ical": "http://www.w3.org/2002/12/cal/icaltzd#",
"license": "http://www.w3.org/1999/xhtml/vocab#license",
"ma": "http://www.w3.org/ns/ma-ont#",
"og": "http://ogp.me/ns#",
"org": "http://www.w3.org/ns/org#",
"org": "http://www.w3.org/ns/org#",
"owl": "http://www.w3.org/2002/07/owl#",
"prov": "http://www.w3.org/ns/prov#",
"ptr": "http://www.w3.org/2009/pointers#",
"qb": "http://purl.org/linked-data/cube#",
"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
"rdfa": "http://www.w3.org/ns/rdfa#",
"rdfs": "http://www.w3.org/2000/01/rdf-schema#",
"rev": "http://purl.org/stuff/rev#",
"rif": "http://www.w3.org/2007/rif#",
"role": "http://www.w3.org/1999/xhtml/vocab#role",
"rr": "http://www.w3.org/ns/r2rml#",
"sd": "http://www.w3.org/ns/sparql-service-description#",
"sioc": "http://rdfs.org/sioc/ns#",
"skos": "http://www.w3.org/2004/02/skos/core#",
"skosxl": "http://www.w3.org/2008/05/skos-xl#",
"v": "http://rdf.data-vocabulary.org/#",
"vcard": "http://www.w3.org/2006/vcard/ns#",
"void": "http://rdfs.org/ns/void#",
"wdr": "http://www.w3.org/2007/05/powder#",
"wdrs": "http://www.w3.org/2007/05/powder-s#",
"xhv": "http://www.w3.org/1999/xhtml/vocab#",
"xml": "http://www.w3.org/XML/1998/namespace",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"""
class DataCacheTool():
def __init__ (self):
self.tlocal = threading.local()
self.tlocal.CurrentDataCache = "core"
self.initialise()
def initialise(self):
self._DataCache = {}
self._DataCache[self.tlocal.CurrentDataCache] = {}
return
def getCache(self,cache=None):
if cache == None:
cache = self.getCurrent()
if cache in self._DataCache.keys():
return self._DataCache[cache]
else:
self._DataCache[cache] = {}
return self._DataCache[cache]
def get(self,key,cache=None):
return self.getCache(cache).get(key)
def remove(self,key,cache=None):
return self.getCache(cache).pop(key,None)
def put(self,key,val,cache=None):
self.getCache(cache)[key] = val
def setCurrent(self,current):
self.tlocal.CurrentDataCache = current
if(self._DataCache.get(current) == None):
self._DataCache[current] = {}
log.debug("[%s] Setting _CurrentDataCache: %s" % (getInstanceId(short=True),current))
def getCurrent(self):
return self.tlocal.CurrentDataCache
def keys(self):
return self._DataCache.keys()
class PageEntity(ndb.Model):
content = ndb.TextProperty()
class PageStoreTool():
def __init__ (self):
self.tlocal = threading.local()
self.tlocal.CurrentStoreSet = "core"
def initialise(self):
import time
log.info("[%s]PageStore initialising Data Store" % (getInstanceId(short=True)))
loops = 0
ret = 0
while loops < 10:
keys = PageEntity.query().fetch(keys_only=True)
count = len(keys)
if count == 0:
break
log.info("[%s]PageStore deleting %s keys" % (getInstanceId(short=True), count))
ndb.delete_multi(keys,use_memcache=False,use_cache=False)
ret += count
loops += 1
time.sleep(0.01)
return {"PageStore":ret}
def getCurrent(self):
return self.tlocal.CurrentStoreSet
def setCurrent(self,current):
self.tlocal.CurrentStoreSet = current
log.debug("PageStore setting CurrentStoreSet: %s",current)
def put(self, key, val,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
#log.info("[%s]PageStore storing %s" % (getInstanceId(),fullKey))
ent = PageEntity(id = fullKey, content = val)
ent.put()
def get(self, key,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
ent = PageEntity.get_by_id(fullKey)
if(ent):
#log.info("[%s]PageStore returning %s" % (os.environ["INSTANCE_ID"],fullKey))
return ent.content
else:
#log.info("PageStore '%s' not found" % fullKey)
return None
def remove(self, key,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
ent = PageEntity.get_by_id(fullKey)
if(ent):
return ent.key.delete()
else:
#log.info("PageStore '%s' not found" % fullKey)
return None
class HeaderEntity(ndb.Model):
content = ndb.PickleProperty()
class HeaderStoreTool():
def __init__ (self):
self.tlocal = threading.local()
self.tlocal.CurrentStoreSet = "core"
def initialise(self):
import time
log.info("[%s]HeaderStore initialising Data Store" % (getInstanceId(short=True)))
loops = 0
ret = 0
while loops < 10:
keys = HeaderEntity.query().fetch(keys_only=True)
count = len(keys)
if count == 0:
break
log.info("[%s]HeaderStore deleting %s keys" % (getInstanceId(short=True), count))
ndb.delete_multi(keys,use_memcache=False,use_cache=False)
ret += count
loops += 1
time.sleep(0.01)
return {"HeaderStore":ret}
def getCurrent(self):
return self.tlocal.CurrentStoreSet
def setCurrent(self,current):
self.tlocal.CurrentStoreSet = current
log.debug("HeaderStore setting CurrentStoreSet: %s",current)
def put(self, key, val,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
ent = HeaderEntity(id = fullKey, content = val)
ent.put()
def get(self, key,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
ent = HeaderEntity.get_by_id(fullKey)
if(ent):
return ent.content
else:
return None
def remove(self, key,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
ent = HeaderEntity.get_by_id(fullKey)
if(ent):
return ent.key.delete()
else:
return None
class DataEntity(ndb.Model):
content = ndb.PickleProperty()
class DataStoreTool():
def __init__ (self):
self.tlocal = threading.local()
self.tlocal.CurrentStoreSet = "core"
def initialise(self):
import time
log.info("[%s]DataStore initialising Data Store" % (getInstanceId(short=True)))
loops = 0
ret = 0
while loops < 10:
keys = DataEntity.query().fetch(keys_only=True)
count = len(keys)
if count == 0:
break
log.info("[%s]DataStore deleting %s keys" % (getInstanceId(short=True), count))
ndb.delete_multi(keys,use_memcache=False,use_cache=False)
ret += count
loops += 1
time.sleep(0.01)
return {"DataStore":ret}
def getCurrent(self):
return self.tlocal.CurrentStoreSet
def setCurrent(self,current):
self.tlocal.CurrentStoreSet = current
log.debug("DataStore setting CurrentStoreSet: %s",current)
def put(self, key, val,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
ent = DataEntity(id = fullKey, content = val)
ent.put()
def get(self, key,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
ent = DataEntity.get_by_id(fullKey)
if(ent):
return ent.content
else:
return None
def remove(self, key,cache=None):
ca = self.getCurrent()
if cache != None:
ca = cache
fullKey = ca + ":" + key
ent = DataEntity.get_by_id(fullKey)
if(ent):
return ent.key.delete()
else:
return None
PageStore = None
HeaderStore = None
DataCache = None
log.info("[%s] NDB PageStore & HeaderStore available: %s" % (getInstanceId(short=True),NDBPAGESTORE))
def enablePageStore(state):
global PageStore,HeaderStore,DataCache
log.info("enablePageStore(%s)" % state)
if state:
log.info("[%s] Enabling NDB" % getInstanceId(short=True))
PageStore = PageStoreTool()
log.info("[%s] Created PageStore" % getInstanceId(short=True))
HeaderStore = HeaderStoreTool()
log.info("[%s] Created HeaderStore" % getInstanceId(short=True))
DataCache = DataStoreTool()
log.info("[%s] Created DataStore" % getInstanceId(short=True))
else:
log.info("[%s] Disabling NDB" % getInstanceId(short=True))
PageStore = DataCacheTool()
HeaderStore = DataCacheTool()
DataCache = DataCacheTool()
if NDBPAGESTORE:
enablePageStore(True)
else:
enablePageStore(False)
class Unit ():
"""
Unit represents a node in our schema graph. IDs are local,
e.g. "Person" or use simple prefixes, e.g. rdfs:Class.
"""
def __init__ (self, id):
self.id = id
NodeIDMap[id] = self
self.arcsIn = []
self.arcsOut = []
self.examples = None
self.home = None
self.subtypes = None
self.sourced = False
self.category = " "
self.typeFlags = {}
def __str__(self):
return self.id
def GetImmediateSubtypes(self, layers='core'):
return GetImmediateSubtypes(self, layers=layers)
@staticmethod
def GetUnit (id, createp=False):
"""Return a Unit representing a node in the schema graph.
Argument:
createp -- should we create node if we don't find it? (default: False)
"""
ret = None
if (id in NodeIDMap):
return NodeIDMap[id]
ret = apirdflib.rdfGetTriples(id)
if (ret == None and createp != False):
return Unit(id)
return ret
@staticmethod
def GetUnitNoLoad(id, createp=False):
if (id in NodeIDMap):
return NodeIDMap[id]
if (createp != False):
return Unit(id)
return None
def typeOf(self, type, layers='core'):
"""Boolean, true if the unit has an rdf:type matching this type."""
types = GetTargets( Unit.GetUnit("rdf:type"), self, layers )
return (type in types)
# Function needs rewriting to use GetTargets(arc,src,layers) and recurse
def subClassOf(self, type, layers='core'):
"""Boolean, true if the unit has an rdfs:subClassOf matching this type, direct or implied (in specified layer(s))."""
if (self.id == type.id):
return True
parents = GetTargets( Unit.GetUnit("rdfs:subClassOf"), self, layers )
if type in parents:
return True
else:
for p in parents:
if p.subClassOf(type, layers):
return True
return False
def directInstanceOf(self, type, layers='core'):
"""Boolean, true if the unit has a direct typeOf (aka rdf:type) property matching this type, direct or implied (in specified layer(s))."""
mytypes = GetTargets( Unit.GetUnit("rdf:type"), self, layers )
if type in mytypes:
return True
return False # TODO: consider an API for implied types too?
def isClass(self, layers='core'):
"""Does this unit represent a class/type?"""
if self.typeFlags.has_key('c'):
return self.typeFlags['c']
isClass = self.typeOf(Unit.GetUnit("rdfs:Class"), layers=EVERYLAYER)
self.typeFlags['c'] = isClass
return isClass
def isAttribute(self, layers='core'):
"""Does this unit represent an attribute/property?"""
if self.typeFlags.has_key('p'):
return self.typeFlags['p']
isProp = self.typeOf(Unit.GetUnit("rdf:Property"), layers=EVERYLAYER)
self.typeFlags['p'] = isProp
return isProp
def isEnumeration(self, layers='core'):
"""Does this unit represent an enumerated type?"""
if self.typeFlags.has_key('e'):
return self.typeFlags['e']
isE = self.subClassOf(Unit.GetUnit("Enumeration"), layers=EVERYLAYER)
self.typeFlags['e'] = isE
return isE
def isEnumerationValue(self, layers='core'):
"""Does this unit represent a member of an enumerated type?"""
if self.typeFlags.has_key('ev'):
return self.typeFlags['ev']
types = GetTargets(Unit.GetUnit("rdf:type"), self , layers=EVERYLAYER)
#log.debug("isEnumerationValue() called on %s, found %s types. layers: %s" % (self.id, str( len( types ) ), layers ) )
found_enum = False
for t in types:
if t.subClassOf(Unit.GetUnit("Enumeration"), layers=EVERYLAYER):
found_enum = True
break
self.typeFlags['ev'] = found_enum
return found_enum
def isDataType(self, layers='core'):
"""
Does this unit represent a DataType type or sub-type?
DataType and its children do not descend from Thing, so we need to
treat it specially.
"""
if self.typeFlags.has_key('d'):
return self.typeFlags['d']
ret = False
if (self.directInstanceOf(Unit.GetUnit("DataType"), layers=layers) or
self.id == "DataType"):
ret = True
else:
subs = GetTargets(Unit.GetUnit("rdfs:subClassOf"), self, layers=layers)
for p in subs:
if p.isDataType(layers=layers):
ret = True
break
self.typeFlags['d'] = ret
return ret
@staticmethod
def storePrefix(prefix):
"""Stores the prefix declaration for a given class or property"""
# Currently defined just to let the tests pass
pass
# e.g. <http://schema.org/actors> <http://schema.org/supersededBy> <http://schema.org/actor> .
def superseded(self, layers='core'):
"""Has this property been superseded? (i.e. deprecated/archaic), in any of these layers."""
supersededBy_values = GetTargets( Unit.GetUnit("supersededBy"), self, layers )
return ( len(supersededBy_values) > 0)
def supersedes(self, layers='core'):
"""Returns a property (assume max 1) that is supersededBy this one, or nothing."""
olderterms = GetSources( Unit.GetUnit("supersededBy"), self, layers )
if len(olderterms) > 0:
return olderterms[0]
else:
return None
def supersedes_all(self, layers='core'):
"""Returns terms that is supersededBy by this later one, or nothing. (in this layer)"""
return(GetSources( Unit.GetUnit("supersededBy"), self, layers ))
# so we want sources of arcs pointing here with 'supersededBy'
# e.g. vendor supersededBy seller ; returns newer 'seller' for earlier 'vendor'.
def supersededBy(self, layers='core'):
"""Returns a property (assume max 1) that supersededs this one, or nothing."""
newerterms = GetTargets( Unit.GetUnit("supersededBy"), self, layers )
if len(newerterms)>0:
return newerterms.pop()
else:
return None
return ret
def category(self):
return self.category
def getHomeLayer(self,defaultToCore=False):
ret = self.home
if ret == None:
if defaultToCore:
ret = 'core'
else:
log.info("WARNING %s has no home extension defined!!" % self.id)
ret = ""
return ret
def superproperties(self, layers='core'):
"""Returns super-properties of this one."""
if not self.isAttribute(layers=layers):
logging.debug("Non-property %s won't have subproperties." % self.id)
return None
superprops = GetTargets(Unit.GetUnit("rdfs:subPropertyOf"),self, layers=layers )
return superprops
def subproperties(self, layers='core'):
"""Returns direct subproperties of this property."""
if not self.isAttribute(layers=layers):
logging.debug("Non-property %s won't have subproperties." % self.id)
return None
subprops = GetSources(Unit.GetUnit("rdfs:subPropertyOf"),self, layers=layers )
return subprops
def inverseproperty(self, layers="core"):
"""A property that is an inverseOf this one, e.g. alumni vs alumniOf."""
a = GetTargets(Unit.GetUnit("inverseOf"), self, layers=layers)
b = GetSources(Unit.GetUnit("inverseOf"), self, layers=layers)
if len(a)>0:
return a.pop()
else:
if len(b) > 0:
return b.pop()
else:
return None
for triple in self.arcsOut:
if (triple.target != None and triple.arc.id == "inverseOf"):
return triple.target
for triple in self.arcsIn:
if (triple.source != None and triple.arc.id == "inverseOf"):
return triple.source
return None
def UsageStr (self) :
str = GetUsage(self.id)
if (str == '1') :
return "Between 10 and 100 domains"
elif (str == '2'):
return "Between 100 and 1000 domains"
elif (str == '3'):
return "Between 1000 and 10,000 domains"
elif (str == '4'):
return "Between 10,000 and 50,000 domains"
elif (str == '5'):
return "Between 50,000 and 100,000 domains"
elif (str == '7'):
return "Between 100,000 and 250,000 domains"
elif (str == '8'):
return "Between 250,000 and 500,000 domains"
elif (str == '9'):
return "Between 500,000 and 1,000,000 domains"
elif (str == '10'):
return "Over 1,000,000 domains"
else:
return ""
# NOTE: each Triple is in exactly one layer, by default 'core'. When we
# read_schemas() from data/ext/{x}/*.rdfa each schema triple is given a
# layer named "x". Access to triples can default to layer="core" or take
# a custom layer or layers, e.g. layers="bib", or layers=["bib", "foo"].
# This is verbose but at least explicit. If we move towards making better
# use of external templates for site generation we could reorganize.
# For now e.g. 'grep GetSources api.py| grep -v layer' and
# 'grep GetTargets api.py| grep -v layer' etc. can check for non-layered usage.
#
# Units, on the other hand, are layer-independent. For now we have only a
# crude inLayer(layerlist, unit) API to check which layers mention a term.
class Triple ():
"""Triple represents an edge in the graph: source, arc and target/text."""
def __init__ (self, source, arc, target, text, layer='core'):
"""Triple constructor keeps state via source node's arcsOut."""
self.source = source
source.arcsOut.append(self)
self.arc = arc
self.layer = layer
self.id = self
if (target != None):
self.target = target
self.text = None
target.arcsIn.append(self)
elif (text != None):
self.text = text
self.target = None
def __str__ (self):
ret = ""
if self.source != None:
ret += "%s " % self.source
if self.target != None:
ret += "%s " % self.target
if self.arc != None:
ret += "%s " % self.arc
return ret
@staticmethod
def AddTriple(source, arc, target, layer='core'):
"""AddTriple stores a thing-valued new Triple within source Unit."""
if (source == None or arc == None or target == None):
log.info("Bailing")
return
else:
# for any term mentioned as subject or object, we register the layer
# TODO: make this into a function
x = all_terms.get(source.id) # subjects
if x is None:
x = []
if layer not in x:
x.append(layer)
all_terms[source.id]= x
x = all_terms.get(target.id) # objects
if x is None:
x = []
if layer not in x:
x.append(layer)
all_terms[target.id]= x
return Triple(source, arc, target, None, layer)
@staticmethod
def AddTripleText(source, arc, text, layer='core'):
"""AddTriple stores a string-valued new Triple within source Unit."""
if (source == None or arc == None or text == None):
return
else:
return Triple(source, arc, None, text, layer)
def GetTargets(arc, source, layers='core'):
"""All values for a specified arc on specified graph node (within any of the specified layers)."""
# log.debug("GetTargets checking in layer: %s for unit: %s arc: %s" % (layers, source.id, arc.id))
targets = {}
fred = False
try:
for triple in source.arcsOut:
if (triple.arc == arc):
if (triple.target != None and (layers == EVERYLAYER or triple.layer in layers)):
targets[triple.target] = 1
elif (triple.text != None and (layers == EVERYLAYER or triple.layer in layers)):
targets[triple.text] = 1
return targets.keys()
except Exception as e:
log.debug("GetTargets caught exception %s" % e)
return []
def GetSources(arc, target, layers='core'):
"""All source nodes for a specified arc pointing to a specified node (within any of the specified layers)."""
#log.debug("GetSources checking in layer: %s for unit: %s arc: %s" % (layers, target.id, arc.id))
if(target.sourced == False):
apirdflib.rdfGetSourceTriples(target)
sources = {}
for triple in target.arcsIn:
if (triple.arc == arc and (layers == EVERYLAYER or triple.layer in layers)):
sources[triple.source] = 1
return sources.keys()
def GetArcsIn(target, layers='core'):
"""All incoming arc types for this specified node (within any of the specified layers)."""
arcs = {}
for triple in target.arcsIn:
if (layers == EVERYLAYER or triple.layer in layers):
arcs[triple.arc] = 1
return arcs.keys()
def GetArcsOut(source, layers='core'):
"""All outgoing arc types for this specified node."""
arcs = {}
for triple in source.arcsOut:
if (layers == EVERYLAYER or triple.layer in layers):
arcs[triple.arc] = 1
return arcs.keys()
# Utility API
def GetComment(node, layers='core') :
"""Get the first rdfs:comment we find on this node (or "No comment"), within any of the specified layers."""
tx = GetComments(node, layers)
if len(tx) > 0:
return Markdown.parse(tx[0])
else:
return "No comment"
def GetComments(node, layers='core') :
"""Get the rdfs:comment(s) we find on this node within any of the specified layers."""
return GetTargets(Unit.GetUnit("rdfs:comment", True), node, layers=layers )
def GetsoftwareVersions(node, layers='core') :
"""Get the schema:softwareVersion(s) we find on this node (or [] ), within any of the specified layers."""
return GetTargets(Unit.GetUnit("softwareVersion", True), node, layers=layers )
def GetImmediateSubtypes(n, layers='core'):
"""Get this type's immediate subtypes, i.e. that are subClassOf this."""
if n==None:
return None
subs = GetSources( Unit.GetUnit("rdfs:subClassOf", True), n, layers=layers)
if (n.isDataType() or n.id == "DataType"):
subs += GetSources( Unit.GetUnit("rdf:type", True), n, layers=layers)
subs.sort(key=lambda x: x.id)
return subs
def GetImmediateSupertypes(n, layers='core'):
"""Get this type's immediate supertypes, i.e. that we are subClassOf."""
if n==None:
return None
sups = GetTargets( Unit.GetUnit("rdfs:subClassOf", True), n, layers=layers)
if (n.isDataType() or n.id == "DataType"):
sups += GetTargets( Unit.GetUnit("rdf:type", True), n, layers=layers)
sups.sort(key=lambda x: x.id)
return sups
Utc = "util_cache"
UtilCache = DataCacheTool()
def GetAllTypes(layers='core'):
global Utc
"""Return all types in the graph."""
KEY = "AllTypes:%s" % layers
if UtilCache.get(KEY+'x',Utc):
#logging.debug("DataCache HIT: %s" % KEY)
return UtilCache.get(KEY,Utc)
else:
#logging.debug("DataCache MISS: %s" % KEY)
mynode = Unit.GetUnit("Thing", True)
subbed = {}
todo = [mynode]
while todo:
current = todo.pop()
subs = GetImmediateSubtypes(current, EVERYLAYER)
if inLayer(layers,current):
subbed[current] = 1
for sc in subs:
if subbed.get(sc.id) == None:
todo.append(sc)
UtilCache.put(KEY,subbed.keys(),Utc)
return subbed.keys()
def GetAllDataTypes(layers='core'):
global Utc
"""Return all types in the graph."""
KEY = "AllDataTypes:%s" % layers
if UtilCache.get(KEY+'x',Utc):
#logging.debug("DataCache HIT: %s" % KEY)
return UtilCache.get(KEY,Utc)
else:
#logging.debug("DataCache MISS: %s" % KEY)
mynode = Unit.GetUnit("DataType", True)
subbed = {}
todo = [mynode]
while todo:
current = todo.pop()
subs = GetImmediateSubtypes(current, EVERYLAYER)
if inLayer(layers,current):
subbed[current] = 1
for sc in subs:
if subbed.get(sc.id) == None:
todo.append(sc)
UtilCache.put(KEY,subbed.keys(),Utc)
return subbed.keys()
def GetAllEnumerationValues(layers='core'):
global Utc
KEY = "AllEnums:%s" % layers
if UtilCache.get(KEY,Utc):
#logging.debug("DataCache HIT: %s" % KEY)
return UtilCache.get(KEY,Utc)
else:
#logging.debug("DataCache MISS: %s" % KEY)
mynode = Unit.GetUnit("Enumeration", True)
enums = {}
subbed = {}
todo = [mynode]
while todo:
current = todo.pop()
subs = GetImmediateSubtypes(current, EVERYLAYER)
subbed[current] = 1
for sc in subs:
vals = GetSources( Unit.GetUnit("rdf:type", True), sc, layers=EVERYLAYER)
for val in vals:
if inLayer(layers,val):
enums[val] = 1
if subbed.get(sc.id) == None:
todo.append(sc)
UtilCache.put(KEY,enums.keys(),Utc)
return enums.keys()
def GetAllProperties(layers='core'):
"""Return all properties in the graph."""
global Utc
KEY = "AllProperties:%s" % layers
if UtilCache.get(KEY,Utc):
#logging.debug("DataCache HIT: %s" % KEY)
return UtilCache.get(KEY,Utc)
else:
#logging.debug("DataCache MISS: %s" % KEY)
mynode = Unit.GetUnit("Thing")
props = GetSources(Unit.GetUnit("rdf:type", True), Unit.GetUnit("rdf:Property", True), layers=EVERYLAYER)
res = []
for prop in props:
if inLayer(layers,prop):
res.append(prop)
sorted_all_properties = sorted(res, key=lambda u: u.id)
UtilCache.put(KEY,sorted_all_properties,Utc)
return sorted_all_properties
def GetAllTerms(layers='core',includeDataTypes=False):
ret = GetAllTypes(layers)
ret.extend(GetAllEnumerationValues(layers))
ret.extend(GetAllProperties(layers))
if includeDataTypes:
ret.extend(GetAllDataTypes(layers))
return sorted(ret,key=lambda u: u.id)
def GetParentList(start_unit, end_unit=None, path=[], layers='core'):
"""
Returns one or more lists, each giving a path from a start unit to a supertype parent unit.
example:
for path in GetParentList( Unit.GetUnit("Restaurant") ):
pprint.pprint(', '.join([str(x.id) for x in path ]))
'Restaurant, FoodEstablishment, LocalBusiness, Organization, Thing'
'Restaurant, FoodEstablishment, LocalBusiness, Place, Thing'
"""
if not end_unit:
end_unit = Unit.GetUnit("Thing")
arc=Unit.GetUnit("rdfs:subClassOf")
logging.debug("from %s to %s - path length %d" % (start_unit.id, end_unit.id, len(path) ) )
path = path + [start_unit]
if start_unit == end_unit:
return [path]
if not Unit.GetUnit(start_unit.id):
return []
paths = []
for node in GetTargets(arc, start_unit, layers=layers):
if node not in path:
newpaths = GetParentList(node, end_unit, path, layers=layers)
for newpath in newpaths:
paths.append(newpath)
return paths
def HasMultipleBaseTypes(typenode, layers='core'):
"""True if this unit represents a type with more than one immediate supertype."""
return len( GetTargets( Unit.GetUnit("rdfs:subClassOf", True), typenode, layers ) ) > 1
EXAMPLESMAP = {}
EXAMPLES = []
ExamplesCount = 0
class Example ():
@staticmethod
def AddExample(terms, original_html, microdata, rdfa, jsonld, egmeta, layer='core'):
"""
Add an Example (via constructor registering it with the terms that it
mentions, i.e. stored in term.examples).
"""
# todo: fix partial examples: if (len(terms) > 0 and len(original_html) > 0 and (len(microdata) > 0 or len(rdfa) > 0 or len(jsonld) > 0)):
typeinfo = "".join( [" %s " % t for t in terms] )
if "FakeEntryNeeded" in typeinfo or terms==[]:
return
if (len(terms) > 0 and len(original_html) > 0 and len(microdata) > 0 and len(rdfa) > 0 and len(jsonld) > 0):
return Example(terms, original_html, microdata, rdfa, jsonld, egmeta, layer='core')
else:
log.info("API AddExample skipped a case due to missing value(s) in example. Target terms: %s ORIG: %s MICRODATA: %s RDFA: %s JSON: %s EGMETA: %s " % ( typeinfo, original_html, microdata, rdfa, jsonld, egmeta ) )
def get(self, name, layers='core') :
"""Exposes original_content, microdata, rdfa and jsonld versions (in the layer(s) specified)."""
if name == 'original_html':
return self.original_html
if name == 'microdata':
return self.microdata
if name == 'rdfa':
return self.rdfa
if name == 'jsonld':
return self.jsonld
def __init__ (self, terms, original_html, microdata, rdfa, jsonld, egmeta, layer='core'):
"""Example constructor, registers itself with the ExampleMap of terms to examples."""
global EXAMPLES, EXAMPLESMAP, ExamplesCount
ExamplesCount += 1
self.orderId = ExamplesCount #Used to maintain consistancy of display order
self.terms = terms
self.original_html = original_html
self.microdata = microdata
self.rdfa = rdfa
self.jsonld = jsonld
self.egmeta = egmeta
self.layer = layer
if 'id' in self.egmeta:
self.keyvalue = self.egmeta['id']