Home       Trees       Indices       Help   
SPARQLWrapper 1.8.4
Package SPARQLWrapper :: Module Wrapper :: Class QueryResult
[hide private]
[frames] | no frames]

Class QueryResult

source code

object --+
         |
        QueryResult

Wrapper around an a query result. Users should not create instances of this class, it is generated by a SPARQLWrapper.query call. The results can be converted to various formats, or used directly.

If used directly: the class gives access to the direct http request results self.response: it is a file-like object with two additional methods: geturl() to return the URL of the resource retrieved and info() that returns the meta-information of the HTTP result as a dictionary-like object (see the urllib2 standard library module of Python).

For convenience, these methods are also available on the instance. The __iter__ and next methods are also implemented (by mapping them to self.response). This means that the common idiom:

for l in obj : do_something_with_line(l)

would work, too.

Instance Methods [hide private]
 
__init__(self, result)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
string
geturl(self)
Return the URL of the original call.		 source code
dict
info(self)
Return the meta-information of the HTTP result.		 source code
 
__iter__(self)
Return an iterator object.		 source code
 
next(self)
Method for the standard iterator.		 source code
dict
_convertJSON(self)
Convert a JSON result into a Python dict.		 source code
PyXlib DOM node
_convertXML(self)
Convert an XML result into a Python dom tree.		 source code
RDFLib Graph
_convertRDF(self)
Convert a RDF/XML result into an RDFLib triple store.		 source code
string
_convertN3(self)
Convert a RDF Turtle/N3 result into a string.		 source code
string
_convertCSV(self)
Convert a CSV result into a string.		 source code
string
_convertTSV(self)
Convert a TSV result into a string.		 source code
RDFLib Graph
_convertJSONLD(self)
Convert a RDF JSON-LD result into an RDFLib triple store.		 source code
 
convert(self)
Encode the return value depending on the return format:		 source code
string
_get_responseFormat(self)
Get the response (return) format.		 source code
 
print_results(self, minWidth=None)
This method prints a representation of a QueryResult object that MUST has as response format JSON.		 source code
 
__get_results_width(self, results, minWidth=2) source code
 
__get_prettyprint_string_sparql_var_result(self, result) source code
string
__str__(self)
This method returns the string representation of a QueryResult object.		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Instance Variables [hide private]
string requestedFormat
The requested format.
  response
the direct HTTP response; a file-like object, as return by the urllib2.urlopen library call.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, result)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • result - HTTP response stemming from a SPARQLWrapper.query call, or a tuple with the expected format: (response,format)
Overrides: object.__init__

geturl(self)

source code 

Return the URL of the original call.

Returns: string
URL of the original call

info(self)

source code 

Return the meta-information of the HTTP result.

Returns: dict
meta information of the HTTP result

__iter__(self)

source code 

Return an iterator object. This method is expected for the inclusion of the object in a standard for loop.

_convertJSON(self)

source code 

Convert a JSON result into a Python dict. This method can be overwritten in a subclass for a different conversion method.

Returns: dict
converted result

_convertXML(self)

source code 

Convert an XML result into a Python dom tree. This method can be overwritten in a subclass for a different conversion method.

Returns: PyXlib DOM node
converted result

_convertRDF(self)

source code 

Convert a RDF/XML result into an RDFLib triple store. This method can be overwritten in a subclass for a different conversion method.

Returns: RDFLib Graph
converted result

_convertN3(self)

source code 

Convert a RDF Turtle/N3 result into a string. This method can be overwritten in a subclass for a different conversion method.

Returns: string
converted result

_convertCSV(self)

source code 

Convert a CSV result into a string. This method can be overwritten in a subclass for a different conversion method.

Returns: string
converted result

_convertTSV(self)

source code 

Convert a TSV result into a string. This method can be overwritten in a subclass for a different conversion method.

Returns: string
converted result

_convertJSONLD(self)

source code 

Convert a RDF JSON-LD result into an RDFLib triple store. This method can be overwritten in a subclass for a different conversion method.

Returns: RDFLib Graph
converted result

convert(self)

source code 

Encode the return value depending on the return format:

  • in the case of XML, a DOM top element is returned;
  • in the case of JSON, a simplejson conversion will return a dictionary;
  • in the case of RDF/XML, the value is converted via RDFLib into a Graph instance;
  • in the case of JSON-LD, the value is converted via RDFLib into a Graph instance;
  • in the case of RDF Turtle/N3, a string is returned;
  • in the case of CSV/TSV, a string is returned.

In all other cases the input simply returned.

Returns:
the converted query result. See the conversion methods for more details.

_get_responseFormat(self)

source code 

Get the response (return) format. The possible values are: JSON, XML, RDFXML, TURTLE, N3, CSV, TSV, JSONLD. In case there is no Content-Type, None is return. In all other cases, the raw Content-Type is return.

Returns: string
the response format. The possible values are: JSON, XML, RDFXML, TURTLE, N3, CSV, TSV, JSONLD.

Since: 1.8.3

print_results(self, minWidth=None)

source code 

This method prints a representation of a QueryResult object that MUST has as response format JSON.

Parameters:
  • minWidth (string) - The minimun width, counting as characters. The default value is None.

__str__(self)
(Informal representation operator)

source code 

This method returns the string representation of a QueryResult object.

Returns: string
A human-readable string of the object.
Overrides: object.__str__

Since: 1.8.3


Instance Variable Details [hide private]

requestedFormat

The requested format. The possible values are: JSON, XML, RDFXML, TURTLE, N3, RDF, CSV, TSV, JSONLD.
Type:
string

   Home       Trees       Indices       Help   
SPARQLWrapper 1.8.4
Generated by Epydoc 3.0.1 on Thu Apr 18 09:55:02 2019 http://epydoc.sourceforge.net