Add YAML-LD test suite & decide about YAML-LD implementation in pyld

[anatoly-scherbakov]

Why

YAML-LD is an emerging specification being developed by the JSON-LD Working Group. Normatively, it is quite stable already even though it is an Editor's Draft at the time of writing this.

I had already started a Python implementation for it at https://python-yaml-ld.iolanta.tech (iolanta-tech/python-yaml-ld), pip install yaml-ld. It is basically a wrapper on top of pyld.

It has to implement its own API functions such as expand() which call Respective pyld functions adding YAML support via custom Document Loaders.

I wonder if we should instead implement this as a feature of PyLD itself, guarded by an optional dependency:

pip install pyld[yaml-ld]

and make it so that expand() and other functions in pyld support YAML-LD. What do you guys think?

See also the undecided ADR in this PR: docs/project/decisions/choose-where-to-host-yaml-ld-support.md.

As a follow up, we could think of implementing similar formats, such as:

• CBOR-LD, which is being developed by the WG as well;
• Markdown-LD, which is a colloquial name for Markdown documents with YAML-LD in their frontmatters;
• maybe TOML-LD and many more formats from JSON-LD ecosystem.

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
lib/pyld
canon.py	218	4	98%	27, 180, 565–566
context_resolver.py	103	8	92%	78, 137, 151, 197, 203–205, 229
iri_resolver.py	141	3	98%	311–312, 322
jsonld.py	2513	166	93%	258–262, 311, 348, 353, 363, 380–395, 431–432, 474, 482, 502, 510–511, 619–624, 704–705, 720–721, 781–786, 811–812, 827–828, 838–839, 865, 906, 916, 922–926, 937–938, 981, 988, 1053, 1076, 1098–1100, 1110–1113, 1128, 1151, 1163–1166, 1262, 1274–1277, 1297, 1326, 1359, 1363, 1400, 1443, 1462–1465, 1478, 1527, 1630–1637, 1664–1666, 1692–1695, 1871, 1909, 2215, 2346, 2355–2362, 2456, 2483, 2507, 2515, 3106, 3151, 3170, 3235, 3288, 3291, 3354, 3439, 3473, 3481, 3759, 3764, 3766, 3952–3956, 4060, 4102, 4165, 4400, 4688, 4820, 4854, 4883–4886, 4912–4913, 5096, 5160, 5187, 5261, 5263, 5281, 5379, 5428, 5660, 5662, 5701, 5703, 5712, 5854, 5982, 6069, 6189–6203, 6265, 6267, 6335, 6548, 6554–6558, 6597, 6600, 6690–6691, 6700
lib/pyld/documentloader
aiohttp.py	71	22	69%	29–39, 68, 74, 86, 98–106, 118–121, 138, 153–156
requests.py	51	5	90%	56, 70, 82–90
TOTAL	3423	208	94%

Tests	Skipped	Failures	Errors	Time
1768	86 💤	0 ❌	0 🔥	2m 21s ⏱️