PyLD 3.0.0

Python implementation of the JSON-LD API

Introduction

This library is an implementation of the JSON-LD specification in Python.

JSON, as specified in RFC7159, is a simple language for representing objects on the Web. Linked Data is a way of describing content across different documents or Web sites. Web resources are described using IRIs, and typically are dereferencable entities that may be used to find more information, creating a “Web of Knowledge”. JSON-LD is intended to be a simple publishing method for expressing not only Linked Data in JSON, but for adding semantics to existing JSON.

JSON-LD is designed as a light-weight syntax that can be used to express Linked Data. It is primarily intended to be a way to express Linked Data in JavaScript and other Web-based programming environments. It is also useful when building interoperable Web Services and when storing Linked Data in JSON-based document storage engines. It is practical and designed to be as simple as possible, utilizing the large number of JSON parsers and existing code that is in use today. It is designed to be able to express key-value pairs, RDF data, RDFa data, Microformats data, and Microdata. That is, it supports every major Web-based structured data model in use today.

The syntax does not require many applications to change their JSON, but easily add meaning by adding context in a way that is either in-band or out-of-band. The syntax is designed to not disturb already deployed systems running on JSON, but provide a smooth migration path from JSON to JSON with added semantics. Finally, the format is intended to be fast to parse, fast to generate, stream-based and document-based processing compatible, and require a very small memory footprint in order to operate.

Conformance

This library aims to conform with the following:

• JSON-LD 1.1, W3C Candidate Recommendation, 2019-12-12 or newer

• JSON-LD 1.1 Processing Algorithms and API, W3C Candidate Recommendation, 2019-12-12 or newer

• JSON-LD 1.1 Framing, W3C Candidate Recommendation, 2019-12-12 or newer

• Working Group test suite

The test runner is often updated to note or skip newer tests that are not yet supported.

Requirements

• Python (3.10 or later)

• Requests (optional)

• aiohttp (optional, Python 3.5 or later)

Installation

PyLD can be installed with a pip package

pip install PyLD

Defining a dependency on pyld will not pull in Requests or aiohttp. If you need one of these for a Document Loader then either depend on the desired external library directly or define the requirement as PyLD[requests] or PyLD[aiohttp].

Quick Examples

from pyld import jsonld
import json

doc = {
    "http://schema.org/name": "Manu Sporny",
    "http://schema.org/url": {"@id": "http://manu.sporny.org/"},
    "http://schema.org/image": {"@id": "http://manu.sporny.org/images/manu.png"}
}

context = {
    "name": "http://schema.org/name",
    "homepage": {"@id": "http://schema.org/url", "@type": "@id"},
    "image": {"@id": "http://schema.org/image", "@type": "@id"}
}

# compact a document according to a particular context
# see: https://json-ld.org/spec/latest/json-ld/#compacted-document-form
compacted = jsonld.compact(doc, context)

print(json.dumps(compacted, indent=2))
# Output:
# {
#   "@context": {...},
#   "image": "http://manu.sporny.org/images/manu.png",
#   "homepage": "http://manu.sporny.org/",
#   "name": "Manu Sporny"
# }

# compact using URLs
jsonld.compact('http://example.org/doc', 'http://example.org/context')

# expand a document, removing its context
# see: https://json-ld.org/spec/latest/json-ld/#expanded-document-form
expanded = jsonld.expand(compacted)

print(json.dumps(expanded, indent=2))
# Output:
# [{
#   "http://schema.org/image": [{"@id": "http://manu.sporny.org/images/manu.png"}],
#   "http://schema.org/name": [{"@value": "Manu Sporny"}],
#   "http://schema.org/url": [{"@id": "http://manu.sporny.org/"}]
# }]

# expand using URLs
jsonld.expand('http://example.org/doc')

# flatten a document
# see: https://json-ld.org/spec/latest/json-ld/#flattened-document-form
flattened = jsonld.flatten(doc)
# all deep-level trees flattened to the top-level

# frame a document
# see: https://json-ld.org/spec/latest/json-ld-framing/#introduction
framed = jsonld.frame(doc, frame)
# document transformed into a particular tree structure per the given frame

# normalize a document using the RDF Dataset Normalization Algorithm
# (URDNA2015), see: https://www.w3.org/TR/rdf-canon/
normalized = jsonld.normalize(
    doc, {'algorithm': 'URDNA2015', 'format': 'application/n-quads'})
# normalized is a string that is a canonical representation of the document
# that can be used for hashing, comparison, etc.

Document Loader

The default document loader for PyLD uses Requests. In a production environment you may want to setup a custom loader that, at a minimum, sets a timeout value. You can also force requests to use https, set client certs, disable verification, or set other Requests parameters.

jsonld.set_document_loader(jsonld.requests_document_loader(timeout=...))

An asynchronous document loader using aiohttp is also available. Please note that this document loader limits asynchronicity to fetching documents only. The processing loops remain synchronous.

jsonld.set_document_loader(jsonld.aiohttp_document_loader(timeout=...))

When no document loader is specified, the default loader is set to Requests. If Requests is not available, the loader is set to aiohttp. The fallback document loader is a dummy document loader that raises an exception on every invocation.

Handling ignored properties during JSON-LD expansion

If a property in a JSON-LD document does not map to an absolute IRI then it is ignored. You can customize this behaviour by passing a customizable handler to on_property_dropped parameter of jsonld.expand().

For example, you can introduce a strict mode by raising a ValueError on every dropped property:

def raise_this(value):
    raise ValueError(value)

jsonld.expand(doc, None, on_property_dropped=raise_this)

Commercial Support

Commercial support for this library is available upon request from Digital Bazaar: [e-mail].

Source

The source code for the Python implementation of the JSON-LD API is available at:

https://github.com/digitalbazaar/pyld

Tests

This library includes a sample testing utility which may be used to verify that changes to the processor maintain the correct output.

To run the sample tests you will need to get the test suite files, which by default, are stored in the specifications/ folder. The test suites can be obtained by either using git submodules or by cloning them manually.

Using git submodules

The test suites are included as git submodules to ensure versions are in sync. When cloning the repository, use the --recurse-submodules flag to automatically clone the submodules. If you have cloned the repository without the submodules, you can initialize them with the following commands:

git submodule init
git submodule update

Cloning manually

You can also avoid using git submodules by manually cloning the json-ld-api, json-ld-framing, and normalization repositories hosted on GitHub using the following commands:

git clone https://github.com/w3c/json-ld-api ./specifications/json-ld-api
git clone https://github.com/w3c/json-ld-framing ./specifications/json-ld-framing
git clone https://github.com/json-ld/normalization ./specifications/normalization

Note that you can clone these repositories into any location you wish; however, if you do not clone them into the default specifications/ folder, you will need to provide the paths to the test runner as arguments when running the tests, as explained below

Running the sample test suites and unittests using pytest

If the suites repositories are available in the specifications/ folder of the PyLD source directory, then all unittests, including the sample test suites, can be run with pytest:

pytest

If you wish to store the test suites in a different location than the default specifications/ folder, or you want to test individual manifest .jsonld files or directories containing a manifest.jsonld, then you can supply these files or directories as arguments:

# use: pytest --tests=TEST_PATH [--tests=TEST_PATH...]
pytest --tests=./specifications/json-ld-api/tests

The test runner supports different document loaders by setting --loader requests or --loader aiohttp. The default document loader is set to Requests.

pytest --loader=requests --tests=./specifications/json-ld-api/tests

An EARL report can be generated using the --earl option.

pytest --earl=./earl-report.json

Running the sample test suites using the original test runner

You can also run the JSON-LD test suites using the original test runner script provided:

python tests/runtests.py

If you wish to store the test suites in a different location than the default specifications/ folder, or you want to test individual manifest .jsonld files or directories containing a manifest.jsonld, then you can supply these files or directories as arguments:

python tests/runtests.py TEST_PATH [TEST_PATH...]

The test runner supports different document loaders by setting -l requests or -l aiohttp. The default document loader is set to Requests.

python tests/runtests.py -l requests ./specifications/json-ld-api/tests

An EARL report can be generated using the -e or --earl option.

python tests/runtests.py -e ./earl-report.json