01iO x S r SSKJr SSKrSSKJrJr SSKJr SSK J
r
J r J r J
r
JrJrJrJrJrJr SSKJrJr \
( a SSKJr SS KJrJrJ r J r SS
K J r S r S r!S
r" S% S&S jjr#\ " S S\5 5 r$ " S S\$5 r% " S S\$5 r& " S S\$5 r' " S S\$5 r( " S S\$5 r) " S S \*5 r+S'S jr,S'S jr- S(S jr. S(S jr/S)S! jr0S*S" jr1S+S# jr2\3S$:X a g\,\l4 \0\l5 \1\l6 \2\l7 \-\l8 \1\$l6 \2\$l7 \0\$l5 \,\$l4 \-\$l8 g),a
This module implements the SPARQL 1.1 Property path operators, as
defined in:
[http://www.w3.org/TR/sparql11-query/#propertypaths](http://www.w3.org/TR/sparql11-query/#propertypaths)
In SPARQL the syntax is as follows:
| Syntax | Matches |
|---------------------|-------------------------------------------------------------------------|
| `iri` | An IRI. A path of length one. |
| `^elt` | Inverse path (object to subject). |
| `elt1 / elt2` | A sequence path of `elt1` followed by `elt2`. |
| `elt1 \| elt2` | An alternative path of `elt1` or `elt2` (all possibilities are tried). |
| `elt*` | A path that connects subject and object by zero or more matches of `elt`.|
| `elt+` | A path that connects subject and object by one or more matches of `elt`.|
| `elt?` | A path that connects subject and object by zero or one matches of `elt`.|
| `!iri` or
`!(iri1 \| ... \| irin)` | Negated property set. An IRI not among `iri1` to `irin`.
`!iri` is short for `!(iri)`. |
| `!^iri` or
`!(^iri1 \| ... \| ^irin)` | Negated reverse property set. Excludes `^iri1` to `^irin` as reverse paths.
`!^iri` is short for `!(^iri)`. |
| `!(iri1 \| ... \| irij \| ^irij+1 \| ... \| ^irin)` | A combination of forward and reverse properties in a negated property set. |
| `(elt)` | A grouped path `elt`, where parentheses control precedence. |
This module is used internally by the SPARQL engine, but the property paths
can also be used to query RDFLib Graphs directly.
Where possible the SPARQL syntax is mapped to Python operators, and property
path objects can be constructed from existing URIRefs.
```python
>>> from rdflib import Graph, Namespace
>>> from rdflib.namespace import FOAF
>>> ~FOAF.knows
Path(~http://xmlns.com/foaf/0.1/knows)
>>> FOAF.knows/FOAF.name
Path(http://xmlns.com/foaf/0.1/knows / http://xmlns.com/foaf/0.1/name)
>>> FOAF.name|FOAF.givenName
Path(http://xmlns.com/foaf/0.1/name | http://xmlns.com/foaf/0.1/givenName)
```
Modifiers (?, \*, +) are done using \* (the multiplication operator) and
the strings '\*', '?', '+', also defined as constants in this file.
```python
>>> FOAF.knows*OneOrMore
Path(http://xmlns.com/foaf/0.1/knows+)
```
The path objects can also be used with the normal graph methods.
First some example data:
```python
>>> g=Graph()
>>> g=g.parse(data='''
... @prefix : .
...
... :a :p1 :c ; :p2 :f .
... :c :p2 :e ; :p3 :g .
... :g :p3 :h ; :p2 :j .
... :h :p3 :a ; :p2 :g .
...
... :q :px :q .
...
... ''', format='n3') # doctest: +ELLIPSIS
>>> e = Namespace('ex:')
```
Graph contains:
```python
>>> (e.a, e.p1/e.p2, e.e) in g
True
```
Graph generator functions, triples, subjects, objects, etc. :
```python
>>> list(g.objects(e.c, (e.p3*OneOrMore)/e.p2)) # doctest: +NORMALIZE_WHITESPACE
[rdflib.term.URIRef('ex:j'), rdflib.term.URIRef('ex:g'),
rdflib.term.URIRef('ex:f')]
```
A more complete set of tests:
```python
>>> list(eval_path(g, (None, e.p1/e.p2, None)))==[(e.a, e.e)]
True
>>> list(eval_path(g, (e.a, e.p1|e.p2, None)))==[(e.a,e.c), (e.a,e.f)]
True
>>> list(eval_path(g, (e.c, ~e.p1, None))) == [ (e.c, e.a) ]
True
>>> list(eval_path(g, (e.a, e.p1*ZeroOrOne, None))) == [(e.a, e.a), (e.a, e.c)]
True
>>> list(eval_path(g, (e.c, e.p3*OneOrMore, None))) == [
... (e.c, e.g), (e.c, e.h), (e.c, e.a)]
True
>>> list(eval_path(g, (e.c, e.p3*ZeroOrMore, None))) == [(e.c, e.c),
... (e.c, e.g), (e.c, e.h), (e.c, e.a)]
True
>>> list(eval_path(g, (e.a, -e.p1, None))) == [(e.a, e.f)]
True
>>> list(eval_path(g, (e.a, -(e.p1|e.p2), None))) == []
True
>>> list(eval_path(g, (e.g, -~e.p2, None))) == [(e.g, e.j)]
True
>>> list(eval_path(g, (e.e, ~(e.p1/e.p2), None))) == [(e.e, e.a)]
True
>>> list(eval_path(g, (e.a, e.p1/e.p3/e.p3, None))) == [(e.a, e.h)]
True
>>> list(eval_path(g, (e.q, e.px*OneOrMore, None)))
[(rdflib.term.URIRef('ex:q'), rdflib.term.URIRef('ex:q'))]
>>> list(eval_path(g, (None, e.p1|e.p2, e.c)))
[(rdflib.term.URIRef('ex:a'), rdflib.term.URIRef('ex:c'))]
>>> list(eval_path(g, (None, ~e.p1, e.a))) == [ (e.c, e.a) ]
True
>>> list(eval_path(g, (None, e.p1*ZeroOrOne, e.c))) # doctest: +NORMALIZE_WHITESPACE
[(rdflib.term.URIRef('ex:c'), rdflib.term.URIRef('ex:c')),
(rdflib.term.URIRef('ex:a'), rdflib.term.URIRef('ex:c'))]
>>> list(eval_path(g, (None, e.p3*OneOrMore, e.a))) # doctest: +NORMALIZE_WHITESPACE
[(rdflib.term.URIRef('ex:h'), rdflib.term.URIRef('ex:a')),
(rdflib.term.URIRef('ex:g'), rdflib.term.URIRef('ex:a')),
(rdflib.term.URIRef('ex:c'), rdflib.term.URIRef('ex:a'))]
>>> list(eval_path(g, (None, e.p3*ZeroOrMore, e.a))) # doctest: +NORMALIZE_WHITESPACE
[(rdflib.term.URIRef('ex:a'), rdflib.term.URIRef('ex:a')),
(rdflib.term.URIRef('ex:h'), rdflib.term.URIRef('ex:a')),
(rdflib.term.URIRef('ex:g'), rdflib.term.URIRef('ex:a')),
(rdflib.term.URIRef('ex:c'), rdflib.term.URIRef('ex:a'))]
>>> list(eval_path(g, (None, -e.p1, e.f))) == [(e.a, e.f)]
True
>>> list(eval_path(g, (None, -(e.p1|e.p2), e.c))) == []
True
>>> list(eval_path(g, (None, -~e.p2, e.j))) == [(e.g, e.j)]
True
>>> list(eval_path(g, (None, ~(e.p1/e.p2), e.a))) == [(e.e, e.a)]
True
>>> list(eval_path(g, (None, e.p1/e.p3/e.p3, e.h))) == [(e.a, e.h)]
True
>>> list(eval_path(g, (e.q, e.px*OneOrMore, None)))
[(rdflib.term.URIRef('ex:q'), rdflib.term.URIRef('ex:q'))]
>>> list(eval_path(g, (e.c, (e.p2|e.p3)*ZeroOrMore, e.j)))
[(rdflib.term.URIRef('ex:c'), rdflib.term.URIRef('ex:j'))]
```
No vars specified:
```python
>>> sorted(list(eval_path(g, (None, e.p3*OneOrMore, None)))) #doctest: +NORMALIZE_WHITESPACE
[(rdflib.term.URIRef('ex:c'), rdflib.term.URIRef('ex:a')),
(rdflib.term.URIRef('ex:c'), rdflib.term.URIRef('ex:g')),
(rdflib.term.URIRef('ex:c'), rdflib.term.URIRef('ex:h')),
(rdflib.term.URIRef('ex:g'), rdflib.term.URIRef('ex:a')),
(rdflib.term.URIRef('ex:g'), rdflib.term.URIRef('ex:h')),
(rdflib.term.URIRef('ex:h'), rdflib.term.URIRef('ex:a'))]
```
) annotationsN)ABCabstractmethod)total_ordering)
TYPE_CHECKINGAnyCallable GeneratorIteratorListOptionalSetTupleUnion)NodeURIRef) _MulPathMod)Graph _ObjectType_PredicateType _SubjectType)NamespaceManager*+?c [ U [ [ 45 ( a- [ U R 5 S: a SU R U5 - $ U R U5 $ )N z(%s))
isinstance SequencePathAlternativePathlenargsn3)argnamespace_managers F/home/james-whalen/.local/lib/python3.13/site-packages/rdflib/paths.py_n3r' sJ # o677CMA# U SS ( a6 [ TXS S 45 H u p4T" U SS XB5 H nX5S 4v M
M" g [ TXS U45 H
u p4X44v M g 7f)Nr r re pathsr6 r7 rf rg r _eval_seqr5 s r& r~ $SequencePath.eval.._eval_seq sv
QRy %ed!Hd-C DDA &uQRy! 9 1g
: E
&ed!Hc-B CDA$J Ds A!A$c 3 ># U S S ( a8 [ TS U S U45 H! u p4T" U S S X5 H nUS U4v M M# g [ TXS U45 H
u p4X44v M g 7f)Nr rz r{ s r& _eval_seq_bw'SequencePath.eval.._eval_seq_bw- sz
Sbz %edE"Is-C DDA &uSbz4 ; dAg
< E
&ed!Hc-B CDA$J Ds A#A&)r| List[Union[Path, URIRef]]r6 rM r7 rN rO 7Generator[Tuple[_SubjectType, _ObjectType], None, None])r| r r6 rM r7 r rO r r" )r4 r5 r6 r7 r r~ s ` @r& r8 SequencePath.eval s , ( ' E , ( E TYY2 2
45 5 TYY2 2r( c L SSR S U R 5 5 - $ )NPath(%s)z / c 3 8 # U H n[ U5 v M g 7fr2 rS .0xs r& (SequencePath.__repr__..C &Ay!s1vvy joinr" r@ s r& rk SequencePath.__repr__B EJJ&Atyy&A AAAr( c N ^ SR U4S jU R 5 5 $ )N/c 3 < ># U H n[ UT5 v M g 7fr2 r' r rv r% s r& r "SequencePath.n3..F E9aA 0119 r r; s `r& r# SequencePath.n3E xxE499EEEr( r r" ro rL r5 r r6 rM r7 rN rO r rp r2 rQ rq r3 r( r& r r sN $ (,%) '3'3 %'3 # '3
A '3RBF Fr( r c V \ rS rSrSS jr S S
S jjrS S jrS S
S jjrSrg)r iI c / U l U HT n[ U[ 5 ( a! U =R UR -
sl M9 U R R U5 MV g r2 )r" r r rt ru s r& rb AlternativePath.__init__J sD /1 A!_-- QVV# # r( Nc # b # U R H n[ XXC45 H nUv M M g 7fr2 )r" re )r4 r5 r6 r7 r ys r& r8 AlternativePath.evalR s- A uQn5 6 s -/c L SSR S U R 5 5 - $ )Nr z | c 3 8 # U H n[ U5 v M g 7fr2 r r s r& r +AlternativePath.__repr__..] r r r r@ s r& rk AlternativePath.__repr__\ r r( c N ^ SR U4S jU R 5 5 $ )N|c 3 < ># U H n[ UT5 v M g 7fr2 r r s r& r %AlternativePath.n3..` r r r r; s `r& r# AlternativePath.n3_ r r( r r rL r rp r2 rQ rq r3 r( r& r r I sM $ (,%) % #
A BF Fr( r c \ \ rS rSrSS jr S S
S jjrS S jrS S
S jjrSrg)MulPathic c Xl X l U[ :X a SU l SU l g U[
:X a SU l SU l g U[ :X a SU l SU l g [ SU- 5 e)NTFzUnknown modifier %s)pathmod ZeroOrOnezeromore
ZeroOrMore OneOrMore Exception)r4 r r s r& rb MulPath.__init__d s_ ) DI DI
J
DI DI
I
DI DI 1C 78 8r( Nc # l ^ ^^^ # T R ( a9 U( a2 U( a U( a X#:X a X#4v OU( a X"4v O U( a X34v S SU UU 4S jjjm S SUUU 4S jjjmSU UU 4S jjn[ 5 nU( a5 T " X#[ 5 5 H nXv; d M
UR U5 Uv M! g U( a5 T" X#[ 5 5 H nXv; d M
UR U5 Uv M! g U" 5 H nXv; d M
UR U5 Uv M! g 7f)Nc 3 ># UR U 5 [ TU T R S 45 HG u p4U( a XA:X a X44v T R ( d M) XB; a M0 T" XAU5 H
u pVX64v M MI g 7fr2 addre r r )
r6 r7 seenrf rg s2o2_fwdr5 r4 s
r& r MulPath.eval.._fwd sk
HHTN!%$ 4)@Aah$J999y "&qt"4 e #5 B AA:#A:c 3 ># UR U5 [ TS T R U45 HG u p4U ( a X:X a X44v T R ( d M) X2; a M0 T" S X25 H
u pVXT4v M MI g 7fr2 r )
r6 r7 r rf rg r r _bwdr5 r4 s
r& r MulPath.eval.._bwd sk
HHSM!%$ 3)?@ty$J999y "&tQ"5 e #6 Ar c 3 ># T R ( a\ [ 5 n TR S 5 H= u pX; a U R U5 X4v X ; d M' U R U5 X"4v M? [ 5 n[ TS T R
S 45 Hg u pT R ( d X4v M X; d M$ UR U5 [ T" US [ 5 5 5 nU H u pVXQ:X d eXV4v M Mi g 7fr2 )r setsubject_objectsr re r r list)
seen1rf rg r fs1o1r r5 r4 s
r& _all_fwd_paths$MulPath.eval.._all_fwd_paths s yy " 1 1$ 7DA~ ! d
~ ! d
8 5D!%$ 4)@Ayy$J} asu!5 6&'FB#%7N7"$&L '( Bs AD A D 8AD )NNN)r6 rM r7 rN r zOptional[Set[_SubjectType]]rO r )r6 rM r7 rN r zOptional[Set[_ObjectType]]rO r )rO r )r r r )
r4 r5 r6 r7 firstr doner r r s
`` @@r& r8 MulPath.evalt s; 99; )Oj h ,0)-04 $( $& $ . $ E $ $( ,0)-/3 $( $& $ - $ E $ $( ) )8 u $SU+=HHQKG , $SU+=HHQKG ,
$%=HHQKG &s B)D438D4/'D4D4c > SU R < U R < S3$ )NzPath(rj )r r r@ s r& rk MulPath.__repr__ s #yy$((33r( c N [ U R U5 < U R < 3$ r2 )r' r r r; s r& r#
MulPath.n3 s TYY(9:DHHEEr( )r r r r )r ro r r )NNT)
r5 r r6 rM r7 rN r rT rO r rp r2 rQ rq r3 r( r& r r c s` 9& (,%) b b %b # b
b
A
b H4F Fr( r c @ \ rS rSrSS jrS S jrS
S jrS S S jjrSrg)
NegatedPathi c U [ U[ [ 45 ( a U/U l g [ U[ 5 ( a UR U l g [ SSU< 3- 5 e)Nz%Can only negate URIRefs, InvPaths or zAlternativePaths, not: )r r r] r" r r ra s r& rb NegatedPath.__init__ sS cFG, - - DI
_
-
-DI71467
r( Nc # & # UR US U45 Hu u pEnU R HZ n[ U[ 5 ( a
XW:X a M2 M" [ U[ 5 ( a XgR
U4U; a M^ MN [
SU- 5 e XF4v Mw g 7f)Nz Invalid path in NegatedPath: %s)triplesr" r r r] r$ r )r4 r5 r6 r7 rf prg rv s r& r8 NegatedPath.eval s }}dD#%67GA!YY a((v 7++55!}- . $$E$IJJ d
8s BBc L SSR S U R 5 5 - $ )Nz
Path(! %s),c 3 8 # U H n[ U5 v M g 7fr2 r r s r& r 'NegatedPath.__repr__.. r r r r@ s r& rk NegatedPath.__repr__ s chh&Atyy&A AAAr( c T ^ SSR U4S jU R 5 5 - $ )Nz!(%s)r c 3 < ># U H n[ UT5 v M g 7fr2 r )r r$ r% s r& r !NegatedPath.n3.. s "T)33s,=#>#>)r r r; s `r& r# NegatedPath.n3 s! #(("T$))"TTUUr( r )r$ z'Union[AlternativePath, InvPath, URIRef]rL rp r2 rQ rq r3 r( r& r r s
BV Vr( r c \ rS rSrSrg)PathListi r3 N)rU rV rW rX r[ r3 r( r& r r s r( r c d [ U[ [ 45 ( d [ S5 e[ X5 $ )z
alternative path
&Only URIRefs or Paths can be in paths!)r r r* r r rD s r& path_alternativer s, efd^ , ,@AA 4 ''r( c d [ U[ [ 45 ( d [ S5 e[ X5 $ )z
sequence path
r )r r r* r r rD s r&
path_sequencer s, efd^ , ,@AA $$r( c V [ R " [ S5 5 [ X5 $ )Nzrdflib.path.evalPath() is deprecated, use the (snake-cased) eval_path(). The mixed-case evalPath() function name is incompatible with PEP8 recommendations and will be replaced by eval_path() in rdflib 7.0.0.)warningswarnDeprecationWarningre r5 ts r& evalPathr s+
MM
S
U r( c 2 S U R U5 5 $ )Nc 3 . # U H u po1U4v M
g 7fr2 r3 )r rf r rg s r& r eval_path..1 s 3"2wqQF"2s )r r s r& re re ) s 4%--"2 33r( c [ X5 $ )z
cardinality path
)r )r muls r& mul_pathr 4 s 1?r( c [ U 5 $ )z
inverse path
)r] r s r& inv_pathr ; s 1:r( c [ U 5 $ )z
negated path
)r r s r& neg_pathr B s q>r( __main__r2 )r$ Union[URIRef, Path]r% rR rO rS )r4 r rE r )r5 r r zWTuple[Optional[_SubjectType], Union[None, Path, _PredicateType], Optional[_ObjectType]]rO rP )r r r r rO r )r r rO r] )r z'Union[URIRef, AlternativePath, InvPath]rO r )9rY
__future__r r abcr r functoolsr typingr r r r
r r r
r r r rdflib.termr r rdflib._type_checkingr rdflib.graphr r r r rdflib.namespacer r r r r' r* r] r r r r r r r r r re r r r rU r, r0 r- r. r/ r3 r( r& r s m^ # # $ %1MM1
OS% %1K%% (3 ( (D8d 8(6F4 6FrFd F4yFd yFx V$ VD t (% 0 $4 44 04 z %FM FN F FN&F DODLDL"DK$Dr(