Prepare release 3.10.0 (#60)

* added test for non-coroutine async

* a.sync leaves ()->await T unchanged

* docs dependency cleanup

* docs typo fix

* version bump

Author: maxfischer2781

asyncstdlib/__init__.py

@@ -35,7 +35,7 @@
 )
 from .asynctools import borrow, scoped_iter, await_each, apply, sync
 
-__version__ = "3.9.2"
+__version__ = "3.10.0"
 
 __all__ = [
     "anext",

asyncstdlib/asynctools.py

@@ -326,7 +326,17 @@ async def compute_something_else() -> float:
     )
 
 
+@overload
+def sync(function: Callable[..., Awaitable[T]]) -> Callable[..., Awaitable[T]]:
+    ...
+
+
+@overload
 def sync(function: Callable[..., T]) -> Callable[..., Awaitable[T]]:
+    ...
+
+
+def sync(function: Callable) -> Callable[..., Awaitable[T]]:
     r"""
     Wraps a callable to ensure its result can be ``await``\ ed
 
@@ -359,12 +369,13 @@ async def main():
         raise TypeError("function argument should be Callable")
 
     if iscoroutinefunction(function):
-        return function  # type: ignore
+        return function
 
     @wraps(function)
     async def async_wrapped(*args, **kwargs):
         result = function(*args, **kwargs)
-
+        if isinstance(result, Awaitable):
+            return await result
         return result
 
     return async_wrapped

docs/conf.py

@@ -49,7 +49,6 @@
     'sphinx.ext.imgmath',
     'sphinx.ext.viewcode',
     'sphinxcontrib_trio',
-    'sphinxcontrib.contentui',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/api/asynctools.rst

@@ -23,8 +23,7 @@ Iterator lifetime
 Async transforming
 ==================
 
-.. autofunction:: sync(function:(...) -> T) -> (...) -> await T
-    :async:
+.. autofunction:: sync(function: (...) -> (await) T) -> (...) -> await T
 
     .. versionadded:: 3.9.3
 

docs/source/api/itertools.rst

@@ -61,7 +61,7 @@ Iterator splitting
     :for: :(async iter T, ...)
 
 .. autofunction:: pairwise(iterable: (async) iter T)
-    :for: :(T, T)
+    :async-for: :(T, T)
 
     .. versionadded:: 3.10.0
 

pyproject.toml

@@ -29,7 +29,7 @@ test = [
     "pytest-cov",
     "mypy; implementation_name=='cpython'",
 ]
-doc = ["sphinx", "sphinxcontrib-contentui", "sphinxcontrib-trio"]
+doc = ["sphinx", "sphinxcontrib-trio"]
 
 [tool.flit.metadata.urls]
 Documentation = "https://asyncstdlib.readthedocs.io/en/latest/"

unittests/test_asynctools.py

@@ -221,3 +221,17 @@ async def check_4(x: int, y: int, z: int) -> int:
     assert t1 == 110
     assert t2 == 120
     assert t3 == 125
+
+
+@sync
+async def test_sync_awaitable():
+    """Test any (…) -> await T is recognised"""
+
+    @a.sync
+    def nocoro_async(value):
+        async def coro():
+            return value
+
+        return coro()
+
+    assert await nocoro_async(5) == 5