Merge pull request #1407 from iafork/iwana-20210910T2303

Fix mypy type errors and add mypy to .drone.yml

Author: Nicholas Car

.dockerignore

@@ -0,0 +1,4 @@
+.tox
+.venv
+.mypy_cache
+.git

.drone.yml

@@ -26,8 +26,9 @@ steps:
   - pip install --default-timeout 60 -r requirements.dev.txt
   - pip install --default-timeout 60 coveralls && export HAS_COVERALLS=1
   - python setup.py install
-  - black --config black.toml --check ./rdflib | true
+  - black --config black.toml --check ./rdflib || true
   - flake8 --exit-zero rdflib
+  - mypy --show-error-context --show-error-codes rdflib
   - PYTHONWARNINGS=default nosetests --with-timer --timer-top-n 42 --with-coverage --cover-tests --cover-package=rdflib
   - coverage report --skip-covered
   - coveralls

.flake8

@@ -0,0 +1,6 @@
+# https://flake8.pycqa.org/en/latest/user/configuration.html
+[flake8]
+extend-ignore =
+    # E501: line too long
+    # Disabled so that black can control line length.
+    E501,

Makefile

@@ -2,6 +2,7 @@ tests:
 	docker-compose -f docker-compose.tests.yml up test-runner
 	docker-compose -f docker-compose.tests.yml down
 
+.PHONY: build
 build:
 	docker-compose -f docker-compose.tests.yml build
 
@@ -14,3 +15,6 @@ reformat:
 
 check-format:
 	black --config ./black.toml --check .
+
+check-types:
+	docker-compose -f docker-compose.tests.yml up check-types

docker-compose.tests.yml

@@ -13,4 +13,12 @@ services:
       dockerfile: test/Dockerfile
     volumes:
       - .:/rdflib
-    command: ["/rdflib/run_tests_with_coverage_report.sh"]
+    command: ["/rdflib/run_tests_with_coverage_report.sh"]
+
+  check-types:
+    build:
+      context: .
+      dockerfile: test/Dockerfile
+    volumes:
+      - .:/rdflib
+    command: ["python", "-m", "mypy", "--show-error-context", "--show-error-codes" ,"/rdflib/rdflib"]

docs/developers.rst

@@ -15,6 +15,9 @@ Code should be formatted using `black <https://github.com/psf/black>`_.
 While not yet mandatory, it will be required in the future  (6.0.0+).1
 Use Black v21.6b1, with the black.toml config file provided.
 
+Code should also pass `flake8 <https://github.com/psf/black>`_ linting
+and `mypy <http://mypy-lang.org/>`_ type checking.
+
 Any new functionality being added to RDFLib should have doc tests and
 unit tests. Tests should be added for any functionality being changed
 that currently does not have any doc tests or unit tests. And all the
@@ -28,7 +31,7 @@ Running tests
 -------------
 Run tests with `nose <https://nose.readthedocs.org/en/latest/>`_:
 
-.. code-block: bash
+.. code-block:: bash
 
    $ pip install nose
    $ python run_tests.py
@@ -42,10 +45,31 @@ Specific tests can either be run by module name or file name. For example::
   $ python run_tests.py --tests rdflib.graph
   $ python run_tests.py --tests test/test_graph.py
 
+Running static checks
+---------------------
+
+Check formatting with `black <https://github.com/psf/black>`_:
+
+.. code-block:: bash
+
+    python -m black --config black.toml --check ./rdflib
+
+Check style and conventions with `flake8 <https://github.com/psf/black>`_:
+
+.. code-block:: bash
+
+    python -m flake8 rdflib
+
+Check types with `mypy <http://mypy-lang.org/>`_:
+
+.. code-block:: bash
+
+    python -m mypy --show-error-context --show-error-codes rdflib
+
 Writing documentation
 ---------------------
 
-We use sphinx for generating HTML docs, see :ref:`docs`
+We use sphinx for generating HTML docs, see :ref:`docs`.
 
 Continuous Integration
 ----------------------

rdflib/compare.py

@@ -454,15 +454,15 @@ def _traces(
             experimental = self._experimental_path(coloring_copy)
             experimental_score = set([c.key() for c in experimental])
             if last_coloring:
-                generator = self._create_generator(
+                generator = self._create_generator(  # type: ignore[unreachable]
                     [last_coloring, experimental], generator
                 )
             last_coloring = experimental
-            if best_score is None or best_score < color_score:
+            if best_score is None or best_score < color_score:  # type: ignore[unreachable]
                 best = [refined_coloring]
                 best_score = color_score
                 best_experimental_score = experimental_score
-            elif best_score > color_score:
+            elif best_score > color_score:  # type: ignore[unreachable]
                 # prune this branch.
                 if stats is not None:
                     stats["prunings"] += 1
@@ -480,7 +480,7 @@ def _traces(
                 d = [depth[0]]
                 new_color = self._traces(coloring, stats=stats, depth=d)
                 color_score = tuple([c.key() for c in refined_coloring])
-                if best_score is None or color_score > best_score:
+                if best_score is None or color_score > best_score:  # type: ignore[unreachable]
                     discrete = [new_color]
                     best_score = color_score
                     best_depth = d[0]

rdflib/extras/infixowl.py

@@ -331,9 +331,6 @@ def castToQName(x):
             if isinstance(thing, BNode):
                 return thing.n3()
             return "<" + thing + ">"
-            logger.debug(list(store.objects(subject=thing, predicate=RDF.type)))
-            raise
-            return "[]"  # +thing._id.encode('utf-8')+'</em>'
         label = first(Class(thing, graph=store).label)
         if label:
             return label

rdflib/graph.py

@@ -1057,34 +1057,34 @@ def serialize(
     @overload
     def serialize(
         self,
-        destination: Union[str, BufferedIOBase],
+        destination: Union[str, BufferedIOBase, pathlib.PurePath],
         format: str = ...,
         base: Optional[str] = ...,
         encoding: Optional[str] = ...,
         **args,
-    ) -> None:
+    ) -> "Graph":
         ...
 
     # fallback
     @overload
     def serialize(
         self,
-        destination: Union[str, BufferedIOBase, None] = None,
+        destination: Union[str, BufferedIOBase, pathlib.PurePath, None] = None,
         format: str = "turtle",
         base: Optional[str] = None,
         encoding: Optional[str] = None,
         **args,
-    ) -> Optional[Union[bytes, str]]:
+    ) -> Union[bytes, str, "Graph"]:
         ...
 
     def serialize(
         self,
-        destination: Union[str, BufferedIOBase, None] = None,
+        destination: Union[str, BufferedIOBase, pathlib.PurePath, None] = None,
         format: str = "turtle",
         base: Optional[str] = None,
         encoding: Optional[str] = None,
         **args,
-    ) -> Optional[Union[bytes, str]]:
+    ) -> Union[bytes, str, "Graph"]:
         """Serialize the Graph to destination
 
         If destination is None serialize method returns the serialization as
@@ -1123,10 +1123,9 @@ def serialize(
                 location = cast(str, destination)
             scheme, netloc, path, params, _query, fragment = urlparse(location)
             if netloc != "":
-                print(
-                    "WARNING: not saving as location" + "is not a local file reference"
+                raise ValueError(
+                    f"destination {destination} is not a local file reference"
                 )
-                return None
             fd, name = tempfile.mkstemp()
             stream = os.fdopen(fd, "wb")
             serializer.serialize(stream, base=base, encoding=encoding, **args)

rdflib/plugins/parsers/jsonld.py

@@ -35,7 +35,8 @@
 
 import warnings
 from rdflib.graph import ConjunctiveGraph
-from rdflib.parser import Parser, URLInputSource
+from rdflib.parser import URLInputSource
+import rdflib.parser
 from rdflib.namespace import RDF, XSD
 from rdflib.term import URIRef, BNode, Literal
 
@@ -78,12 +79,12 @@
     pass
 
 
-TYPE_TERM = Term(str(RDF.type), TYPE, VOCAB)
+TYPE_TERM = Term(str(RDF.type), TYPE, VOCAB)  # type: ignore[call-arg]
 
 ALLOW_LISTS_OF_LISTS = True  # NOTE: Not allowed in JSON-LD 1.0
 
 
-class JsonLDParser(Parser):
+class JsonLDParser(rdflib.parser.Parser):
     def __init__(self):
         super(JsonLDParser, self).__init__()