o
mio# @ sb d Z ddlmZ ddlmZ ddlmZ ddlmZm Z m
Z
m Z G dd dZ dd Z
d
d Zd S )
a
A Describer is a stateful utility for creating RDF statements in a
semi-declarative manner. It has methods for creating literal values, rel and
rev resource relations (somewhat resembling RDFa).
The `Describer.rel` and `Describer.rev` methods return a context manager which sets the current
about to the referenced resource for the context scope (for use with the
`with` statement).
Full example in the `to_rdf` method below:
```python
>>> import datetime
>>> from rdflib.graph import Graph
>>> from rdflib.namespace import Namespace, RDFS, FOAF
>>> ORG_URI = "http://example.org/"
>>> CV = Namespace("http://purl.org/captsolo/resume-rdf/0.2/cv#")
>>> class Person:
... def __init__(self):
... self.first_name = "Some"
... self.last_name = "Body"
... self.username = "some1"
... self.presentation = "Just a Python & RDF hacker."
... self.image = "/images/persons/" + self.username + ".jpg"
... self.site = "http://example.net/"
... self.start_date = datetime.date(2009, 9, 4)
... def get_full_name(self):
... return " ".join([self.first_name, self.last_name])
... def get_absolute_url(self):
... return "/persons/" + self.username
... def get_thumbnail_url(self):
... return self.image.replace('.jpg', '-thumb.jpg')
...
... def to_rdf(self):
... graph = Graph()
... graph.bind('foaf', FOAF)
... graph.bind('cv', CV)
... lang = 'en'
... d = Describer(graph, base=ORG_URI)
... d.about(self.get_absolute_url()+'#person')
... d.rdftype(FOAF.Person)
... d.value(FOAF.name, self.get_full_name())
... d.value(FOAF.givenName, self.first_name)
... d.value(FOAF.familyName, self.last_name)
... d.rel(FOAF.homepage, self.site)
... d.value(RDFS.comment, self.presentation, lang=lang)
... with d.rel(FOAF.depiction, self.image):
... d.rdftype(FOAF.Image)
... d.rel(FOAF.thumbnail, self.get_thumbnail_url())
... with d.rev(CV.aboutPerson):
... d.rdftype(CV.CV)
... with d.rel(CV.hasWorkHistory):
... d.value(CV.startDate, self.start_date)
... d.rel(CV.employedIn, ORG_URI+"#company")
... return graph
...
>>> person_graph = Person().to_rdf()
>>> expected = Graph().parse(data='''
...
...
... Some Body
... Some
... Body
...
...
...
...
...
...
... Just a Python & RDF hacker.
...
...
...
...
...
...
...
...
... 2009-09-04
...
...
...
...
...
... ''', format="xml")
>>> from rdflib.compare import isomorphic
>>> isomorphic(person_graph, expected) #doctest: +SKIP
True
```
)contextmanager)Graph)RDF)BNode
IdentifierLiteralURIRefc @ sV e Zd ZdddZdd Zdd Zddd Zdd
d Zd d
Zdd Z e
dd Z dS ) DescriberNc C s2 |d u rt }|| _|| _g | _| |pd d S N)r graphbase _subjectsabout)selfr r r r Q/home/kim/smarthome/.venv/lib/python3.10/site-packages/rdflib/extras/describer.py__init__t s zDescriber.__init__c K sB | d| j t|fi |}| jr|| jd< dS | j| dS )a
Sets the current subject. Will convert the given object into an
`URIRef` if it's not an `Identifier`.
Example:
```python
>>> d = Describer()
>>> d._current() #doctest: +ELLIPSIS
rdflib.term.BNode(...)
>>> d.about("http://example.org/")
>>> d._current()
rdflib.term.URIRef('http://example.org/')
```
r N)
setdefaultr cast_identifierr
append)r subjectkwsr r r r | s
zDescriber.aboutc K s* t |fi |}| j| ||f dS )a
Set a literal value for the given property. Will cast the value to an
`Literal` if a plain literal is given.
Example:
```python
>>> from rdflib import URIRef
>>> from rdflib.namespace import RDF, RDFS
>>> d = Describer(about="http://example.org/")
>>> d.value(RDFS.label, "Example")
>>> d.graph.value(URIRef('http://example.org/'), RDFS.label)
rdflib.term.Literal('Example')
```
N)
cast_valuer add_current)r pvr r r r value s zDescriber.valuec K sF | d| j t|}t|fi |}| j| ||f | |S )a< Set an object for the given property. Will convert the given object
into an `URIRef` if it's not an `Identifier`. If none is given, a
new `BNode` is used.
Returns a context manager for use in a `with` block, within which the
given object is used as current subject.
Example:
```python
>>> from rdflib import URIRef
>>> from rdflib.namespace import RDF, RDFS
>>> d = Describer(about="/", base="http://example.org/")
>>> _ctxt = d.rel(RDFS.seeAlso, "/about")
>>> d.graph.value(URIRef('http://example.org/'), RDFS.seeAlso)
rdflib.term.URIRef('http://example.org/about')
>>> with d.rel(RDFS.seeAlso, "/more"):
... d.value(RDFS.label, "More")
>>> (URIRef('http://example.org/'), RDFS.seeAlso,
... URIRef('http://example.org/more')) in d.graph
True
>>> d.graph.value(URIRef('http://example.org/more'), RDFS.label)
rdflib.term.Literal('More')
```
r r r r r r r _subject_stack)r r or r r r rel s
z
Describer.relc K sF | d| j t|}t|fi |}| j||| f | |S )a
Same as `rel`, but uses current subject as *object* of the relation.
The given resource is still used as subject in the returned context
manager.
Example:
```python
>>> from rdflib import URIRef
>>> from rdflib.namespace import RDF, RDFS
>>> d = Describer(about="http://example.org/")
>>> with d.rev(RDFS.seeAlso, "http://example.net/"):
... d.value(RDFS.label, "Net")
>>> (URIRef('http://example.net/'), RDFS.seeAlso,
... URIRef('http://example.org/')) in d.graph
True
>>> d.graph.value(URIRef('http://example.net/'), RDFS.label)
rdflib.term.Literal('Net')
```
r r )r r sr r r r rev s
z
Describer.revc C s | j | tj|f dS )a Shorthand for setting rdf:type of the current subject.
Example:
```python
>>> from rdflib import URIRef
>>> from rdflib.namespace import RDF, RDFS
>>> d = Describer(about="http://example.org/")
>>> d.rdftype(RDFS.Resource)
>>> (URIRef('http://example.org/'),
... RDF.type, RDFS.Resource) in d.graph
True
```
N)r r r r type)r tr r r rdftype s zDescriber.rdftypec C s
| j d S )Nr )r
)r r r r r s
zDescriber._currentc c s" | j | d V | j d S r
)r
r pop)r r r r r r s zDescriber._subject_stack)NNNr
) __name__
__module__ __qualname__r r r r" r$ r' r r r r r r r r s s
"r c K s t | ts
t| fi |} | S r
)
isinstancer )r r r r r r s
r c K s( | pt } t| tst| fi |} | S r
)r r, r r )refr r r r r s
r N)__doc__
contextlibr Z rdflib.graphr Zrdflib.namespacer Z rdflib.termr r r r r r r r r r r s k