Initial mypy setup (#560)

Author: Dreamsorcerer

.github/workflows/ci.yml

@@ -114,7 +114,7 @@ jobs:
       env:
         COLOR: 'yes'
       run: |
-        pytest tests
+        pytest tests --cov-report xml --cov-report html
         python -m coverage xml
     - name: Run functional tests
       run: bash examples/run_all.sh

.mypy.ini

@@ -0,0 +1,30 @@
+[mypy]
+files = aiocache, examples, tests
+#check_untyped_defs = True
+follow_imports_for_stubs = True
+#disallow_any_decorated = True
+disallow_any_generics = True
+disallow_incomplete_defs = True
+disallow_subclassing_any = True
+#disallow_untyped_calls = True
+disallow_untyped_decorators = True
+#disallow_untyped_defs = True
+implicit_reexport = False
+no_implicit_optional = True
+show_error_codes = True
+strict_equality = True
+warn_incomplete_stub = True
+warn_redundant_casts = True
+warn_unreachable = True
+warn_unused_ignores = True
+disallow_any_unimported = True
+#warn_return_any = True
+
+[mypy-tests.*]
+disallow_any_decorated = False
+disallow_untyped_calls = False
+disallow_untyped_defs = False
+
+
+[mypy-msgpack.*]
+ignore_missing_imports = True

aiocache/__init__.py

@@ -1,11 +1,13 @@
 import logging
+from typing import Dict, Type
 
 from ._version import __version__
 from .backends.memory import SimpleMemoryCache
+from .base import BaseCache
 
 logger = logging.getLogger(__name__)
 
-AIOCACHE_CACHES = {SimpleMemoryCache.NAME: SimpleMemoryCache}
+AIOCACHE_CACHES: Dict[str, Type[BaseCache]] = {SimpleMemoryCache.NAME: SimpleMemoryCache}
 
 try:
     import aioredis

aiocache/backends/memory.py

@@ -1,4 +1,5 @@
 import asyncio
+from typing import Dict
 
 from aiocache.base import BaseCache
 from aiocache.serializers import NullSerializer
@@ -9,8 +10,8 @@ class SimpleMemoryBackend:
     Wrapper around dict operations to use it as a cache backend
     """
 
-    _cache = {}
-    _handlers = {}
+    _cache: Dict[str, object] = {}
+    _handlers: Dict[str, asyncio.TimerHandle] = {}
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)

aiocache/backends/redis.py

@@ -46,8 +46,6 @@ class RedisBackend:
         " end"
     )
 
-    pools = {}
-
     def __init__(
         self,
         endpoint="127.0.0.1",

aiocache/base.py

@@ -3,6 +3,7 @@
 import logging
 import os
 import time
+from typing import Callable, Set
 
 from aiocache import serializers
 
@@ -14,7 +15,7 @@
 
 class API:
 
-    CMDS = set()
+    CMDS: Set[Callable[..., object]] = set()
 
     @classmethod
     def register(cls, func):
@@ -103,6 +104,8 @@ class BaseCache:
         the backend. It can be overriden in the specific calls.
     """
 
+    NAME: str
+
     def __init__(
         self, serializer=None, plugins=None, namespace=None, key_builder=None, timeout=5, ttl=None
     ):

aiocache/factory.py

@@ -2,6 +2,7 @@
 import urllib
 import warnings
 from copy import deepcopy
+from typing import Dict
 
 from aiocache import AIOCACHE_CACHES
 from aiocache.base import BaseCache
@@ -126,7 +127,7 @@ def from_url(cls, url):
 
 class CacheHandler:
 
-    _config = {
+    _config: Dict[str, Dict[str, object]] = {
         "default": {
             "cache": "aiocache.SimpleMemoryCache",
             "serializer": {"class": "aiocache.serializers.StringSerializer"},
@@ -136,7 +137,7 @@ class CacheHandler:
     def __init__(self):
         self._caches = {}
 
-    def add(self, alias: str, config: dict) -> None:
+    def add(self, alias: str, config: Dict[str, object]) -> None:
         """
         Add a cache to the current config. If the key already exists, it
         will overwrite it::
@@ -153,7 +154,7 @@ def add(self, alias: str, config: dict) -> None:
         """
         self._config[alias] = config
 
-    def get(self, alias: str):
+    def get(self, alias: str) -> object:
         """
         Retrieve cache identified by alias. Will return always the same instance
 

aiocache/lock.py

@@ -1,6 +1,6 @@
 import asyncio
 import uuid
-from typing import Any, Union
+from typing import Any, Dict, Union
 
 from aiocache.base import BaseCache
 
@@ -60,7 +60,7 @@ class RedLock:
     result of ``super_expensive_function``.
     """
 
-    _EVENTS = {}
+    _EVENTS: Dict[str, asyncio.Event] = {}
 
     def __init__(self, client: BaseCache, key: str, lease: Union[int, float]):
         self.client = client
@@ -149,7 +149,7 @@ async def _acquire(self):
     async def __aexit__(self, exc_type, exc_value, traceback):
         pass
 
-    async def cas(self, value: Any, **kwargs) -> bool:
+    async def cas(self, value: Any, **kwargs: Any) -> bool:
         """
         Checks and sets the specified value for the locked key. If the value has changed
         since the lock was created, it will raise an :class:`aiocache.lock.OptimisticLockError`

aiocache/py.typed

@@ -1,13 +1,14 @@
 import logging
 import pickle  # noqa: S403
+from typing import Any, Optional
 
 logger = logging.getLogger(__name__)
 
 try:
     import ujson as json
 except ImportError:
     logger.debug("ujson module not found, using json")
-    import json
+    import json  # type: ignore[no-redef]
 
 try:
     import msgpack
@@ -21,16 +22,18 @@
 
 class BaseSerializer:
 
-    DEFAULT_ENCODING = "utf-8"
+    DEFAULT_ENCODING: Optional[str] = "utf-8"
 
     def __init__(self, *args, encoding=_NOT_SET, **kwargs):
         self.encoding = self.DEFAULT_ENCODING if encoding is _NOT_SET else encoding
         super().__init__(*args, **kwargs)
 
-    def dumps(self, value):
+    # TODO(PY38): Positional-only
+    def dumps(self, value: Any) -> str:
         raise NotImplementedError("dumps method must be implemented")
 
-    def loads(self, value):
+    # TODO(PY38): Positional-only
+    def loads(self, value: str) -> Any:
         raise NotImplementedError("loads method must be implemented")