Merge pull request #244 from vemonet/fix-tests

Fix tests and make them more reliable

Author: nicholascar

.github/workflows/test.yml

@@ -1,5 +1,4 @@
 name: Test
-
 on:
   push:
     branches: ["master"]
@@ -13,32 +12,25 @@ jobs:
         fail-fast: false
         max-parallel: 1
         matrix:
-            python-version: ["3.7", "3.8", "3.9", "3.10"]
+            python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         pip install -U pip
         pip install '.[dev]'
+
     - name: Mypy
-      run: |
-        mypy --show-error-context --show-error-codes
+      run: mypy --show-error-context
+
     - name: Test [wrapper]
       if: ${{ always() }}
-      run: |
-        python -m unittest test/test_wrapper.py -v
+      run: pytest test/test_wrapper.py
+
     - name: Test [all]
-      run: |
-        python -m unittest -v |& tee log.txt
-        grep '^FAIL:' log.txt > fails.txt
-        # if all failures is not raised in `test.test_wrapper`:
-        if [ "$(grep 'test.test_wrapper' fails.txt | wc -l)" -ne "$(wc -l < fails.txt)" ]; then
-          exit 1
-        else
-          echo 'All of the above failures are maybe false errors.'
-          echo 'See: https://github.com/RDFLib/sparqlwrapper/issues/192'
-        fi
+      run: pytest

.gitignore

@@ -11,3 +11,4 @@ doc
 .settings/
 .venv/
 .tox/
+.coverage

README.rst

@@ -18,8 +18,8 @@ About
 
 **SPARQLWrapper** is a simple Python wrapper around a `SPARQL <https://www.w3.org/TR/sparql11-overview/>`_ service to
 remotely execute your queries. It helps by creating the query
-invocation and, optionally, converting the result into a more manageable
-format.
+invocation and, optionally, converting the result into more manageable
+formats.
 
 Installation & Distribution
 ===========================
@@ -35,13 +35,13 @@ You can install SPARQLWrapper from GitHub::
 You can install SPARQLWrapper from Debian::
 
    $ sudo apt-get install python-sparqlwrapper
-   
+
 .. note::
 
    Be aware that there could be a gap between the latest version of SPARQLWrapper
    and the version available as Debian package.
 
-Also, the source code of the package can be downloaded 
+Also, the source code of the package can be downloaded
 in ``.zip`` and ``.tar.gz`` formats from `GitHub SPARQLWrapper releases <https://github.com/RDFLib/sparqlwrapper/releases>`_.
 Documentation is included in the distribution.
 
@@ -125,9 +125,9 @@ This query gets a boolean response from DBPedia's SPARQL endpoint:
 
    sparql = SPARQLWrapper("http://dbpedia.org/sparql")
    sparql.setQuery("""
-       ASK WHERE { 
+       ASK WHERE {
            <http://dbpedia.org/resource/Asturias> rdfs:label "Asturias"@es
-       }    
+       }
    """)
    sparql.setReturnFormat(XML)
    results = sparql.query().convert()
@@ -307,7 +307,7 @@ Return formats
 
 The expected return formats differs per query type (``SELECT``, ``ASK``, ``CONSTRUCT``, ``DESCRIBE``...).
 
-.. note:: From the `SPARQL specification <https://www.w3.org/TR/sparql11-protocol/#query-success>`_, 
+.. note:: From the `SPARQL specification <https://www.w3.org/TR/sparql11-protocol/#query-success>`_,
   *The response body of a successful query operation with a 2XX response is either:*
 
   * ``SELECT`` and ``ASK``: a SPARQL Results Document in XML, JSON, or CSV/TSV format.
@@ -430,12 +430,12 @@ in the return value). This features becomes particularly useful when the ``OPTIO
 GET or POST
 ^^^^^^^^^^^
 
-By default, all SPARQL services are invoked using HTTP **GET** verb. However, 
+By default, all SPARQL services are invoked using HTTP **GET** verb. However,
 **POST** might be useful if the size of the query
 extends a reasonable size; this can be set in the query instance.
 
 Note that some combinations may not work yet with all SPARQL processors
-(e.g., there are implementations where **POST + JSON return** does not work). 
+(e.g., there are implementations where **POST + JSON return** does not work).
 Hopefully, this problem will eventually disappear.
 
 
@@ -914,8 +914,7 @@ Organizations involved:
 * `Salzburg Research <http://www.salzburgresearch.at>`_
 * `Foundation CTIC <http://www.fundacionctic.org/>`_
 
-
-.. |Build Status| image:: https://secure.travis-ci.org/RDFLib/sparqlwrapper.svg?branch=master
-   :target: https://travis-ci.org/RDFLib/sparqlwrapper
+.. |Build Status| image:: https://github.com/RDFLib/sparqlwrapper/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/RDFLib/sparqlwrapper/actions/workflows/test.yml
 .. |PyPi version| image:: https://badge.fury.io/py/SPARQLWrapper.svg
    :target: https://pypi.python.org/pypi/SPARQLWrapper

SPARQLWrapper/Wrapper.py

@@ -39,7 +39,7 @@
 from SPARQLWrapper import __agent__
 
 if TYPE_CHECKING:
-    from rdflib import Graph
+    from rdflib import Dataset, Graph
 
 
 
@@ -649,7 +649,7 @@ def setUseKeepAlive(self) -> None:
         :raises ImportError: when could not be imported ``keepalive.HTTPHandler``.
         """
         try:
-            from keepalive import HTTPHandler  # type: ignore[import]
+            from keepalive import HTTPHandler  # type: ignore[import-not-found]
 
             if urllib.request._opener and any(  # type: ignore[attr-defined]
                 isinstance(h, HTTPHandler) for h in urllib.request._opener.handlers  # type: ignore[attr-defined]
@@ -1071,21 +1071,21 @@ def _convertXML(self) -> Document:
         :return: converted result.
         :rtype: :class:`xml.dom.minidom.Document`
         """
-        doc = parse(self.response)
+        doc: Any = parse(self.response)
         rdoc = cast(Document, doc)
         return rdoc
 
-    def _convertRDF(self) -> "Graph":
+    def _convertRDF(self) -> "Dataset":
         """
         Convert a RDF/XML result into an RDFLib Graph. This method can be overwritten
         in a subclass for a different conversion method.
 
         :return: converted result.
         :rtype: :class:`rdflib.graph.Graph`
         """
-        from rdflib import ConjunctiveGraph
-        retval = ConjunctiveGraph()
-        retval.parse(self.response, format="xml")  # type: ignore[no-untyped-call]
+        from rdflib import Dataset
+        retval = Dataset()
+        retval.parse(self.response, format="xml")
         return retval
 
     def _convertN3(self) -> bytes:
@@ -1118,18 +1118,18 @@ def _convertTSV(self) -> bytes:
         """
         return self.response.read()
 
-    def _convertJSONLD(self) -> "Graph":
+    def _convertJSONLD(self) -> "Dataset":
         """
         Convert a RDF JSON-LD result into an RDFLib Graph. This method can be overwritten
         in a subclass for a different conversion method.
 
         :return: converted result
         :rtype: :class:`rdflib.graph.Graph`
         """
-        from rdflib import ConjunctiveGraph
+        from rdflib import Dataset
 
-        retval = ConjunctiveGraph()
-        retval.parse(self.response, format="json-ld")  # type: ignore[no-untyped-call]
+        retval = Dataset()
+        retval.parse(self.response, format="json-ld")
         return retval
 
     def convert(self) -> ConvertResult:

SPARQLWrapper/main.py

@@ -145,7 +145,7 @@ def main(test: Optional[List[str]] = None) -> None:
     elif isinstance(results, bytes):
         # "csv", "tsv", "turtle", "n3"
         print(results.decode("utf-8"))
-    elif isinstance(results, rdflib.graph.ConjunctiveGraph):
+    elif isinstance(results, rdflib.graph.Dataset):
         # "rdf"
         print(results.serialize())
     else:

SPARQLWrapper/sparql_dataframe.py

@@ -2,7 +2,7 @@
 Query a SPARQL endpoint and return results as a Pandas dataframe.
 """
 import io
-from typing import TYPE_CHECKING, Any, Dict, List, Union
+from typing import TYPE_CHECKING, Dict, List, Union
 
 from SPARQLWrapper.SmartWrapper import Bindings, SPARQLWrapper2, Value
 from SPARQLWrapper.Wrapper import CSV, SELECT, SPARQLWrapper
@@ -39,8 +39,6 @@ def get_sparql_typed_dict(
     endpoint: str, query: Union[str, bytes]
 ) -> List[Dict[str, Value]]:
     """modified from: https://github.com/lawlesst/sparql-dataframe"""
-    # pandas inside to avoid requiring it
-    import pandas as pd
     # rdflib in here because there is some meta stuff in the setup.py and Travis fails because rdflib is installed later
     import rdflib.term
     sparql = SPARQLWrapper2(endpoint)
@@ -58,7 +56,7 @@ def get_sparql_typed_dict(
         row = {}
         for k in x:
             v = x[k]
-            vv = rdflib.term.Literal(v.value, datatype=v.datatype).toPython()  # type: ignore[no-untyped-call]
+            vv = rdflib.term.Literal(v.value, datatype=v.datatype).toPython()
             row[k] = vv
         d.append(row)
     return d

pyproject.toml

@@ -1,3 +1,25 @@
 [build-system]
 requires = ["wheel", "setuptools"]
 build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+addopts = [
+    "--cov=SPARQLWrapper",
+    "--cov-report=term-missing",
+    "--durations=3", # Show slowest tests durations
+]
+
+[tool.mypy]
+files = ["SPARQLWrapper"]
+exclude = ["test"]
+python_version = "3.7"
+show_error_codes = true
+strict = true
+pretty = true
+warn_unused_configs = true
+warn_unused_ignores = true
+warn_unreachable = true
+
+# [[tool.mypy.overrides]]
+# module = "tests.*"
+# disallow_untyped_defs = false

setup.cfg

@@ -49,6 +49,8 @@ dev =
     mypy>=0.931
     pandas>=1.3.5
     pandas-stubs>=1.2.0.48
+    pytest>=8.3.5
+    pytest-cov>=5.0.0
 
 pandas =
     pandas>=1.3.5
@@ -61,13 +63,3 @@ docs =
 [options.entry_points]
 console_scripts =
     rqw = SPARQLWrapper.main:main
-
-[mypy]
-files = SPARQLWrapper
-python_version = 3.7
-show_error_codes = True
-strict = True
-pretty = True
-warn_unused_configs = True
-warn_unused_ignores = True
-warn_unreachable = True

test/test.rq

@@ -5,5 +5,5 @@ WHERE {
   ?pl
     a dbo:ProgrammingLanguage;
     rdfs:label ?pllabel.
-  FILTER(SUBSTR(STR(?pllabel), 1, 1) = "P")
+  FILTER(SUBSTR(STR(?pllabel), 1, 5) = "PARLO")
 } ORDER BY ?pllabel LIMIT 1