-
Notifications
You must be signed in to change notification settings - Fork 21
/
links.py
823 lines (743 loc) · 24.9 KB
/
links.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
"""
Produce links to Text-Fabric data and links from nodes to web resources.
"""
import os
import re
import types
from textwrap import dedent
from ..parameters import (
BACKEND_REP,
URL_TFDOC,
SEARCHREF,
APIREF,
APP_APP,
GH,
GL,
)
from ..core.helpers import console, htmlEsc, unexpanduser as ux
from ..core.timestamp import SILENT_D, AUTO, TERSE, VERBOSE, silentConvert
from .repo import Checkout
from .helpers import dh
from ..server.wrap import wrapProvenance
UNSUPPORTED = ""
def linksApi(app, silent=SILENT_D):
"""Produce the link API.
The link API provides methods to maps nodes to urls of web resources.
It also computes several provenance and documentation links from the
configuration settings of the corpus.
If a single volume has been loaded, there will be added a provenance notice
to the provenance data of the work as a whole,
essentially stating which volume from the work is being used and what top-level
sections of the work are part of it.
Parameters
----------
app: obj
The high-level API object
silent: string, optional `tf.core.timestamp.SILENT_D`
See `tf.core.timestamp.Timestamp`
Normally the silent parameter is taken from the app,
but when we do an `A.reuse()` we force `silent="deep"`.
"""
inNb = app.inNb
_browse = app._browse
silent = silentConvert(silent)
backend = app.backend
app.showProvenance = types.MethodType(showProvenance, app)
app.header = types.MethodType(header, app)
app.webLink = types.MethodType(webLink, app)
isCompatible = app.isCompatible
aContext = app.context
appName = aContext.appName
appRelative = aContext.relative
appPath = aContext.appPath
apiVersion = aContext.apiVersion
docUrl = aContext.docUrl
org = aContext.org or ""
repo = aContext.repo or ""
version = aContext.version
corpus = aContext.corpus
featureBase = aContext.featureBase
featurePage = aContext.featurePage
charUrl = aContext.charUrl
charText = aContext.charText
tutUrl = (
f"{BACKEND_REP(backend, 'urlnb')}/"
f"{org}/{repo}/blob/master/tutorial/start.ipynb"
)
apiVersionRep = "" if apiVersion is None else f" v{apiVersion}"
dataName = repo.upper()
collectionInfo = app.collectionInfo
if collectionInfo:
dataName += f" collection {collectionInfo}"
else:
volumeInfo = app.volumeInfo
if volumeInfo:
dataName += f" volume {volumeInfo}"
dataLink = (
outLink(dataName, docUrl, f"provenance of {corpus}", asHtml=inNb or _browse)
if isCompatible and repo is not None and docUrl
else "/".join(
(x or "") for x in (appPath.rsplit("/", 1)[0], appRelative, version)
)
if appName.startswith("app:")
else "/".join((x or "") for x in (appPath, appName, version))
)
charLink = (
(
outLink(
"Character table",
charUrl.format(tfDoc=URL_TFDOC),
charText,
asHtml=inNb or _browse,
)
if isCompatible
else UNSUPPORTED
)
if charUrl
else ""
)
featureLink = (
(
outLink(
"Feature docs",
featureBase.replace("<feature>", featurePage).format(version=version),
f"{repo.upper()} feature documentation",
asHtml=inNb or _browse,
)
if isCompatible and repo is not None and featureBase
else UNSUPPORTED
)
if isCompatible
else UNSUPPORTED
)
extraUrl = f"{BACKEND_REP(backend, 'url')}/{org}/{repo}/blob/master/{APP_APP}"
appLink = (
outLink(
f"{org}/{repo}/app {apiVersionRep}",
extraUrl,
f"{appName} TF-app",
asHtml=inNb or _browse,
)
if isCompatible and repo is not None
else "no app configured"
)
tfLink = outLink(
f"Text-Fabric API {app.TF.version}",
APIREF,
"text-fabric-api",
asHtml=inNb or _browse,
)
tfsLink = (
outLink(
"Search Reference",
SEARCHREF,
"Search Templates Introduction and Reference",
asHtml=inNb or _browse,
)
if isCompatible
else UNSUPPORTED
)
tutLink = (
outLink(
"App tutorial",
tutUrl,
"App tutorial in Jupyter Notebook",
asHtml=inNb or _browse,
)
if isCompatible and repo is not None
else UNSUPPORTED
)
app.appLink = appLink
app.dataLink = dataLink
app.charLink = charLink
app.featureLink = featureLink
app.tfLink = tfLink
app.tfsLink = tfsLink
app.tutLink = tutLink
if not app._browse:
if silent in {VERBOSE, AUTO, TERSE}:
header(app, allMeta=silent == VERBOSE)
def header(app, allMeta=False):
"""Generate a colofon of the TF-app.
This colofon will be displayed after initializing the advanced API,
and it is packed with provenance and documentation links.
Parameters
----------
allMeta: boolean, optional False
If True, includes all metadata of all features. This leads to big
stretches of largely redundant information in html details elements.
It is not visually cumbersome, but notebooks may grow excessively
if you load many datasets many times. So, if False, it will suppress
all that metadata except the description keys.
"""
inNb = app.inNb
appLink = app.appLink
dataLink = app.dataLink
charLink = app.charLink
featureLink = app.featureLink
tfsLink = app.tfsLink
tfLink = app.tfLink
tutLink = app.tutLink
if app._browse:
return (
f"""\
<div class="hdlinks">
{dataLink}
{charLink}
{featureLink}
{tfsLink}
{tutLink}
</div>\
""",
'<img class="hdlogo" src="/data/static/logo.png"/>',
'<img class="hdlogo" src="/server/static/icon.png"/>',
)
else:
featureInfo = _featuresPerModule(app, allMeta=allMeta)
if inNb:
tfLine = ", ".join(x for x in (tfLink, appLink, tfsLink) if x)
dataLine = ", ".join(x for x in (dataLink, charLink, featureLink) if x)
dh(
f"<b>Text-Fabric:</b> {tfLine}<br>"
f"<b>Data:</b> {dataLine}<br>"
f"<b>Features:</b><br>{featureInfo}"
)
else:
tfLine = "\n\t".join(x for x in (tfLink, appLink, tfsLink) if x)
dataLine = "\n\t".join(x for x in (dataLink, charLink, featureLink) if x)
console(
f"Text-Fabric:\n\t{tfLine}\n"
f"Data:\n\t{dataLine}\n"
f"Features:\n{featureInfo}\n",
newline=False,
)
def webLink(
app, n, text=None, clsName=None, urlOnly=False, _asString=False, _noUrl=False
):
"""Maps a node to a web resource.
Usually called as `A.webLink(...)`
The mapping is quite sophisticated. It will do sensible things for
section nodes and lexeme nodes, dependent on how they are configured in
the app's `config.yaml`.
!!! hint "Customizable"
You can customize the behaviour of `webLink()` to the needs of your corpus
by providing appropriate values in its `config.yaml`, especially for
`webBase`, `webLang`, `webOffset`, `webFeature`, `webUrl`, `webUrlLex`, and `webHint`.
Parameters
----------
n: int
A node
text: string/HTML, optional default `None`
The text of the link. If left out, a suitable text will be derived from
the node.
clsName: string, optional default `None`
A CSS class name to add to the resulting link element
urlOnly: boolean, optional `False`
If True, only the url will be returned.
_asString: boolean, optional `False`
Whether to deliver the result as a piece of HTML or to display the link
on the (Jupyter) interface.
_noUrl: boolean, optional `False`
Whether to put the generated url in the `href` attribute.
It can be inhibited. This is useful for the TF-browser, which may want
to attach an action to the link and navigate to a location based on
other attributes.
See Also
--------
tf.advanced.settings: options allowed in `config.yaml`
"""
api = app.api
TF = api.TF
T = api.T
F = api.F
Fs = api.Fs
inNb = app.inNb
_browse = app._browse
aContext = app.context
webBase = aContext.webBase
webLang = aContext.webLang
webOffset = aContext.webOffset
webFeature = aContext.webFeature
webUrl = aContext.webUrl
webUrlZeros = aContext.webUrlZeros or {}
webUrlLex = aContext.webUrlLex
webLexId = aContext.webLexId
webHint = aContext.webHint
lexTypes = aContext.lexTypes
styles = aContext.styles
nType = F.otype.v(n)
passageText = None
if _noUrl:
href = "#"
elif nType in lexTypes:
if webUrlLex and webLexId:
lid = (
app.getLexId(n)
if webLexId is True
else Fs(webLexId).v(n)
if webLexId
else None
)
href = webUrlLex.replace("<lid>", str(lid))
elif webBase:
href = webBase
else:
href = None
else:
href = None
if webFeature:
if TF.isLoaded(webFeature, pretty=False)[webFeature]:
val = Fs(webFeature).v(n)
if val is not None:
href = f"{webBase}{val}"
if href is None:
if webUrl:
href = webUrl
headingTuple = T.sectionFromNode(n, lang=webLang, fillup=True)
for (i, heading) in enumerate(headingTuple):
defaultOffset = 0 if type(heading) is int else ""
offset = (
defaultOffset
if webOffset is None
else webOffset.get(i + 1, {}).get(
headingTuple[i - 1], defaultOffset
)
if i > 0
else defaultOffset
)
value = "" if heading is None else str(heading + offset)
leadingZeros = webUrlZeros.get(i + 1, 0)
if 0 < len(value) < leadingZeros:
value = "0" * (leadingZeros - len(value)) + value
href = href.replace(f"<{i + 1}>", value)
else:
href = None
if nType in lexTypes:
if text is None:
text = app.getText(False, n, nType, False, True, True, "", None, None)
else:
passageText = app.sectionStrFromNode(n)
if text is None:
text = passageText
style = styles.get(nType, None)
if style:
clsName = f"{clsName or ''} {style}"
if href is None:
fullResult = text
else:
atts = dict(target="") if _noUrl else dict(title=webHint)
fullResult = outLink(
text,
href,
clsName=clsName,
passage=passageText,
asHtml=inNb or _browse,
**atts,
)
result = href if urlOnly else fullResult
if _asString or urlOnly:
return result
dh(result, inNb=inNb)
def showProvenance(app, jobName="program code", author="program author"):
"""Shows the provenance that is normally displayed during data loading.
This comes in handy if you have started with
`use("org/repo", silence='deep')` and still need to show the provenance.
Moreover, the provenance is shown in a formatted way.
Parameters
----------
jobName: string, optional `program code`
E.g. the name of program in which you call this function.
In the Text-Fabric browser the name of the job will be entered here.
This item will be displayed together with the rest of the provenance.
author: string, optional `program author`
E.g. your own name.
This item will be displayed together with the rest of the provenance.
"""
inNb = app.inNb
aContext = app.context
backend = app.backend
org = aContext.org
repo = aContext.repo
commit = aContext.commit
appProvenance = (
(("backend", backend), ("org", org), ("repo", repo), ("commit", commit)),
)
provenance = (appProvenance, app.provenance)
setNames = (
tuple(sorted(app.sets.keys()))
if hasattr(app, "sets") and type(app.sets) is dict
else ()
)
form = dict(jobName=jobName, author=author)
dh(wrapProvenance(form, provenance, setNames)[0], inNb=inNb)
PATH_RE1 = re.compile(
rf"""
^
(.*?)
/
(?:
(
(?:
text-fabric-data
/
)?
)
(
{GH}
|
{GL}
|
(?:
(?:
[a-zA-Z0-9_-]+\.
)+
[a-zA-Z0-9_-]+
)
)
)
/
(.*)
$
""",
re.X | re.I,
)
PATH_RE2 = re.compile(
r"""
^
([^/]+)
/
([^/]+)
/
(.*)
$
""",
re.X | re.I,
)
def _parseFeaturePath(path, backend):
match1 = PATH_RE1.fullmatch(path)
if not match1:
return (False, backend, "??", "??", "??")
(lead, exDir, theBackend, rest) = match1.groups()
theBackend = theBackend.lower()
match2 = PATH_RE2.fullmatch(rest)
if not match2:
return (False, theBackend, "??", "??", "??")
(org, repo, relative) = match2.groups()
return (True, theBackend, org, repo, relative)
def outLink(
text, href, title=None, passage=None, clsName=None, target="_blank", asHtml=True
):
"""Produce a formatted link.
Parameters
----------
text: string/HTML
The text of the link.
href: string/URL
The url of the link.
title: string, optional `None`
The hint of the link.
target: string, optional `_blank`
The target window/tab of the link.
clsName: string, optional default `None`
A CSS class name to add to the resulting link element
passage: string, optional `None`
A passage indicator, which will end up in the `sec` attribute of the
link element. Used by the TF-browser.
asHtml: boolean, optional `True`
Whether we are in a notebook or in the browser. If not, a plain text representation
of the link will be made.
"""
titleAtt = "" if title is None else f' title="{title}"'
clsAtt = f' class="{clsName.lower()}"' if clsName else ""
targetAtt = f' target="{target}"' if target else ""
passageAtt = f' sec="{passage}"' if passage else ""
return (
(
f'<a{clsAtt}{targetAtt} href="{htmlEsc(href)}"{titleAtt}{passageAtt}>'
f"{text}</a>"
)
if asHtml
else f"{text} => {href}"
)
def _featuresPerModule(app, allMeta=False):
"""Generate a formatted list of loaded TF features, per module.
Parameters
----------
allMeta: boolean, optional False
Whether to display all metadata for all features or the descriptions only
"""
isCompatible = app.isCompatible
if isCompatible is not None and not isCompatible:
return UNSUPPORTED
api = app.api
TF = app.TF
inNb = app.inNb
backend = app.backend
aContext = app.context
mOrg = aContext.org
mRepo = aContext.repo
mRelative = aContext.relative
version = aContext.version
moduleSpecs = aContext.moduleSpecs
corpus = aContext.corpus
featureBase = aContext.featureBase
features = api.Fall() + api.Eall()
fixedModuleIndex = {}
for m in moduleSpecs or []:
fixedModuleIndex[
(m["backend"] or backend, m["org"], m["repo"], m["relative"])
] = (
m["corpus"],
m["docUrl"],
)
moduleIndex = {}
mLocations = app.mLocations if hasattr(app, "mLocations") else []
baseLoc = mLocations[0] if hasattr(app, "mLocations") else ()
for mLoc in mLocations:
(parseOK, theBackend, org, repo, relative) = _parseFeaturePath(mLoc, backend)
if not parseOK:
moduleIndex[mLoc] = (theBackend, org, repo, relative, mLoc, "")
else:
mId = (theBackend, org, repo, relative)
(corpus, docUrl) = (
(relative, None)
if org is None or repo is None
else (
(corpus, featureBase.format(version=version))
if featureBase
else (corpus, None)
)
if mLoc == baseLoc
else fixedModuleIndex[mId]
if mId in fixedModuleIndex
else (
f"{BACKEND_REP(backend, 'rep')}{org}/{repo}/{relative}",
f"{BACKEND_REP(backend, 'url')}/{org}/{repo}/tree/master/{relative}",
)
)
moduleIndex[mId] = (theBackend, org, repo, relative, corpus, docUrl)
featureCat = {}
for feature in features:
added = False
featureInfo = TF.features[feature]
featurePath = featureInfo.path
(parsedOK, fBackend, fOrg, fRepo, relative) = _parseFeaturePath(
os.path.dirname(featurePath), backend
)
if parsedOK:
fRelative = relative.rsplit("/", 1)[0]
mId = (fBackend, fOrg, fRepo, fRelative)
else:
mId = featurePath.rsplit("/", 1)[0]
if type(mId) is str:
for mIId in moduleIndex:
if type(mIId) is str:
if featurePath.startswith(mIId):
featureCat.setdefault(mIId, []).append(feature)
added = True
else:
for mIId in moduleIndex:
if type(mIId) is not str:
(mBackend, mOrg, mRepo, mRelative) = mIId
if (
fBackend == mBackend
and fOrg == mOrg
and fRepo == mRepo
and fRelative.startswith(mRelative)
):
featureCat.setdefault(mIId, []).append(feature)
added = True
if not added:
featureCat.setdefault(mId, []).append(feature)
baseId = (backend, mOrg, mRepo, mRelative)
baseMods = {
mId for mId in featureCat.keys() if type(mId) is tuple and mId == baseId
}
moduleOrder = list(baseMods) + sorted(
(mId for mId in featureCat.keys() if mId not in baseMods),
key=lambda mId: (1, mId) if type(mId) is str else (0, mId),
)
output = ""
for mId in moduleOrder:
catFeats = featureCat[mId]
if not catFeats:
continue
modInfo = moduleIndex.get(mId, None)
if modInfo:
(mBackend, org, repo, relative, corpus, docUrl) = modInfo
else:
corpus = mId if type(mId) is str else "/".join(mId)
docUrl = (
""
if type(mId) is str
else (
f"{BACKEND_REP(mBackend, 'url')}/"
f"{mId[0]}/{mId[1]}/tree/master/{mId[2]}"
)
)
output += (
dedent(
f"""
<details><summary><b>{corpus}</b></summary>
<div class="fcorpus">
"""
)
if inNb
else f"{corpus}\n"
)
seen = set()
for feature in catFeats:
if "@" in feature:
dlFeature = f'{feature.rsplit("@", 1)[0]}@ll'
if dlFeature in seen:
continue
seen.add(dlFeature)
featureRep = dlFeature
else:
featureRep = feature
featureInfo = TF.features[feature]
featurePath = ux(featureInfo.path)
isEdge = featureInfo.isEdge
valueType = featureInfo.dataType
edgeValues = featureInfo.edgeValues
typeRep = "none" if isEdge and not edgeValues else valueType
meta = featureInfo.metaData
description = meta.get("description", "")
edgeRep = "edge" if isEdge else ""
if inNb:
output += dedent(
f"""
<div class="frow">
<div class="fnamecat {edgeRep}">
"""
)
output += (
(
outLink(
featureRep,
docUrl.replace("<feature>", featureRep),
title=featurePath,
asHtml=True,
)
if docUrl
else f'<span title="{featurePath}">{featureRep}</span>'
)
if inNb
else f"\t{featureRep:<20} "
)
if inNb:
output += dedent(
f"""
</div>
<div class="fmono">{typeRep}</div>
"""
)
if inNb:
output += dedent(
f"""
<details>
<summary>{description}</summary>
<div class="fmeta">
"""
if allMeta
else f"""
<span> {description}</span>
"""
)
else:
output += f"{description}\n"
if allMeta:
for (k, v) in sorted(meta.items()):
if k not in {"valueType", "description"}:
if inNb:
k = htmlEsc(k)
v = htmlEsc(v)
output += dedent(
f"""
<div class="fmetarow">
<div class="fmetakey">{k}:</div>
<div>{v}</div>
</div>
"""
)
else:
output += f"\t\t{k}: {v}\n"
if inNb:
output += dedent(
"""
</div>
</details>
"""
)
else:
output += "\n"
if inNb:
output += dedent(
"""
</div>
"""
)
if inNb:
output += dedent(
"""
</div>
</details>
"""
)
else:
output += "\n"
return output
def provenanceLink(backend, org, repo, version, commit, local, release, relative):
"""Generate a provenance link for a data source.
We assume the data source resides somewhere inside a backend repository.
Parameters
----------
backend: string
`github` or `gitlab` or a GitLab instance such as `gitlab.huc.knaw.nl`.
org: string
Organization on GitHub or group on GitLab
repo: string
Repository on GitHub or project on GitLab
version: string
Version of the data source.
This is not the release or commit of a repo, but the subdirectory
corresponding with a data version under a `tf` directory with feature files.
commit: string
The commit hash of the repository
local: boolean
Whether the data is on the local computer and not necessarily backed up
by a backend repository
release: string
The release tag of the repository
"""
text = (
f"data on local machine {relative}"
if org is None or repo is None
else (
f"{org}/{repo} v:{version}"
f"({Checkout.toString(commit, release, local, backend)})"
)
)
relativeFlat = relative.replace("/", "-")
bUrl = BACKEND_REP(backend, "url")
url = (
None
if org is None or repo is None
else f"{bUrl}/{org}/{repo}/tree/master/{relative}"
if local
else (
(
(
f"{bUrl}/{org}/{repo}/releases/download/{release}"
f"/{relativeFlat}-{version}.zip"
)
if backend == GH
else (
f"{bUrl}/{org}/{repo}/-/archive/{release}" f"/{repo}-{version}.zip"
)
)
if release
else f"{bUrl}/{org}/{repo}/tree/{commit}/{relative}"
)
)
return (text, url)