Add type hints

BoboTiG · BoboTiG · commit 7cb58e9f4442 · 2016-10-12T17:39:30.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -16,9 +16,12 @@ before_install:
   - xpra --xvfb="Xorg +extension RANDR -config `pwd`/tests/dummy.xorg.conf -logfile ${HOME}/.xpra/xorg.log" start :42
 
 install:
+  - pip install mypy
   - python setup.py install
 
-script: py.test --display=":42.0"
+script:
+  - py.test --display=":42.0"
+  - mypy --check-untyped-defs --warn-incomplete-stub -m mss
 
 after_script:
   - xpra stop :42
diff --git a/CHANGELOG b/CHANGELOG
@@ -4,6 +4,7 @@ History:
 
 dev
       - change license to MIT
+      - add type hints
       - add documentation (fix #10)
       - add tests and use Travis CI (fix #9)
       - Linux: remove MSS library
diff --git a/mss/base.pyi b/mss/base.pyi
@@ -0,0 +1,16 @@
+from typing import Callable, Iterator
+
+
+class MSSBase(object):
+    monitors = []  # type: list
+    image = None  # type: bytes
+    width = 0  # type: int
+    height = 0  # type: int
+
+    def __enter__(self) -> object: ...
+    def __exit__(self, exc_type, exc_value, traceback) -> None: ...
+    def bgra_to_rgb(self, raw: bytearray) -> bytes: ...
+    def enum_display_monitors(self, force: bool=False) -> list: ...
+    def get_pixels(self, monitor: dict) -> bytes: ...
+    def save(self, mon: int=0, output: str='monitor-%d.png', callback: Callable[[str], None]=None) -> Iterator[str]: ...
+    def to_png(self, data: bytes, output: str) -> None: ...
diff --git a/mss/darwin.pyi b/mss/darwin.pyi
@@ -0,0 +1,11 @@
+from typing import Any
+from .base import MSSBase
+
+
+def cgfloat() -> Any: ...
+def get_infinity(maxi: bool=False) -> float: ...
+
+
+class MSS(MSSBase):
+    def _set_argtypes(self) -> None: ...
+    def _set_restypes(self) -> None: ...
diff --git a/mss/factory.pyi b/mss/factory.pyi
@@ -0,0 +1,4 @@
+from typing import Any
+
+
+def mss(*args: Any, **kwargs: Any) -> object: ...
diff --git a/mss/linux.pyi b/mss/linux.pyi
@@ -0,0 +1,11 @@
+from .base import MSSBase
+
+
+class MSS(MSSBase):
+    def __del__(self) -> None: ...
+    def __init__(self, display: str=None) -> None: ...
+    def _set_argtypes(self) -> None: ...
+    def _set_restypes(self) -> None: ...
+
+
+def arch() -> int: ...
diff --git a/mss/windows.pyi b/mss/windows.pyi
@@ -0,0 +1,6 @@
+from typing import Callable
+from .base import MSSBase
+
+
+def set_argtypes(callback: Callable) -> None: ...
+def set_restypes() -> None: ...

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +from typing import Any
++
++
 +def mss(*args: Any, **kwargs: Any) -> object: ...