Merge pull request #77 from evo-company/fix-py.typed

fix py.typed

hiku/endpoint/graphql.py

@@ -2,6 +2,7 @@
 
 from abc import ABC, abstractmethod
 from asyncio import gather
+from inspect import isawaitable
 
 from ..engine import Engine
 from ..graph import (
@@ -12,6 +13,7 @@
     QueryTransformer,
     Node,
 )
+from ..result import Proxy
 from ..validate.query import validate
 from ..readers.graphql import (
     read_operation,
@@ -130,6 +132,7 @@ def execute(
     ) -> t.Dict:
         stripped_query = _process_query(graph, op.query)
         result = self.engine.execute(graph, stripped_query, ctx)
+        assert isinstance(result, Proxy)
         type_name = _type_names[op.type]
         return DenormalizeGraphQL(graph, result, type_name).process(op.query)
 
@@ -173,8 +176,9 @@ async def execute(
         self, graph: Graph, op: Operation, ctx: t.Optional[t.Dict]
     ) -> t.Dict:
         stripped_query = _process_query(graph, op.query)
-        # TODO: create AsyncEngine class
-        result = await self.engine.execute(graph, stripped_query, ctx)  # type: ignore  # noqa: E501
+        coro = self.engine.execute(graph, stripped_query, ctx)
+        assert isawaitable(coro)
+        result = await coro
         type_name = _type_names[op.type]
         return DenormalizeGraphQL(graph, result, type_name).process(op.query)
 

hiku/engine.py

@@ -16,6 +16,7 @@
     Optional,
     overload,
     DefaultDict,
+    Awaitable,
 )
 from functools import partial
 from itertools import chain, repeat
@@ -26,14 +27,14 @@
     Concatenate,
 )
 
+from .executors.base import SyncAsyncExecutor
 from .query import (
     Node as QueryNode,
     Field as QueryField,
     Link as QueryLink,
     QueryTransformer,
     QueryVisitor
 )
-from .executors.sync import SyncExecutor
 from .graph import (
     Link,
     Maybe,
@@ -627,15 +628,15 @@ def __getitem__(self, item: Any) -> Any:
 
 class Engine:
 
-    def __init__(self, executor: SyncExecutor) -> None:
+    def __init__(self, executor: SyncAsyncExecutor) -> None:
         self.executor = executor
 
     def execute(
         self,
         graph: Graph,
         query: QueryNode,
         ctx: Optional[Dict] = None
-    ) -> Proxy:
+    ) -> Union[Proxy, Awaitable[Proxy]]:
         if ctx is None:
             ctx = {}
         query = InitOptions(graph).visit(query)

hiku/executors/asyncio.py

@@ -18,7 +18,7 @@
     cast,
 )
 
-from hiku.executors.base import BaseExecutor
+from hiku.executors.base import BaseAsyncExecutor
 from hiku.result import Proxy
 
 
@@ -29,7 +29,7 @@
     )
 
 
-class AsyncIOExecutor(BaseExecutor):
+class AsyncIOExecutor(BaseAsyncExecutor):
 
     def __init__(self, loop: Optional[AbstractEventLoop] = None) -> None:
         self._loop = loop or get_event_loop()

hiku/executors/sync.py

@@ -6,7 +6,7 @@
 
 from typing_extensions import ParamSpec
 
-from hiku.executors.base import BaseExecutor
+from hiku.executors.base import BaseSyncExecutor
 from hiku.result import Proxy
 
 if TYPE_CHECKING:
@@ -29,7 +29,7 @@ def result(self) -> T:
         return self._result
 
 
-class SyncExecutor(BaseExecutor):
+class SyncExecutor(BaseSyncExecutor):
 
     def submit(
         self,

hiku/executors/threads.py

@@ -10,7 +10,7 @@
     Any,
 )
 
-from hiku.executors.base import BaseExecutor
+from hiku.executors.base import BaseSyncExecutor
 from hiku.result import Proxy
 
 if TYPE_CHECKING:
@@ -20,7 +20,7 @@
     )
 
 
-class ThreadsExecutor(BaseExecutor):
+class ThreadsExecutor(BaseSyncExecutor):
 
     def __init__(self, pool: Executor):
         self._pool = pool

hiku/federation/endpoint.py

@@ -4,6 +4,7 @@
 )
 from asyncio import gather
 from contextlib import contextmanager
+from inspect import isawaitable
 from typing import (
     List,
     Dict,
@@ -157,6 +158,7 @@ def execute(
     ) -> Dict:
         stripped_query = _process_query(graph, op.query)
         result = self.engine.execute(graph, stripped_query, ctx or {})
+        assert isinstance(result, Proxy)
         return self.postprocess_result(result, graph, op)
 
     def dispatch(self, data: Dict) -> Dict:
@@ -178,7 +180,9 @@ async def execute(
         self, graph: Graph, op: Operation, ctx: Optional[Dict]
     ) -> Dict:
         stripped_query = _process_query(graph, op.query)
-        result = await self.engine.execute_async(graph, stripped_query, ctx)
+        coro = self.engine.execute(graph, stripped_query, ctx)
+        assert isawaitable(coro)
+        result = await coro
         return self.postprocess_result(result, graph, op)
 
     async def dispatch(self, data: Dict) -> Dict:

hiku/federation/engine.py

@@ -1,9 +1,9 @@
-import inspect
 from collections import defaultdict
 from typing import (
     Optional,
     Dict,
-    Any,
+    Awaitable,
+    Union,
 )
 
 from .sdl import print_sdl
@@ -20,15 +20,15 @@
     Index,
     ROOT,
 )
+from ..executors.base import SyncAsyncExecutor
 from ..query import (
     Node,
     Field,
 )
 
 
 class Engine:
-    # TODO: add type for executor
-    def __init__(self, executor: Any):
+    def __init__(self, executor: SyncAsyncExecutor):
         self.executor = executor
 
     def execute_service(self, graph: Graph) -> Proxy:
@@ -42,7 +42,7 @@ def execute_entities(
         graph: Graph,
         query: Node,
         ctx: Dict
-    ) -> Proxy:
+    ) -> Union[Proxy, Awaitable[Proxy]]:
         entities_link = query.fields_map['_entities']
         query = entities_link.node
         representations = entities_link.options['representations']
@@ -74,7 +74,7 @@ def execute_query(
         graph: Graph,
         query: Node,
         ctx: Dict
-    ) -> Proxy:
+    ) -> Union[Proxy, Awaitable[Proxy]]:
         query = InitOptions(graph).visit(query)
         queue = Queue(self.executor)
         task_set = queue.fork(None)
@@ -88,7 +88,7 @@ def execute(
         graph: Graph,
         query: Node,
         ctx: Optional[Dict] = None
-    ) -> Proxy:
+    ) -> Union[Proxy, Awaitable[Proxy]]:
         if ctx is None:
             ctx = {}
 
@@ -98,14 +98,3 @@ def execute(
             return self.execute_entities(graph, query, ctx)
 
         return self.execute_query(graph, query, ctx)
-
-    async def execute_async(
-        self,
-        graph: Graph,
-        query: Node,
-        ctx: Optional[Dict] = None
-    ) -> Proxy:
-        result = self.execute(graph, query, ctx)
-        if inspect.iscoroutine(result):
-            return await result
-        return result

hiku/graph.py

@@ -36,6 +36,10 @@
 )
 from .directives import DirectiveBase
 
+if t.TYPE_CHECKING:
+    from .sources.graph import SubGraph
+    from .sources.graph import BoundExpr
+
 
 Maybe = const('Maybe')
 
@@ -76,7 +80,7 @@ class Option(AbstractOption):
     def __init__(
         self,
         name: str,
-        type_: GenericMeta,
+        type_: t.Optional[GenericMeta],
         *,
         default: t.Any = Nothing,
         description: t.Optional[str] = None
@@ -130,6 +134,8 @@ class AbstractField(AbstractBase, ABC):
     RootFieldFunc,
     NotRootFieldFunc,
     NotRootFieldFuncCtx,
+    'SubGraph',
+    'BoundExpr'
 ]
 
 

lets.yaml

@@ -57,7 +57,7 @@ commands:
   bench:
     description: Run benchmarks
     depends: [_build-tests]
-    cmd: docker-compose run --rm pytest tests/benchmarks $@
+    cmd: docker-compose run --rm pytest tests/benchmarks --benchmark-enable $@
 
   flake:
     description: Run flake8

setup.py

@@ -24,6 +24,7 @@
     author_email='vladimir@magamedov.com',
     url='https://github.com/evo-company/hiku',
     packages=find_packages(exclude=['test*']),
+    package_data={'hiku': ['py.typed']},
     include_package_data=True,
     license='BSD-3-Clause',
     python_requires='>=3.7',

tox.ini

@@ -21,7 +21,7 @@ setenv =
 commands = mypy --config-file {toxinidir}/mypy.ini --show-error-codes {posargs:-p hiku}
 
 [pytest]
-addopts = -q --tb=native
+addopts = -q --tb=native --benchmark-disable
 testpaths = tests
 filterwarnings =
   once::DeprecationWarning