o
miO @ s d Z ddlmZ ddlZddlmZmZ ddlmZ ddl m
Z
m Z m Z m
Z
mZmZmZmZmZmZ ddlmZmZ e
rTddlmZ dd lmZmZm Z m Z dd
l m Z d Z d Z!d
Z" d>d?ddZ#eG dd deZ$G dd de$Z%G dd de$Z&G d d d e$Z'G d d d e$Z(G d d! d!e$Z)G d"d# d#e*Z+d@d&d'Z,d@d(d)Z-dAd/d0Z.dAd1d2Z/dBd6d7Z0dCd8d9Z1dDd;d<Z2e3d=krdS e,e_4e0e_5e1e_6e2e_7e-e_8e1e$_6e2e$_7e0e$_5e,e$_4e-e$_8dS )Ea
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*+?argUnion[URIRef, Path]namespace_managerOptional[NamespaceManager]returnstrc C s4 t | ttfrt| jdkrd| | S | |S )N z(%s))
isinstance SequencePathAlternativePathlenargsn3)r r r( F/home/kim/smarthome/.venv/lib/python3.10/site-packages/rdflib/paths.py_n3 s
r* c @ sx e Zd ZU dZded< ded< ded< ded < d
ed < e d%d&ddZed'd(ddZd d Zd d Z d)d#d$Z
d S )*Pathz"Base class for all property paths.z6Callable[[Path, Union[URIRef, Path]], AlternativePath]__or__zCallable[[Path], InvPath]
__invert__z Callable[[Path], NegatedPath]__neg__z3Callable[[Path, Union[URIRef, Path]], SequencePath] __truediv__z Callable[[Path, str], MulPath]__mul__Ngraphr subjOptional[_SubjectType]objOptional[_ObjectType]r *Iterator[Tuple[_SubjectType, _ObjectType]]c C d S Nr( )selfr1 r2 r4 r( r( r) eval s z Path.evalr r r c C r7 r8 r( r9 r r( r( r) r' s zPath.n3c C s t t| S r8 )hashreprr9 r( r( r) __hash__ z
Path.__hash__c C s t | t |kS r8 )r= r9 otherr( r( r) __eq__ z Path.__eq__rB r boolc C s6 t |ttfstdt| t|f t| t|k S )Nz unorderable types: %s() < %s())r" r+ r TypeErrorr= rA r( r( r) __lt__ s
z Path.__lt__NN)r1 r r2 r3 r4 r5 r r6 r8 r r r r )rB r r rE ) __name__
__module__ __qualname____doc____annotations__r r: r' r? rC rG r( r( r( r) r+ s
r+ c @ < e Zd ZdddZ ddddZdddZdd ddZdS ) InvPathr Union[Path, URIRef]c C s
|| _ d S r8 r r9 r r( r( r) __init__ s
zInvPath.__init__Nr1 r r2 r3 r4 r5 r 7Generator[Tuple[_ObjectType, _SubjectType], None, None]c c s, t ||| j|fD ] \}}||fV q
d S r8 ) eval_pathr )r9 r1 r2 r4 sor( r( r) r: s z InvPath.evalr c C s d| j f S )Nz Path(~%s)rR r> r( r( r) __repr__ r@ zInvPath.__repr__r r c C s dt | j| S )Nz^%s)r* r r; r( r( r) r' rD z
InvPath.n3)r rQ rH )r1 r r2 r3 r4 r5 r rU r r r8 rI rJ rK rL rT r: rY r' r( r( r( r) rP s
rP c @ rO ) r# r& rQ c G < g | _ |D ]}t|tr| j |j 7 _ q| j | qd S r8 )r& r" r# appendr9 r& ar( r( r) rT
zSequencePath.__init__Nr1 r r2 r3 r4 r5 r 7Generator[Tuple[_SubjectType, _ObjectType], None, None]c sR d fd d
d fd d
}|r | j ||S |r"|| j ||S | j ||S )NpathsList[Union[Path, URIRef]]r2 r3 r4 r5 r ra c 3 s | dd r,t || d d fD ]\}} | dd ||D ] }||d fV q qd S t || d |fD ] \}}||fV q6d S )Nr! r rV rb r2 r4 rW rX r _eval_seqr1 r( r) rh z$SequencePath.eval.._eval_seqr c 3 s | d d r,t d | d |fD ]\}} | d d ||D ] }|d |fV q qd S t || d |fD ] \}}||fV q6d S )Nr rd re rg r( r) _eval_seq_bw- ri z'SequencePath.eval.._eval_seq_bw)rb rc r2 r3 r4 r5 r ra )rb rc r2 r3 r4 r r ra )r& )r9 r1 r2 r4 rk r( rg r) r: s zSequencePath.evalr c C dd dd | jD S )NPath(%s)z / c s | ]}t |V qd S r8 r .0xr( r( r) C z(SequencePath.__repr__..joinr& r> r( r( r) rY B zSequencePath.__repr__r r c d fdd| jD S )N/c 3 | ]}t | V qd S r8 r* rq r_ r r( r) rs F z"SequencePath.n3..ru r; r( r} r) r' E rw zSequencePath.n3r& rQ rH r1 r r2 r3 r4 r5 r ra rZ r8 rI r[ r( r( r( r) r# s
)r# c @ rO ) r$ r& rQ c G r\ r8 )r& r" r$ r] r^ r( r( r) rT J r` zAlternativePath.__init__Nr1 r r2 r3 r4 r5 r ra c c s. | j D ]}t||||fD ]}|V qqd S r8 )r& rV )r9 r1 r2 r4 rr yr( r( r) r: R s
zAlternativePath.evalr c C rl )Nrm z | c s rn r8 ro rp r( r( r) rs ] rt z+AlternativePath.__repr__..ru r> r( r( r) rY \ rw zAlternativePath.__repr__r r c rx )N|c 3 rz r8 r{ r| r} r( r) rs ` r~ z%AlternativePath.n3..ru r; r( r} r) r' _ rw zAlternativePath.n3r rH r rZ r8 rI r[ r( r( r( r) r$ I s
r$ c @ s> e Zd Zd ddZ d d ddZd ddZd d!ddZdS )"MulPathpathrQ modr c C s` || _ || _|tkrd| _d| _d S |tkr d| _d| _d S |tkr*d| _d| _d S td| )NTFzUnknown modifier %s)r r ZeroOrOnezeromore
ZeroOrMore OneOrMore Exception)r9 r r r( r( r) rT d s
zMulPath.__init__NTr1 r r2 r3 r4 r5 firstrE r ra c # s" j r#|r#|r|r||kr||fV n|r ||fV n|r#||fV ddfd d
dd fd d
dfdd }t }|rc||t D ]}||vr`|| |V qRd S |r} ||t D ]}||vrz|| |V qld S | D ]}||vr|| |V qd S )Nr2 r3 r4 r5 seenOptional[Set[_SubjectType]]r ra c 3 sr | | t| jd fD ]'\}}|r||kr ||fV jr6||v r&q |||D ] \}}||fV q,qd S r8 addrV r r r2 r4 r rW rX s2o2_fwdr1 r9 r( r) r s
zMulPath.eval.._fwdOptional[Set[_ObjectType]]c 3 sr | | td j|fD ]'\}}| r| |kr ||fV jr6||v r&q d ||D ] \}}||fV q,qd S r8 r r )_bwdr1 r9 r( r) r s
zMulPath.eval.._bwdc 3 s j r-t } d D ] \}}|| vr | | ||fV || vr,| | ||fV q t }td jd fD ]1\}}jsF||fV q9||vrj|| t |d t }|D ]\}}||ksdJ ||fV qZq9d S r8 )r setZsubject_objectsr rV r r list)Zseen1rW rX r fs1Zo1r r( r) _all_fwd_paths s.
z$MulPath.eval.._all_fwd_paths)NNN)r2 r3 r4 r5 r r r ra )r2 r3 r4 r5 r r r ra )r ra )r r r )r9 r1 r2 r4 r r donerr r( )r r r1 r9 r) r: t sP
z MulPath.evalr c C s d| j | jf S )Nz
Path(%s%s))r r r> r( r( r) rY rD zMulPath.__repr__r r c C s dt | j|| jf S )Nz%s%s)r* r r r; r( r( r) r' s z
MulPath.n3)r rQ r r )NNT)
r1 r r2 r3 r4 r5 r rE r ra rZ r8 rI r[ r( r( r( r) r c s
dr c @ s6 e Zd ZdddZdddZdd
d ZddddZdS ) NegatedPathr 'Union[AlternativePath, InvPath, URIRef]c C sF | t |ttfr|g| _d S t |tr|j| _d S tdd|f )Nz%Can only negate URIRefs, InvPaths or zAlternativePaths, not: %s)r" r rP r& r$ r rS r( r( r) rT s
zNegatedPath.__init__Nc c sz | |d |fD ]1\}}}| jD ]#}t|tr ||kr n qt|tr/||j|f|v r. n qtd| ||fV q d S )Nz Invalid path in NegatedPath: %s)triplesr& r" r rP r r )r9 r1 r2 r4 rW prX r_ r( r( r) r: s
zNegatedPath.evalr r c C rl )Nz
Path(! %s),c s rn r8 ro rp r( r( r) rs rt z'NegatedPath.__repr__..ru r> r( r( r) rY rw zNegatedPath.__repr__r r c s dd fdd| jD S )Nz!(%s)r c 3 rz r8 r{ )rq r r} r( r) rs r~ z!NegatedPath.n3..ru r; r( r} r) r' s zNegatedPath.n3)r r rH rZ r8 rI r[ r( r( r( r) r s
r c @ s e Zd ZdS )PathListN)rJ rK rL r( r( r( r) r s r r9 rB c C t |ttfs tdt| |S )z
alternative path
&Only URIRefs or Paths can be in paths!)r" r r+ r r$ rA r( r( r) path_alternative
r c C r )z
sequence path
r )r" r r+ r r# rA r( r( r)
path_sequence r r r1 r tWTuple[Optional[_SubjectType], Union[None, Path, _PredicateType], Optional[_ObjectType]]r6 c C s t td t| |S )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.)warningswarnDeprecationWarningrV r1 r r( r( r) evalPath s
r c C s dd | |D S )Nc s s | ]
\}}}||fV qd S r8 r( )rq rW r rX r( r( r) rs 1 s z eval_path..)r r r( r( r) rV ) s rV r mulr c C s
t | |S )z
cardinality path
)r )r r r( r( r) mul_path4 s
r c C t | S )z
inverse path
)rP r r( r( r) inv_path; r 'Union[URIRef, AlternativePath, InvPath]c C r )z
negated path
)r r r( r( r) neg_pathB r r __main__r8 )r r r r r r )r9 r rB r )r1 r r r r r6 )r r r r r r )r r r rP )r r r r )9rM
__future__r r abcr r functoolsr typingr r r r r
r r r
r r Z rdflib.termr r Zrdflib._type_checkingr Z rdflib.graphr r r r Zrdflib.namespacer r r r r* r+ rP r# r$ r r r r r r r rV r r r rJ r, r0 r- r. r/ r( r( r( r) sX 0 0
"9|"