(#21) Add a note about coroutine cancellation.

Signed-off-by: Dan O'Reilly <oreilldf@gmail.com>
dano · Dec 7, 2020 · e7fdf6f · e7fdf6f
1 parent d5e1f28
commit e7fdf6f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -124,3 +124,12 @@ What versions of Python are compatible?
 ---------------------------------------
 
 `aioprocessing` will work out of the box on Python 3.5+.
+
+Gotchas
+-------
+Keep in mind that, while the API exposes coroutines for interacting with
+`multiprocessing` APIs, internally they are almost always being delegated
+to a `ThreadPoolExecutor`, this means the caveats that apply with using
+`ThreadPoolExecutor` with `asyncio` apply: namely, you won't be able to
+cancel any of the coroutines, because the work being done in the worker
+thread can't be interrupted.
diff --git a/aioprocessing/__init__.py b/aioprocessing/__init__.py
@@ -27,8 +27,8 @@
 # is zero for an official release, positive for a development branch,
 # or negative for a release candidate or beta (after the base version
 # number has been incremented)
-version = "1.1.0"
-version_info = (1, 1, 0, 1)
+version = "1.1.1"
+version_info = (1, 1, 1, 0)
 
 if hasattr(multiprocessing, "get_context"):