Expose JSON-LD parser and serializer

Author: Tpt

.pre-commit-config.yaml

@@ -23,12 +23,12 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.10
+    rev: v0.13.0
     hooks:
       - id: ruff
         args: [ --fix ]
       - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.17.1
+    rev: v1.18.1
     hooks:
       - id: mypy

README.md

@@ -93,7 +93,9 @@ The following formats are supported:
 - `ox-nquads` (`ox-nq`)
 - `ox-turtle` (`ox-ttl`)
 - `ox-trig`
+- `ox-n3`
 - `ox-xml`
+- `ox-json-ld` (`ox-streaming-json-ld` for streaming JSON-LD, note that only JSON-LD 1.0 is supported)
 
 Note that Oxigraph parser and serializers are not 1:1 compatible with the rdflib ones and some minor differences exist.
 

pyproject.toml

@@ -17,6 +17,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "License :: OSI Approved :: BSD License",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Database :: Database Engines/Servers",
@@ -40,6 +41,8 @@ Oxigraph = "oxrdflib.store:OxigraphStore"
 oxigraph = "oxrdflib.store:OxigraphStore"
 
 [project.entry-points."rdf.plugins.parser"]
+ox-json-ld = "oxrdflib.parser:OxigraphJsonLdParser"
+ox-streaming-json-ld = "oxrdflib.parser:OxigraphStreamingJsonLdParser"
 ox-turtle = "oxrdflib.parser:OxigraphTurtleParser"
 ox-ttl = "oxrdflib.parser:OxigraphTurtleParser"
 ox-n3 = "oxrdflib.parser:OxigraphN3Parser"
@@ -52,6 +55,8 @@ ox-trig = "oxrdflib.parser:OxigraphTriGParser"
 ox-xml = "oxrdflib.parser:OxigraphRdfXmlParser"
 
 [project.entry-points."rdf.plugins.serializer"]
+ox-json-ld = "oxrdflib.serializer:OxigraphJsonLdSerializer"
+ox-streaming-json-ld = "oxrdflib.serializer:OxigraphJsonLdSerializer"
 ox-turtle = "oxrdflib.serializer:OxigraphTurtleSerializer"
 ox-ttl = "oxrdflib.serializer:OxigraphTurtleSerializer"
 ox-n3 = "oxrdflib.serializer:OxigraphN3Serializer"

src/oxrdflib/parser.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Optional
+from typing import Final, Optional
 
 from pyoxigraph import DefaultGraph, RdfFormat, parse
 from rdflib import Graph
@@ -16,10 +16,12 @@
 from oxrdflib.store import OxigraphStore
 
 __all__ = [
+    "OxigraphJsonLdParser",
     "OxigraphN3Parser",
     "OxigraphNQuadsParser",
     "OxigraphNTriplesParser",
     "OxigraphRdfXmlParser",
+    "OxigraphStreamingJsonLdParser",
     "OxigraphTriGParser",
     "OxigraphTurtleParser",
 ]
@@ -73,25 +75,33 @@ def _format(self) -> RdfFormat:
         pass
 
 
+class OxigraphJsonLdParser(_OxigraphParser):
+    _format: Final = RdfFormat.JSON_LD
+
+
+class OxigraphStreamingJsonLdParser(_OxigraphParser):
+    _format: Final = RdfFormat.STREAMING_JSON_LD
+
+
 class OxigraphTurtleParser(_OxigraphParser):
-    _format = RdfFormat.TURTLE
+    _format: Final = RdfFormat.TURTLE
 
 
 class OxigraphNTriplesParser(_OxigraphParser):
-    _format = RdfFormat.N_TRIPLES
+    _format: Final = RdfFormat.N_TRIPLES
 
 
 class OxigraphRdfXmlParser(_OxigraphParser):
-    _format = RdfFormat.RDF_XML
+    _format: Final = RdfFormat.RDF_XML
 
 
 class OxigraphN3Parser(_OxigraphParser):
-    _format = RdfFormat.N3
+    _format: Final = RdfFormat.N3
 
 
 class OxigraphNQuadsParser(_OxigraphParser):
-    _format = RdfFormat.N_QUADS
+    _format: Final = RdfFormat.N_QUADS
 
 
 class OxigraphTriGParser(_OxigraphParser):
-    _format = RdfFormat.TRIG
+    _format: Final = RdfFormat.TRIG

src/oxrdflib/serializer.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import IO, Optional
+from typing import IO, Final, Optional
 
 from pyoxigraph import RdfFormat, serialize
 from rdflib import Dataset
@@ -9,6 +9,7 @@
 from oxrdflib.store import OxigraphStore
 
 __all__ = [
+    "OxigraphJsonLdSerializer",
     "OxigraphN3Serializer",
     "OxigraphNQuadsSerializer",
     "OxigraphNTriplesSerializer",
@@ -47,25 +48,29 @@ def _format(self) -> RdfFormat:
         pass
 
 
+class OxigraphJsonLdSerializer(_OxigraphSerializer):
+    _format: Final = RdfFormat.JSON_LD
+
+
 class OxigraphN3Serializer(_OxigraphSerializer):
-    _format = RdfFormat.N3
+    _format: Final = RdfFormat.N3
 
 
 class OxigraphTurtleSerializer(_OxigraphSerializer):
-    _format = RdfFormat.TURTLE
+    _format: Final = RdfFormat.TURTLE
 
 
 class OxigraphNTriplesSerializer(_OxigraphSerializer):
-    _format = RdfFormat.N_TRIPLES
+    _format: Final = RdfFormat.N_TRIPLES
 
 
 class OxigraphRdfXmlSerializer(_OxigraphSerializer):
-    _format = RdfFormat.RDF_XML
+    _format: Final = RdfFormat.RDF_XML
 
 
 class OxigraphNQuadsSerializer(_OxigraphSerializer):
-    _format = RdfFormat.N_QUADS
+    _format: Final = RdfFormat.N_QUADS
 
 
 class OxigraphTriGSerializer(_OxigraphSerializer):
-    _format = RdfFormat.TRIG
+    _format: Final = RdfFormat.TRIG

tests/test_parser.py

@@ -20,6 +20,11 @@ def test_parse_graph(self) -> None:
         for store in ("default", "oxigraph"):
             for transactional in (True, False):
                 for fmt, serialization in (
+                    ("ox-json-ld", '{"@context":{"v":"http://example.com/vocab#"},"@id":"s","v:p":{"@id":"o"}}'),
+                    (
+                        "ox-streaming-json-ld",
+                        '{"@context":{"v":"http://example.com/vocab#"},"@id":"s","v:p":{"@id":"o"}}',
+                    ),
                     ("ox-turtle", "@prefix v: <http://example.com/vocab#> . <s> v:p <o> ."),
                     ("ox-ttl", "@prefix v: <http://example.com/vocab#> . <s> v:p <o> ."),
                     ("ox-ntriples", "<http://example.com/s> <http://example.com/vocab#p> <http://example.com/o> .\n"),

tests/test_serializer.py

@@ -12,6 +12,14 @@ class TestSerializer(unittest.TestCase):
     def test_serialize_graph(self) -> None:
         for store in ("default", "oxigraph"):
             for fmt, serialization in (
+                (
+                    "ox-json-ld",
+                    '[{"@id":"http://example.com/s","http://example.com/vocab#p":[{"@id":"http://example.com/o"}]}]',
+                ),
+                (
+                    "ox-streaming-json-ld",
+                    '[{"@id":"http://example.com/s","http://example.com/vocab#p":[{"@id":"http://example.com/o"}]}]',
+                ),
                 ("ox-turtle", "<s> v:p <o> .\n"),
                 ("ox-ttl", "<s> v:p <o> .\n"),
                 ("ox-ntriples", "<http://example.com/s> <http://example.com/vocab#p> <http://example.com/o> .\n"),
@@ -39,6 +47,10 @@ def test_serialize_graph(self) -> None:
     def test_serialize_dataset(self) -> None:
         for store in ("default", "oxigraph"):
             for fmt, serialization in (
+                (
+                    "ox-json-ld",
+                    '[{"@id":"http://example.com/g","@graph":[{"@id":"http://example.com/s","http://example.com/vocab#p":[{"@id":"http://example.com/o"}]}]}]',
+                ),
                 (
                     "ox-nquads",
                     "<http://example.com/s> <http://example.com/vocab#p> "