chore: add mypy to the build

bringhurst · bringhurst · commit 02484bc907c6 · 2023-01-26T21:54:01.000-08:00
diff --git a/.github/workflows/testing.yml b/.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]
diff --git a/kazoo/client.py b/kazoo/client.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo Zookeeper Client"""
 from collections import defaultdict, deque
 from functools import partial
diff --git a/kazoo/exceptions.py b/kazoo/exceptions.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo Exceptions"""
 from collections import defaultdict
 
diff --git a/kazoo/handlers/eventlet.py b/kazoo/handlers/eventlet.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """A eventlet based handler."""
 from __future__ import absolute_import
 
diff --git a/kazoo/handlers/gevent.py b/kazoo/handlers/gevent.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """A gevent based handler."""
 from __future__ import absolute_import
 
diff --git a/kazoo/handlers/threading.py b/kazoo/handlers/threading.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """A threading based handler.
 
 The :class:`SequentialThreadingHandler` is intended for regular Python
diff --git a/kazoo/handlers/utils.py b/kazoo/handlers/utils.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo handler helpers"""
 
 from collections import defaultdict
diff --git a/kazoo/hosts.py b/kazoo/hosts.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import urllib.parse
 
 
diff --git a/kazoo/interfaces.py b/kazoo/interfaces.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo Interfaces
 
 .. versionchanged:: 1.4
diff --git a/kazoo/protocol/connection.py b/kazoo/protocol/connection.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Protocol Connection Handler"""
 from binascii import hexlify
 from contextlib import contextmanager
diff --git a/kazoo/protocol/paths.py b/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("/")
diff --git a/kazoo/protocol/serialization.py b/kazoo/protocol/serialization.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Serializers, Deserializers, and NamedTuple objects"""
 from collections import namedtuple
 import struct
diff --git a/kazoo/protocol/states.py b/kazoo/protocol/states.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo State and Event objects"""
 from collections import namedtuple
 
diff --git a/kazoo/recipe/barrier.py b/kazoo/recipe/barrier.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Barriers
 
 :Maintainer: None
diff --git a/kazoo/recipe/cache.py b/kazoo/recipe/cache.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """TreeCache
 
 :Maintainer: Jiangge Zhang <tonyseek@gmail.com>
diff --git a/kazoo/recipe/counter.py b/kazoo/recipe/counter.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Counter
 
 :Maintainer: None
diff --git a/kazoo/recipe/election.py b/kazoo/recipe/election.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """ZooKeeper Leader Elections
 
 :Maintainer: None
diff --git a/kazoo/recipe/lease.py b/kazoo/recipe/lease.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper lease implementations
 
 :Maintainer: Lars Albertsson <lars.albertsson@gmail.com>
diff --git a/kazoo/recipe/lock.py b/kazoo/recipe/lock.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Locking Implementations
 
 :Maintainer: Ben Bangert <ben@groovie.org>
diff --git a/kazoo/recipe/partitioner.py b/kazoo/recipe/partitioner.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper Partitioner Implementation
 
 :Maintainer: None
diff --git a/kazoo/recipe/party.py b/kazoo/recipe/party.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Party
 
 :Maintainer: Ben Bangert <ben@groovie.org>
diff --git a/kazoo/recipe/queue.py b/kazoo/recipe/queue.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Zookeeper based queue implementations.
 
 :Maintainer: None
diff --git a/kazoo/recipe/watchers.py b/kazoo/recipe/watchers.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Higher level child and data watching API's.
 
 :Maintainer: Ben Bangert <ben@groovie.org>
diff --git a/kazoo/retry.py b/kazoo/retry.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import logging
 import random
 import time
diff --git a/kazoo/security.py b/kazoo/security.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo Security"""
 from base64 import b64encode
 from collections import namedtuple
diff --git a/kazoo/testing/common.py b/kazoo/testing/common.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 #
 #  Copyright (C) 2010-2011, 2011 Canonical Ltd. All Rights Reserved
 #
diff --git a/kazoo/testing/harness.py b/kazoo/testing/harness.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 """Kazoo testing harnesses"""
 import atexit
 import logging
diff --git a/kazoo/tests/conftest.py b/kazoo/tests/conftest.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import logging
 
 log = logging.getLogger(__name__)
diff --git a/kazoo/tests/test__connection.py b/kazoo/tests/test__connection.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 from collections import namedtuple, deque
 import os
 import threading
diff --git a/kazoo/tests/test_barrier.py b/kazoo/tests/test_barrier.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import threading
 
 from kazoo.testing import KazooTestCase
diff --git a/kazoo/tests/test_build.py b/kazoo/tests/test_build.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import os
 
 import pytest
diff --git a/kazoo/tests/test_cache.py b/kazoo/tests/test_cache.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import gc
 import importlib
 import uuid
diff --git a/kazoo/tests/test_client.py b/kazoo/tests/test_client.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import socket
 import sys
 import threading
diff --git a/kazoo/tests/test_counter.py b/kazoo/tests/test_counter.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 
 import pytest
diff --git a/kazoo/tests/test_election.py b/kazoo/tests/test_election.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 import sys
 import threading
diff --git a/kazoo/tests/test_eventlet_handler.py b/kazoo/tests/test_eventlet_handler.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import contextlib
 import unittest
 
diff --git a/kazoo/tests/test_exceptions.py b/kazoo/tests/test_exceptions.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 from unittest import TestCase
 
 import pytest
diff --git a/kazoo/tests/test_gevent_handler.py b/kazoo/tests/test_gevent_handler.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import unittest
 
 import pytest
diff --git a/kazoo/tests/test_hosts.py b/kazoo/tests/test_hosts.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 from unittest import TestCase
 
 from kazoo.hosts import collect_hosts
diff --git a/kazoo/tests/test_interrupt.py b/kazoo/tests/test_interrupt.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import os
 from sys import platform
 
diff --git a/kazoo/tests/test_lease.py b/kazoo/tests/test_lease.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import datetime
 import uuid
 
diff --git a/kazoo/tests/test_lock.py b/kazoo/tests/test_lock.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import collections
 import mock
 import threading
diff --git a/kazoo/tests/test_partitioner.py b/kazoo/tests/test_partitioner.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 import threading
 import time
diff --git a/kazoo/tests/test_party.py b/kazoo/tests/test_party.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 
 from kazoo.testing import KazooTestCase
diff --git a/kazoo/tests/test_paths.py b/kazoo/tests/test_paths.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import sys
 from unittest import TestCase
 
diff --git a/kazoo/tests/test_queue.py b/kazoo/tests/test_queue.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import uuid
 
 import pytest
diff --git a/kazoo/tests/test_retry.py b/kazoo/tests/test_retry.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import unittest
 
 import pytest
diff --git a/kazoo/tests/test_sasl.py b/kazoo/tests/test_sasl.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import os
 import subprocess
 import time
diff --git a/kazoo/tests/test_security.py b/kazoo/tests/test_security.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import unittest
 
 from kazoo.security import Permissions
diff --git a/kazoo/tests/test_selectors_select.py b/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.
diff --git a/kazoo/tests/test_threading_handler.py b/kazoo/tests/test_threading_handler.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import threading
 import unittest
 
diff --git a/kazoo/tests/test_utils.py b/kazoo/tests/test_utils.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import unittest
 
 from mock import patch
diff --git a/kazoo/tests/test_watchers.py b/kazoo/tests/test_watchers.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 import time
 import threading
 import uuid
diff --git a/kazoo/tests/util.py b/kazoo/tests/util.py
@@ -1,3 +1,5 @@
+# mypy: ignore-errors
+
 ##############################################################################
 #
 # Copyright Zope Foundation and Contributors.
diff --git a/mypy.ini b/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
diff --git a/setup.cfg b/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
 
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`"""Kazoo Zookeeper Client"""`
`2`	`4`	`from collections import defaultdict, deque`
`3`	`5`	`from functools import partial`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`"""Kazoo Exceptions"""`
`2`	`4`	`from collections import defaultdict`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`"""A eventlet based handler."""`
`2`	`4`	`from __future__ import absolute_import`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`"""A gevent based handler."""`
`2`	`4`	`from __future__ import absolute_import`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`"""A threading based handler.`
`2`	`4`
`3`	`5`	The :class:`SequentialThreadingHandler` is intended for regular Python
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`"""Kazoo handler helpers"""`
`2`	`4`
`3`	`5`	`from collections import defaultdict`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`import urllib.parse`
`2`	`4`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`"""Kazoo Interfaces`
`2`	`4`
`3`	`5`	`.. versionchanged:: 1.4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# mypy: ignore-errors`
	`2`	`+`
`1`	`3`	`"""Zookeeper Protocol Connection Handler"""`
`2`	`4`	`from binascii import hexlify`
`3`	`5`	`from contextlib import contextmanager`