Fixes typos in the documentation

pull/46/head
Tpt 4 years ago
parent 54fdb91dac
commit ffdc68ebf6
  1. 2
      js/README.md
  2. 8
      lib/src/sparql/mod.rs
  3. 12
      python/README.md
  4. 10
      python/docs/index.rst
  5. 4
      python/src/io.rs
  6. 12
      python/src/memory_store.rs
  7. 2
      python/src/model.rs
  8. 14
      python/src/sled_store.rs

@ -9,7 +9,7 @@ This package provides a JavaScript API on top of Oxigraph compiled with WebAssem
Oxigraph is a graph database written in Rust implementing the [SPARQL](https://www.w3.org/TR/sparql11-overview/) standard. Oxigraph is a graph database written in Rust implementing the [SPARQL](https://www.w3.org/TR/sparql11-overview/) standard.
Oxigraph or JavaScript is a work in progress and currently offers a simple in-memory store with [SPARQL 1.1 Query](https://www.w3.org/TR/sparql11-query/) capabilities. Oxigraph for JavaScript is a work in progress and currently offers a simple in-memory store with [SPARQL 1.1 Query](https://www.w3.org/TR/sparql11-query/) capabilities.
The store is also able to load RDF serialized in [Turtle](https://www.w3.org/TR/turtle/), [TriG](https://www.w3.org/TR/trig/), [N-Triples](https://www.w3.org/TR/n-triples/), [N-Quads](https://www.w3.org/TR/n-quads/) and [RDF/XML](https://www.w3.org/TR/rdf-syntax-grammar/). The store is also able to load RDF serialized in [Turtle](https://www.w3.org/TR/turtle/), [TriG](https://www.w3.org/TR/trig/), [N-Triples](https://www.w3.org/TR/n-triples/), [N-Quads](https://www.w3.org/TR/n-quads/) and [RDF/XML](https://www.w3.org/TR/rdf-syntax-grammar/).

@ -206,16 +206,16 @@ impl QueryOptions {
self self
} }
/// Adds a named graph to the set of graphs considered by the SPARQL query as the queried dataset default graph /// Adds a named graph to the set of graphs considered by the SPARQL query as the queried dataset default graph.
/// Overrides the `FROM` and `FROM NAMED` elements of the evaluated query /// It overrides the `FROM` and `FROM NAMED` elements of the evaluated query.
#[inline] #[inline]
pub fn with_default_graph(mut self, default_graph_name: impl Into<NamedNode>) -> Self { pub fn with_default_graph(mut self, default_graph_name: impl Into<NamedNode>) -> Self {
self.dataset.default.push(default_graph_name.into()); self.dataset.default.push(default_graph_name.into());
self self
} }
/// Adds a named graph to the set of graphs considered by the SPARQL query as the queried dataset named graphs /// Adds a named graph to the set of graphs considered by the SPARQL query as the queried dataset named graphs.
/// Overrides the `FROM` and `FROM NAMED` elements of the evaluated query /// It overrides the `FROM` and `FROM NAMED` elements of the evaluated query.
#[inline] #[inline]
pub fn with_named_graph(mut self, named_graph_name: impl Into<NamedNode>) -> Self { pub fn with_named_graph(mut self, named_graph_name: impl Into<NamedNode>) -> Self {
self.dataset.named.push(named_graph_name.into()); self.dataset.named.push(named_graph_name.into());

@ -23,9 +23,9 @@ It also provides a set of utility functions for reading, writing and processing
Pyoxigraph is distributed [on Pypi](https://pypi.org/project/pyoxigraph/). Pyoxigraph is distributed [on Pypi](https://pypi.org/project/pyoxigraph/).
Run `pip install pyoxigraph` to install it. Run `pip install pyoxigraph` to install it.
There exists also a small library providing [rdflib](https://rdflib.readthedocs.io) store using pyoxigraph: [oxrdflib](https://github.com/oxigraph/oxrdflib). There exists also a small library providing [rdflib](https://rdflib.readthedocs.io) stores using pyoxigraph: [oxrdflib](https://github.com/oxigraph/oxrdflib).
Pyoxigraph documentation is [available on Oxigraph website](https://oxigraph.org/pyoxigraph/). Pyoxigraph documentation is [available on the Oxigraph website](https://oxigraph.org/pyoxigraph/).
## Build the development version ## Build the development version
@ -37,12 +37,12 @@ and to run `pip install .` in the `python` directory (the one this README is in)
Pyoxigraph is written in Rust using [PyO3](https://github.com/PyO3/pyo3). Pyoxigraph is written in Rust using [PyO3](https://github.com/PyO3/pyo3).
Pyoxigraph is build using [Maturin](https://github.com/PyO3/maturin). Pyoxigraph is built using [Maturin](https://github.com/PyO3/maturin).
Maturin could be installed using the usual `pip install maturin`. Maturin could be installed using the `pip install maturin`.
To install a development version of Oxigraph just run `maturin develop`. To install a development version of Oxigraph just run `maturin develop` in this README directory.
The Python bindings tests are written in Python. The Python bindings tests are written in Python.
To run them use the usual `python -m unittest` in the `tests` directory. To run them use `python -m unittest` in the `tests` directory.
To release a new version of Pyoxigraph run: To release a new version of Pyoxigraph run:
```bash ```bash

@ -12,9 +12,9 @@ pyoxigraph |release|
:alt: PyPI - License :alt: PyPI - License
Pyoxigraph is a graph database library implementing the `SPARQL <https://www.w3.org/TR/sparql11-overview/>`_ standard. Pyoxigraph is a Python graph database library implementing the `SPARQL <https://www.w3.org/TR/sparql11-overview/>`_ standard.
It is built on top of `Oxigraph <https://github.com/oxigraph/oxigraph>`_ using `PyO3 <https://pyo3.rs/>`_ to provides a Python API. It is built on top of `Oxigraph <https://github.com/oxigraph/oxigraph>`_ using `PyO3 <https://pyo3.rs/>`_.
It offers two stores with `SPARQL 1.1 Query <https://www.w3.org/TR/sparql11-query/>`_ capabilities. It offers two stores with `SPARQL 1.1 Query <https://www.w3.org/TR/sparql11-query/>`_ capabilities.
One of the store is in-memory, and the other one is disk based. One of the store is in-memory, and the other one is disk based.
@ -28,7 +28,7 @@ It also provides a set of utility functions for reading, writing and processing
Pyoxigraph is `distributed on Pypi <https://pypi.org/project/pyoxigraph/>`_. Pyoxigraph is `distributed on Pypi <https://pypi.org/project/pyoxigraph/>`_.
There exists also a small library providing `rdflib <https://rdflib.readthedocs.io>`_ store using pyoxigraph: `oxrdflib <https://github.com/oxigraph/oxrdflib>`_. There exists also a small library providing `rdflib <https://rdflib.readthedocs.io>`_ stores using pyoxigraph: `oxrdflib <https://github.com/oxigraph/oxrdflib>`_.
Oxigraph and pyoxigraph source code are on `GitHub <https://github.com/oxigraph/oxigraph/tree/master/python>`_. Oxigraph and pyoxigraph source code are on `GitHub <https://github.com/oxigraph/oxigraph/tree/master/python>`_.
@ -52,8 +52,8 @@ Insert the triple ``<http://example/> <http://schema.org/name> "example"`` and p
store = MemoryStore() store = MemoryStore()
ex = NamedNode('http://example/') ex = NamedNode('http://example/')
schemaName = NamedNode('http://schema.org/name') schema_name = NamedNode('http://schema.org/name')
store.add((ex, schemaName, Literal('example'))) store.add(Quad(ex, schema_name, Literal('example')))
for binding in store.query('SELECT ?name WHERE { <http://example/> <http://schema.org/name> ?name }'): for binding in store.query('SELECT ?name WHERE { <http://example/> <http://schema.org/name> ?name }'):
print(binding['name'].value) print(binding['name'].value)

@ -36,7 +36,7 @@ pub fn add_to_module(module: &PyModule) -> PyResult<()> {
/// :param mime_type: the MIME type of the RDF serialization /// :param mime_type: the MIME type of the RDF serialization
/// :type mime_type: str /// :type mime_type: str
/// :param base_iri: the base IRI used to resolve the relative IRIs in the file or :py:const:`None` if relative IRI resolution should not be done /// :param base_iri: the base IRI used to resolve the relative IRIs in the file or :py:const:`None` if relative IRI resolution should not be done
/// :type base_iri: str or None /// :type base_iri: str or None, optional
/// :return: an iterator of RDF triples or quads depending on the format /// :return: an iterator of RDF triples or quads depending on the format
/// :rtype: iter(Triple) or iter(Quad) /// :rtype: iter(Triple) or iter(Quad)
/// :raises ValueError: if the MIME type is not supported /// :raises ValueError: if the MIME type is not supported
@ -99,7 +99,7 @@ pub fn parse(
/// and ``application/xml`` for `RDF/XML <https://www.w3.org/TR/rdf-syntax-grammar/>`_. /// and ``application/xml`` for `RDF/XML <https://www.w3.org/TR/rdf-syntax-grammar/>`_.
/// ///
/// :param input: the RDF triples and quads to serialize /// :param input: the RDF triples and quads to serialize
/// :type input: iterable(Triple) or iterable(Quad) /// :type input: iter(Triple) or iter(Quad)
/// :param output: The binary I/O object to write to. For example, it could be a file opened in binary mode with ``open('my_file.ttl', 'wb')``. /// :param output: The binary I/O object to write to. For example, it could be a file opened in binary mode with ``open('my_file.ttl', 'wb')``.
/// :type output: io.RawIOBase or io.BufferedIOBase /// :type output: io.RawIOBase or io.BufferedIOBase
/// :param mime_type: the MIME type of the RDF serialization /// :param mime_type: the MIME type of the RDF serialization

@ -109,11 +109,11 @@ impl PyMemoryStore {
/// :param query: the query to execute /// :param query: the query to execute
/// :type query: str /// :type query: str
/// :param use_default_graph_as_union: optional, if the SPARQL query should look for triples in all the dataset graphs by default (i.e. without `GRAPH` operations). Disabled by default. /// :param use_default_graph_as_union: optional, if the SPARQL query should look for triples in all the dataset graphs by default (i.e. without `GRAPH` operations). Disabled by default.
/// :type use_default_graph_as_union: bool /// :type use_default_graph_as_union: bool, optional
/// :param default_graph_uris: optional, list of the named graph URIs that should be used as the query default graph. By default the store default graph is used. /// :param default_graph_uris: optional, list of the named graph URIs that should be used as the query default graph. By default the store default graph is used.
/// :type default_graph_uris: list(NamedNode),None /// :type default_graph_uris: list(NamedNode) or None, optional
/// :param named_graph_uris: optional, list of the named graph URIs that could be used in SPARQL `GRAPH` clause. By default all the store default graphs are available. /// :param named_graph_uris: optional, list of the named graph URIs that could be used in SPARQL `GRAPH` clause. By default all the store default graphs are available.
/// :type named_graph_uris: list(NamedNode),None /// :type named_graph_uris: list(NamedNode) or None, optional
/// :return: a :py:class:`bool` for ``ASK`` queries, an iterator of :py:class:`Triple` for ``CONSTRUCT`` and ``DESCRIBE`` queries and an iterator of :py:class:`QuerySolution` for ``SELECT`` queries. /// :return: a :py:class:`bool` for ``ASK`` queries, an iterator of :py:class:`Triple` for ``CONSTRUCT`` and ``DESCRIBE`` queries and an iterator of :py:class:`QuerySolution` for ``SELECT`` queries.
/// :rtype: QuerySolutions or QueryTriples or bool /// :rtype: QuerySolutions or QueryTriples or bool
/// :raises SyntaxError: if the provided query is invalid /// :raises SyntaxError: if the provided query is invalid
@ -186,9 +186,9 @@ impl PyMemoryStore {
/// :param mime_type: the MIME type of the RDF serialization /// :param mime_type: the MIME type of the RDF serialization
/// :type mime_type: str /// :type mime_type: str
/// :param base_iri: the base IRI used to resolve the relative IRIs in the file or :py:const:`None` if relative IRI resolution should not be done /// :param base_iri: the base IRI used to resolve the relative IRIs in the file or :py:const:`None` if relative IRI resolution should not be done
/// :type base_iri: str or None /// :type base_iri: str or None, optional
/// :param to_graph: if it is a file composed of triples, the graph in which store the triples. By default, the default graph is used. /// :param to_graph: if it is a file composed of triples, the graph in which store the triples. By default, the default graph is used.
/// :type to_graph: NamedNode or BlankNode or DefaultGraph or None /// :type to_graph: NamedNode or BlankNode or DefaultGraph or None, optional
/// :raises ValueError: if the MIME type is not supported or the `to_graph` parameter is given with a quad file. /// :raises ValueError: if the MIME type is not supported or the `to_graph` parameter is given with a quad file.
/// :raises SyntaxError: if the provided data is invalid /// :raises SyntaxError: if the provided data is invalid
/// ///
@ -257,7 +257,7 @@ impl PyMemoryStore {
/// :param mime_type: the MIME type of the RDF serialization /// :param mime_type: the MIME type of the RDF serialization
/// :type mime_type: str /// :type mime_type: str
/// :param from_graph: if a triple based format is requested, the store graph from which dump the triples. By default, the default graph is used. /// :param from_graph: if a triple based format is requested, the store graph from which dump the triples. By default, the default graph is used.
/// :type from_graph: NamedNode or BlankNode or DefaultGraph or None /// :type from_graph: NamedNode or BlankNode or DefaultGraph or None, optional
/// :raises ValueError: if the MIME type is not supported or the `from_graph` parameter is given with a quad syntax. /// :raises ValueError: if the MIME type is not supported or the `from_graph` parameter is given with a quad syntax.
/// ///
/// >>> store = MemoryStore() /// >>> store = MemoryStore()

@ -514,7 +514,7 @@ impl PyIterProtocol for PyTriple {
/// :param object: the quad object /// :param object: the quad object
/// :type object: NamedNode or BlankNode or Literal /// :type object: NamedNode or BlankNode or Literal
/// :param graph: the quad graph name. If not present, the default graph is assumed. /// :param graph: the quad graph name. If not present, the default graph is assumed.
/// :type object: NamedNode or BlankNode or DefaultGraph or None /// :type graph: NamedNode or BlankNode or DefaultGraph or None, optional
/// ///
/// The :py:func:`str` function provides a serialization compatible with NTriples, Turtle and SPARQL: /// The :py:func:`str` function provides a serialization compatible with NTriples, Turtle and SPARQL:
/// ///

@ -17,7 +17,7 @@ use std::io::BufReader;
/// It encodes a `RDF dataset <https://www.w3.org/TR/rdf11-concepts/#dfn-rdf-dataset>`_ and allows to query it using SPARQL. /// It encodes a `RDF dataset <https://www.w3.org/TR/rdf11-concepts/#dfn-rdf-dataset>`_ and allows to query it using SPARQL.
/// ///
/// :param path: the path of the directory in which Sled should read and write its data. If the directory does not exist, it is created. If no directory is provided a temporary one is created and removed when the Python garbage collector removes the store. /// :param path: the path of the directory in which Sled should read and write its data. If the directory does not exist, it is created. If no directory is provided a temporary one is created and removed when the Python garbage collector removes the store.
/// :type path: str or None /// :type path: str or None, optional
/// :raises IOError: if the target directory contains invalid data or could not be accessed /// :raises IOError: if the target directory contains invalid data or could not be accessed
/// ///
/// Warning: Sled is not stable yet and might break its storage format. /// Warning: Sled is not stable yet and might break its storage format.
@ -124,11 +124,11 @@ impl PySledStore {
/// :param query: the query to execute /// :param query: the query to execute
/// :type query: str /// :type query: str
/// :param use_default_graph_as_union: optional, if the SPARQL query should look for triples in all the dataset graphs by default (i.e. without `GRAPH` operations). Disabled by default. /// :param use_default_graph_as_union: optional, if the SPARQL query should look for triples in all the dataset graphs by default (i.e. without `GRAPH` operations). Disabled by default.
/// :type use_default_graph_as_union: bool /// :type use_default_graph_as_union: bool, optional
/// :param default_graph_uris: optional, list of the named graph URIs that should be used as the query default graph. By default the store default graph is used. /// :param default_graph_uris: optional, list of the named graph URIs that should be used as the query default graph. By default the store default graph is used.
/// :type default_graph_uris: list(NamedNode),None /// :type default_graph_uris: list(NamedNode) or None, optional
/// :param named_graph_uris: optional, list of the named graph URIs that could be used in SPARQL `GRAPH` clause. By default all the store default graphs are available. /// :param named_graph_uris: optional, list of the named graph URIs that could be used in SPARQL `GRAPH` clause. By default all the store default graphs are available.
/// :type named_graph_uris: list(NamedNode),None /// :type named_graph_uris: list(NamedNode) or None, optional
/// :return: a :py:class:`bool` for ``ASK`` queries, an iterator of :py:class:`Triple` for ``CONSTRUCT`` and ``DESCRIBE`` queries and an iterator of :py:class:`QuerySolution` for ``SELECT`` queries. /// :return: a :py:class:`bool` for ``ASK`` queries, an iterator of :py:class:`Triple` for ``CONSTRUCT`` and ``DESCRIBE`` queries and an iterator of :py:class:`QuerySolution` for ``SELECT`` queries.
/// :rtype: QuerySolutions or QueryTriples or bool /// :rtype: QuerySolutions or QueryTriples or bool
/// :raises SyntaxError: if the provided query is invalid /// :raises SyntaxError: if the provided query is invalid
@ -202,9 +202,9 @@ impl PySledStore {
/// :param mime_type: the MIME type of the RDF serialization /// :param mime_type: the MIME type of the RDF serialization
/// :type mime_type: str /// :type mime_type: str
/// :param base_iri: the base IRI used to resolve the relative IRIs in the file or :py:const:`None` if relative IRI resolution should not be done /// :param base_iri: the base IRI used to resolve the relative IRIs in the file or :py:const:`None` if relative IRI resolution should not be done
/// :type base_iri: str or None /// :type base_iri: str or None, optional
/// :param to_graph: if it is a file composed of triples, the graph in which store the triples. By default, the default graph is used. /// :param to_graph: if it is a file composed of triples, the graph in which store the triples. By default, the default graph is used.
/// :type to_graph: NamedNode or BlankNode or DefaultGraph or None /// :type to_graph: NamedNode or BlankNode or DefaultGraph or None, optional
/// :raises ValueError: if the MIME type is not supported or the `to_graph` parameter is given with a quad file. /// :raises ValueError: if the MIME type is not supported or the `to_graph` parameter is given with a quad file.
/// :raises SyntaxError: if the provided data is invalid /// :raises SyntaxError: if the provided data is invalid
/// :raises IOError: if an I/O error happens during a quad insertion /// :raises IOError: if an I/O error happens during a quad insertion
@ -274,7 +274,7 @@ impl PySledStore {
/// :param mime_type: the MIME type of the RDF serialization /// :param mime_type: the MIME type of the RDF serialization
/// :type mime_type: str /// :type mime_type: str
/// :param from_graph: if a triple based format is requested, the store graph from which dump the triples. By default, the default graph is used. /// :param from_graph: if a triple based format is requested, the store graph from which dump the triples. By default, the default graph is used.
/// :type from_graph: NamedNode or BlankNode or DefaultGraph or None /// :type from_graph: NamedNode or BlankNode or DefaultGraph or None, optional
/// :raises ValueError: if the MIME type is not supported or the `from_graph` parameter is given with a quad syntax. /// :raises ValueError: if the MIME type is not supported or the `from_graph` parameter is given with a quad syntax.
/// :raises IOError: if an I/O error happens during a quad lookup /// :raises IOError: if an I/O error happens during a quad lookup
/// ///

Loading…
Cancel
Save