index.md

:material-file-download-outline: Document Loaders

Document loaders retrieve remote JSON-LD documents and contexts. PyLD ships class-based loaders for common cases and supports custom subclasses of DocumentLoader.

• :material-cloud-download:{ .lg .middle } RequestsDocumentLoader

  ---

  Synchronous remote document loading with requests.

• :material-database:{ .lg .middle } SqliteCacheRequestsDocumentLoader

  ---

  Persistent :simple-sqlite: SQLite caching for remote JSON-LD documents.

• :material-sync:{ .lg .middle } AioHttpDocumentLoader

  ---

  Asynchronous fetching with aiohttp while JSON-LD processing stays synchronous.

• :material-snowflake:{ .lg .middle } FrozenDocumentLoader

  ---

  Serve only documents from an allowlist for air-gapped or reproducible runs.

• :material-file-outline:{ .lg .middle } FileDocumentLoader

  ---

  Read local JSON-LD documents from file: URLs.

• :material-call-split:{ .lg .middle } SchemeDirectedDocumentLoader

  ---

  Delegate to another Document Loader based on the scheme of the URL, for instance, file: vs https://.

• :material-shape-outline:{ .lg .middle } TypeDirectedDocumentLoader

  ---

  Delegate by Python input type, for instance pathlib.Path vs URL str.

• :material-code-braces:{ .lg .middle } Custom Document Loaders

  ---

  Subclass DocumentLoader for application-specific loading logic.

Default Document Loader

The default document loader is selected at import time, in this order:

1. RequestsDocumentLoader if requests is available
2. AioHttpDocumentLoader if aiohttp is available

If neither is installed, document loading raises.