Add checker, improve annotations

Author: asvetlov

.gitignore

@@ -74,3 +74,5 @@ multidict/_istr.html
 
 # test results in junit format for Appveyor
 /junit-test-results.xml
+
+.pytest_cache

multidict/__init__.pyi

@@ -1,9 +1,10 @@
-from typing import Any, Mapping, MutableMapping, List, Union, Iterable
-from typing import KeysView, ValuesView, ItemsView, Iterator, Tuple
-from typing import overload, TypeVar, Generic, Optional
+from typing import (Mapping, MutableMapping, List, Union, Iterable,
+                    Iterator, TypeVar, Generic, Tuple, Dict)
 
 
-class istr(str): ...
+class istr(str):
+    pass
+
 
 upstr = istr
 
@@ -12,87 +13,86 @@ _S = Union[str, istr]
 _T = TypeVar('_T')
 
 
-class MultiMapping(Mapping[_S, _T]):
-    def getall(self, key: _S, default: _T=...) -> List[_T]: ...
-    def getone(self, key: _S, default: _T=...) -> _T: ...
+class MultiMapping(Mapping[_S, _T], Generic[_T]):
+    def getall(self, key: _S, default: _T = ...) -> List[_T]: ...
+
+    def getone(self, key: _S, default: _T = ...) -> _T: ...
+
+
+_Arg = Union[Mapping[_S, _T],
+             Dict[_S, _T],
+             MultiMapping[_T],
+             Iterable[Tuple[_S. _T]]]
 
 
 class MutableMultiMapping(MultiMapping[_T],
-                          MutableMapping[_S, _T]):
+                          MutableMapping[_S, _T],
+                          Generic[_T]):
 
     def add(self, key: _S, value: _T) -> None: ...
 
-    @overload
-    def extend(self, dct: MultiDict[_T]) -> None: ...
-    @overload
-    def extend(self, map: Mapping[_S, _T]) -> None: ...
-    @overload
-    def extend(self, iterable: Iterable[Tuple[_S, _T]]) -> None: ...
+    def extend(self, arg: _Arg = ..., **kwargs: _T) -> None: ...
 
-    @overload
-    def popone(self, key: _S) -> _T: ...
-    @overload
-    def popone(self, key: _S, default: _T=...) -> _T: ...
+    def popone(self, key: _S, default: _T = ...) -> _T: ...
 
-    @overload
-    def popall(self, key: _S) -> List[_T]: ...
-    @overload
-    def popall(self, key: _S, default: _T=...) -> List[_T]: ...
+    def popall(self, key: _S, default: _T = ...) -> List[_T]: ...
 
 
-class MultiDict(MutableMultiMapping[_T]):
-    @overload
-    def __init__(self) -> None: ...
-    @overload
-    def __init__(self, map: Mapping[_S, _T]) -> None: ...
-    @overload
-    def __init__(self, iterable: Iterable[Tuple[_S, _T]]) -> None: ...
+class MultiDict(MutableMultiMapping[_T], Generic[_T]):
+    def __init__(self, arg: _Arg = ..., **kwargs: _T) -> None: ...
 
     def copy(self) -> MultiDict[_T]: ...
 
-
     def __getitem__(self, k: _S) -> _T: ...
+
     def __setitem__(self, k: _S, v: _T) -> None: ...
+
     def __delitem__(self, v: _S) -> None: ...
+
     def __iter__(self) -> Iterator[_S]: ...
+
     def __len__(self) -> int: ...
 
 
-class CIMultiDict(MutableMultiMapping[_T]):
-    @overload
-    def __init__(self) -> None: ...
-    @overload
-    def __init__(self, map: Mapping[_S, _T]) -> None: ...
-    @overload
-    def __init__(self, iterable: Iterable[Tuple[_S, _T]]) -> None: ...
+class CIMultiDict(MutableMultiMapping[_T], Generic[_T]):
+    def __init__(self, arg: _Arg = ..., **kwargs: _T) -> None: ...
 
     def copy(self) -> CIMultiDict[_T]: ...
 
     def __getitem__(self, k: _S) -> _T: ...
+
     def __setitem__(self, k: _S, v: _T) -> None: ...
+
     def __delitem__(self, v: _S) -> None: ...
+
     def __iter__(self) -> Iterator[_S]: ...
+
     def __len__(self) -> int: ...
 
 
-class MultiDictProxy(MultiMapping[_T]):
+class MultiDictProxy(MultiMapping[_T], Generic[_T]):
     def __init__(self, arg: Union[MultiMapping[_T],
                                   MutableMultiMapping[_T]]) -> None: ...
 
     def copy(self) -> MultiDictProxy[_T]: ...
 
     def __getitem__(self, k: _S) -> _T: ...
+
     def __iter__(self) -> Iterator[_S]: ...
+
     def __len__(self) -> int: ...
 
 
-class CIMultiDictProxy(MultiMapping[_T]):
+class CIMultiDictProxy(MultiMapping[_T], Generic[_T]):
     def __init__(self, arg: Union[MultiMapping[_T],
                                   MutableMultiMapping[_T]]) -> None: ...
+
     def copy(self) -> CIMultiDictProxy[_T]: ...
 
     def __getitem__(self, k: _S) -> _T: ...
+
     def __iter__(self) -> Iterator[_S]: ...
+
     def __len__(self) -> int: ...
 
 

requirements/ci.txt

@@ -1,5 +1,6 @@
 -r wheel.txt
 flake8==3.5.0
+flake8-pyi==18.3.1
 pyflakes>=1.0.0
 coverage==4.5.1
 sphinx==1.7.4

tests/test_mypy.py

@@ -2,8 +2,8 @@
 
 
 def test_classes_not_abstract() -> None:
-    d1 = multidict.MultiDict({'a': 'b'})
-    d2 = multidict.CIMultiDict({'a': 'b'})
+    d1 = multidict.MultiDict({'a': 'b'})  # type: multidict.MultiDict[str]
+    d2 = multidict.CIMultiDict({'a': 'b'})  # type: multidict.CIMultiDict[str]
 
     d3 = multidict.MultiDictProxy(d1)
     d4 = multidict.CIMultiDictProxy(d2)