src/rdflib/plugins/serializers/n3.py
1"""
2Notation 3 (N3) RDF graph serializer for RDFLib.
3"""
4
5import warnings
6
7from rdflib.graph import Graph
8from rdflib.namespace import OWL, Namespace
9from rdflib.plugins.serializers.turtle import OBJECT, SUBJECT, TurtleSerializer
10
11__all__ = ["N3Serializer"]
12
13SWAP_LOG = Namespace("http://www.w3.org/2000/10/swap/log#")
14
15
16class N3Serializer(TurtleSerializer):
17 """Notation 3 (N3) RDF graph serializer."""
18
19 short_name = "n3"
20
21 def __init__(self, store: Graph, parent=None):
22 super(N3Serializer, self).__init__(store)
23 self.keywords.update({OWL.sameAs: "=", SWAP_LOG.implies: "=>"})
24 self.parent = parent
25
26 def reset(self):
27 super(N3Serializer, self).reset()
28 self._stores = {}
29
30 def endDocument(self): # noqa: N802
31 if not self.parent:
32 super(N3Serializer, self).endDocument()
33
34 def indent(self, modifier=0):
35 indent = super(N3Serializer, self).indent(modifier)
36 if self.parent is not None:
37 indent += self.parent.indent() # modifier)
38 return indent
39
40 def preprocessTriple(self, triple): # noqa: N802
41 super(N3Serializer, self).preprocessTriple(triple)
42 if isinstance(triple[0], Graph):
43 for t in triple[0]:
44 self.preprocessTriple(t)
45 if isinstance(triple[1], Graph):
46 for t in triple[1]:
47 self.preprocessTriple(t)
48 if isinstance(triple[2], Graph):
49 for t in triple[2]:
50 self.preprocessTriple(t)
51
52 def get_pname(self, uri, gen_prefix=True):
53 qname = None
54 if self.parent is not None:
55 qname = self.parent.get_pname(uri, gen_prefix)
56 if qname is None:
57 qname = super(N3Serializer, self).get_pname(uri, gen_prefix)
58 return qname
59
60 def getQName(self, uri, gen_prefix=True): # noqa: N802
61 warnings.warn(
62 "N3Serializer.getQName is deprecated, use N3Serializer.get_pname instead.",
63 DeprecationWarning,
64 stacklevel=2,
65 )
66 return self.get_pname(uri, gen_prefix)
67
68 def statement(self, subject):
69 self.subjectDone(subject)
70 properties = self.buildPredicateHash(subject)
71 if len(properties) == 0:
72 return False
73 return self.s_clause(subject) or super(N3Serializer, self).statement(subject)
74
75 def path(self, node, position, newline=False):
76 if not self.p_clause(node, position):
77 super(N3Serializer, self).path(node, position, newline)
78
79 def s_clause(self, subject):
80 if isinstance(subject, Graph):
81 self.write("\n" + self.indent())
82 self.p_clause(subject, SUBJECT)
83 self.predicateList(subject)
84 self.write(" .")
85 return True
86 else:
87 return False
88
89 def p_clause(self, node, position):
90 if isinstance(node, Graph):
91 self.subjectDone(node)
92 if position is OBJECT:
93 self.write(" ")
94 self.write("{")
95 self.depth += 1
96 serializer = N3Serializer(node, parent=self)
97 # type error: Argument 1 to "serialize" of "TurtleSerializer" has incompatible type "Optional[IO[bytes]]"; expected "IO[bytes]"
98 serializer.serialize(self.stream) # type: ignore[arg-type]
99 self.depth -= 1
100 self.write(self.indent() + "}")
101 return True
102 else:
103 return False