chore: add mypy to the build

Author: bringhurst

.github/workflows/testing.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Code check
         run: tox -e ${TOX_VENV}
         env:
-          TOX_VENV: black,pep8
+          TOX_VENV: black,pep8,mypy
 
   test:
     needs: [validate]

kazoo/client.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo Zookeeper Client"""
 from collections import defaultdict, deque
 from functools import partial

kazoo/exceptions.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo Exceptions"""
 from collections import defaultdict
 

kazoo/handlers/eventlet.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """A eventlet based handler."""
 from __future__ import absolute_import
 

kazoo/handlers/gevent.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """A gevent based handler."""
 from __future__ import absolute_import
 

kazoo/handlers/threading.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """A threading based handler.
 
 The :class:`SequentialThreadingHandler` is intended for regular Python

kazoo/handlers/utils.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo handler helpers"""
 
 from collections import defaultdict

kazoo/hosts.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import urllib.parse
 
 

kazoo/interfaces.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo Interfaces
 
 .. versionchanged:: 1.4

kazoo/protocol/connection.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Protocol Connection Handler"""
 from binascii import hexlify
 from contextlib import contextmanager

kazoo/protocol/paths.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 def normpath(path, trailing=False):
     """Normalize path, eliminating double slashes, etc."""
     comps = path.split("/")

kazoo/protocol/serialization.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Serializers, Deserializers, and NamedTuple objects"""
 from collections import namedtuple
 import struct

kazoo/protocol/states.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo State and Event objects"""
 from collections import namedtuple
 

kazoo/recipe/barrier.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Barriers
 
 :Maintainer: None

kazoo/recipe/cache.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """TreeCache
 
 :Maintainer: Jiangge Zhang <[email protected]>

kazoo/recipe/counter.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Counter
 
 :Maintainer: None

kazoo/recipe/election.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """ZooKeeper Leader Elections
 
 :Maintainer: None

kazoo/recipe/lease.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper lease implementations
 
 :Maintainer: Lars Albertsson <[email protected]>

kazoo/recipe/lock.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Locking Implementations
 
 :Maintainer: Ben Bangert <[email protected]>

kazoo/recipe/partitioner.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Partitioner Implementation
 
 :Maintainer: None

kazoo/recipe/party.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Party
 
 :Maintainer: Ben Bangert <[email protected]>

kazoo/recipe/queue.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper based queue implementations.
 
 :Maintainer: None

kazoo/recipe/watchers.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Higher level child and data watching API's.
 
 :Maintainer: Ben Bangert <[email protected]>

kazoo/retry.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import logging
 import random
 import time

kazoo/security.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo Security"""
 from base64 import b64encode
 from collections import namedtuple

kazoo/testing/common.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 #
 #  Copyright (C) 2010-2011, 2011 Canonical Ltd. All Rights Reserved
 #

kazoo/testing/harness.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo testing harnesses"""
 import atexit
 import logging

kazoo/tests/conftest.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import logging
 
 log = logging.getLogger(__name__)

kazoo/tests/test__connection.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 from collections import namedtuple, deque
 import os
 import threading

kazoo/tests/test_barrier.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import threading
 
 from kazoo.testing import KazooTestCase

kazoo/tests/test_build.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import os
 
 import pytest

kazoo/tests/test_cache.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import gc
 import importlib
 import uuid

kazoo/tests/test_client.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import socket
 import sys
 import threading

kazoo/tests/test_counter.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 
 import pytest

kazoo/tests/test_election.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 import sys
 import threading

kazoo/tests/test_eventlet_handler.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import contextlib
 import unittest
 

kazoo/tests/test_exceptions.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 from unittest import TestCase
 
 import pytest

kazoo/tests/test_gevent_handler.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import unittest
 
 import pytest

kazoo/tests/test_hosts.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 from unittest import TestCase
 
 from kazoo.hosts import collect_hosts

kazoo/tests/test_interrupt.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import os
 from sys import platform
 

kazoo/tests/test_lease.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import datetime
 import uuid
 

kazoo/tests/test_lock.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import collections
 import mock
 import threading

kazoo/tests/test_partitioner.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 import threading
 import time

kazoo/tests/test_party.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 
 from kazoo.testing import KazooTestCase

kazoo/tests/test_paths.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import sys
 from unittest import TestCase
 

kazoo/tests/test_queue.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 
 import pytest

kazoo/tests/test_retry.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import unittest
 
 import pytest

kazoo/tests/test_sasl.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import os
 import subprocess
 import time

kazoo/tests/test_security.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import unittest
 
 from kazoo.security import Permissions

kazoo/tests/test_selectors_select.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """
 The official python select function test case copied from python source
  to test the selector_select function.

kazoo/tests/test_threading_handler.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import threading
 import unittest
 

kazoo/tests/test_utils.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import unittest
 
 from mock import patch

kazoo/tests/test_watchers.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import time
 import threading
 import uuid

kazoo/tests/util.py

@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 ##############################################################################
 #
 # Copyright Zope Foundation and Contributors.

mypy.ini

@@ -0,0 +1,46 @@
+[mypy]
+
+# TODO: For details on each flag, please see the mypy documentation at:
+# https://mypy.readthedocs.io/en/stable/config_file.html#config-file
+
+# Import Discovery
+ignore_missing_imports = false
+
+# Disallow dynamic typing
+disallow_any_generics = true
+disallow_subclassing_any = true
+
+# Untyped definitions and calls
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+
+# None and Optional handling
+implicit_optional = false
+strict_optional = true
+
+# Configuring warnings
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_return_any = true
+warn_unreachable = true
+
+# Miscellaneous strictness flags
+implicit_reexport = false
+strict_equality = true
+
+# Configuring error messages
+show_error_context = true
+show_column_numbers = true
+show_error_codes = true
+pretty = true
+color_output = true
+show_absolute_path = true
+
+# Miscellaneous
+allow_untyped_globals = false
+warn_unused_configs = true
+verbosity = 0

setup.cfg

@@ -73,11 +73,14 @@ sasl =
 docs =
     Sphinx>=1.2.2
 
+typing =
+    mypy>=0.991
+
 alldeps =
     %(dev)s
     %(eventlet)s
     %(gevent)s
     %(sasl)s
     %(docs)s
-
+    %(typing)s