Implement PEP518 support, mass fix of type hints + add stubs

.editorconfig

@@ -9,7 +9,7 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.{py,ini}]
-max_line_length = 79
+max_line_length = 120
 
 [*.{yml,rst}]
 indent_size = 2

.pylintrc

@@ -273,7 +273,7 @@ logging-modules=logging
 [FORMAT]
 
 # Maximum number of characters on a single line.
-max-line-length=80
+max-line-length=120
 
 # Regexp for a line that is allowed to be longer than the limit.
 ignore-long-lines=^\s*(# )?<?https?://\S+>?$

doc/source/asynciotask.rst

@@ -54,4 +54,4 @@ API: Decorators: `AsyncIOTask`, `asynciotask`.
     :type loop_getter: typing.Union[typing.Callable[..., asyncio.AbstractEventLoop], asyncio.AbstractEventLoop]
     :param loop_getter_need_context: Loop getter requires function context
     :type loop_getter_need_context: bool
-    :rtype: AsyncIOTask
+    :rtype: typing.Union[AsyncIOTask, asyncio.Task]

doc/source/gthreadpooled.rst

@@ -54,4 +54,4 @@ API: Decorators: `GThreadPooled`, `gthreadpooled`.
 
     :param func: function to wrap
     :type func: typing.Optional[typing.Callable]
-    :rtype: GThreadPooled
+    :rtype: typing.Union[GThreadPooled, gevent.event.AsyncResult]

doc/source/threaded.rst

@@ -15,7 +15,7 @@ API: Decorators: `Threaded` class and `threaded` function.
         :param name: New thread name.
                      If callable: use as wrapped function.
                      If none: use wrapped function name.
-        :type name: typing.Union[None, str, typing.Callable[.., typing.Union[typing.Any, typing.Awaitable]]]
+        :type name: typing.Optional[typing.Union[str, typing.Callable[.., typing.Union[typing.Any, typing.Awaitable]]]]
         :param daemon: Daemonize thread.
         :type daemon: bool
         :param started: Return started thread
@@ -28,7 +28,13 @@ API: Decorators: `Threaded` class and `threaded` function.
         ``typing.Optional[str]`` - New thread name. If none: use wrapped function name.
 
     .. py:attribute:: started
+
+        ``bool``
+
     .. py:attribute:: daemon
+
+        ``bool``
+
     .. py:attribute:: _func
 
         Wrapped function. Used for inheritance only.
@@ -47,9 +53,9 @@ API: Decorators: `Threaded` class and `threaded` function.
     :param name: New thread name.
                  If callable: use as wrapped function.
                  If none: use wrapped function name.
-    :type name: typing.Union[None, str, typing.Callable[.., typing.Union[typing.Any, typing.Awaitable]]]
+    :type name: typing.Optional[typing.Union[str, typing.Callable[.., typing.Union[typing.Any, typing.Awaitable]]]]
     :param daemon: Daemonize thread.
     :type daemon: bool
     :param started: Return started thread
     :type started: bool
-    :rtype: Threaded
+    :rtype: typing.Union[Threaded, threading.Thread]

doc/source/threadpooled.rst

@@ -46,6 +46,8 @@ API: Decorators: `ThreadPooled`, `threadpooled`.
 
         ``ThreadPoolExecutor`` instance. Class-wide.
 
+        :rtype: ThreadPoolExecutor
+
     .. py:attribute:: _func
 
         ``typing.Optional[typing.Callable[..., typing.Union[typing.Any, typing.Awaitable]]]``
@@ -84,7 +86,7 @@ API: Decorators: `ThreadPooled`, `threadpooled`.
     :type loop_getter: typing.Union[None, typing.Callable[..., asyncio.AbstractEventLoop], asyncio.AbstractEventLoop]
     :param loop_getter_need_context: Loop getter requires function context
     :type loop_getter_need_context: bool
-    :rtype: ThreadPooled
+    :rtype: typing.Union[ThreadPooled, concurrent.futures.Future, asyncio.Task]
 
 Not exported, but public accessed data type:
 

pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+# Minimum requirements for the build system to execute.
+# PEP 508 specifications for PEP 518.
+requires = [
+    "setuptools > 20.2 ",
+    "wheel",
+]

setup.py

@@ -20,6 +20,7 @@
 import collections
 from distutils.command import build_ext
 import distutils.errors
+import glob
 import os.path
 import shutil
 import sys
@@ -32,7 +33,7 @@
 
 import setuptools
 
-PY3 = sys.version_info[:2] > (2, 7)
+PY3 = sys.version_info[:2] > (2, 7)  # type: bool
 
 with open(
     os.path.join(
@@ -258,6 +259,12 @@ def get_simple_vars_from_src(src):
         ],
     },
     install_requires=required,
+    package_data={
+        'threaded': [
+            os.path.basename(filename)
+            for filename in glob.glob(os.path.join('threaded', '*.pyi'))
+        ],
+    },
 )
 if PY3 and cythonize is not None:
     setup_args['ext_modules'] = ext_modules

threaded/__init__.py

@@ -18,7 +18,7 @@
 
 import sys
 
-PY3 = sys.version_info[:2] > (3, 0)
+PY3 = sys.version_info[:2] > (3, 0)  # type: bool
 
 # pylint: disable=no-name-in-module
 if PY3:  # pragma: no cover

threaded/_base_gthreadpooled.py

@@ -16,6 +16,8 @@
 
 from __future__ import absolute_import
 
+import typing  # noqa  # pylint: disable=unused-import
+
 import gevent.threadpool
 import six
 
@@ -31,15 +33,15 @@ class BaseGThreadPooled(_base_threaded.APIPooled):
 
     __slots__ = ()
 
-    __executor = None
+    __executor = None  # type: typing.Optional[gevent.threadpool.ThreadPool]
 
     # pylint: disable=arguments-differ
     @classmethod
     def configure(
         cls,
-        max_workers=None,
-        hub=None
-    ):
+        max_workers=None,  # type: typing.Optional[int]
+        hub=None  # type: typing.Optional[gevent.hub.Hub]
+    ):  # type: (...) -> None
         """Pool executor create and configure.
 
         :param max_workers: Maximum workers
@@ -67,7 +69,7 @@ def configure(
     # pylint: enable=arguments-differ
 
     @classmethod
-    def shutdown(cls):
+    def shutdown(cls):  # type: () -> None
         """Shutdown executor.
 
         Due to not implemented method, set maxsize to 0 (do not accept new).
@@ -76,7 +78,7 @@ def shutdown(cls):
             cls.__executor.kill()
 
     @property
-    def executor(self):
+    def executor(self):  # type: () -> gevent.threadpool.ThreadPool
         """Executor instance.
 
         :rtype: gevent.threadpool.ThreadPool
@@ -85,7 +87,10 @@ def executor(self):
             self.configure()
         return self.__executor
 
-    def _get_function_wrapper(self, func):
+    def _get_function_wrapper(
+        self,
+        func  # type: typing.Callable
+    ):  # type: (...) -> typing.Callable[..., gevent.event.AsyncResult]
         """Here should be constructed and returned real decorator.
 
         :param func: Wrapped function
@@ -96,7 +101,10 @@ def _get_function_wrapper(self, func):
         # pylint: disable=missing-docstring
         # noinspection PyMissingOrEmptyDocstring
         @six.wraps(func)
-        def wrapper(*args, **kwargs):
+        def wrapper(
+            *args,
+            **kwargs
+        ):  # type: (...) -> gevent.event.AsyncResult
             return self.executor.spawn(func, *args, **kwargs)
         # pylint: enable=missing-docstring
         return wrapper

threaded/_base_gthreadpooled.pyi

@@ -0,0 +1,17 @@
+import gevent.threadpool
+import typing
+from . import _base_threaded
+
+class BaseGThreadPooled(_base_threaded.APIPooled):
+    @classmethod
+    def configure(
+        cls,
+        max_workers: typing.Optional[int]=...,
+        hub: typing.Optional[gevent.hub.Hub]=...
+    ) -> None: ...
+
+    @classmethod
+    def shutdown(cls) -> None: ...
+
+    @property
+    def executor(self) -> gevent.threadpool.ThreadPool: ...