| Name | anyioutils JSON |
| Version |
0.4.9
JSON |
| download |
| home_page | None |
| Summary | Utility classes and functions for AnyIO |
| upload_time | 2024-11-27 09:42:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Copyright (c) 2024 David Brochart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
asyncio
trio
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# anyioutils
Utility classes and functions for AnyIO.
## Task
`task = anyioutils.create_task(my_async_func(), task_group)` behaves the same as `task = asyncio.create_task(my_async_func())` except that an existing `task_group` has to be passed for the task to be launched in the background.
You can also use `task = anyioutils.Task(my_async_func())` and then launch the `task` with `task_group.start_soon(task.wait)`, and/or await it with `result = await task.wait()`.
```py
from anyioutils import CancelledError, Task, create_task
from anyio import create_task_group, run, sleep
async def foo():
return 1
async def bar():
await sleep(float("inf"))
async def main():
async with create_task_group() as tg:
task = Task(foo())
assert await task.wait() == 1
try:
async with create_task_group() as tg:
task = create_task(bar(), tg)
await sleep(0.1)
task.cancel()
except BaseExceptionGroup as exc_group:
assert len(exc_group.exceptions) == 1
assert type(exc_group.exceptions[0]) == CancelledError
run(main)
```
## Future
`anyioutils.Future` behaves the same as `asyncio.Future` except that:
- you cannot directly await an `anyioutils.Future` object, but through its `.wait()` method (unlike an `asyncio.Future`, but like an `asyncio.Event`),
- cancelling an `anyioutils.Future` doesn't raise an `anyio.get_cancelled_exc_class()`, but an `anyioutils.CancelledError`.
```py
from anyioutils import CancelledError, Future
from anyio import create_task_group, run
async def set_result(future):
future.set_result("done")
async def cancel(future):
future.cancel()
async def main():
async with create_task_group() as tg:
future0 = Future()
tg.start_soon(set_result, future0)
assert await future0.wait() == "done"
future1 = Future()
tg.start_soon(cancel, future1)
try:
await future1.wait()
except CancelledError:
assert future1.cancelled()
run(main)
```
## wait
`anyioutils.wait(aws, task_group)` behaves the same as `asyncio.wait(aws)` except that an existing `task_group` has to be passed.
```py
from anyioutils import ALL_COMPLETED, Task, wait
from anyio import create_task_group, run
async def foo():
return "foo"
async def main():
async with create_task_group() as tg:
tasks = [Task(aw) for aw in (foo(), foo())]
done, pending = await wait(tasks, tg, return_when=ALL_COMPLETED)
assert done == set(tasks)
assert not pending
for task in done:
assert task.result() == "foo"
run(main)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "anyioutils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "asyncio, trio",
"author": null,
"author_email": "David Brochart <david.brochart@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e4/33/eda515da647cdd4d43287871ea38254baff3e867d2c381fe52e0353af165/anyioutils-0.4.9.tar.gz",
"platform": null,
"description": "# anyioutils\n\nUtility classes and functions for AnyIO.\n\n## Task\n\n`task = anyioutils.create_task(my_async_func(), task_group)` behaves the same as `task = asyncio.create_task(my_async_func())` except that an existing `task_group` has to be passed for the task to be launched in the background.\n\nYou can also use `task = anyioutils.Task(my_async_func())` and then launch the `task` with `task_group.start_soon(task.wait)`, and/or await it with `result = await task.wait()`.\n\n```py\nfrom anyioutils import CancelledError, Task, create_task\nfrom anyio import create_task_group, run, sleep\n\nasync def foo():\n return 1\n\nasync def bar():\n await sleep(float(\"inf\"))\n\nasync def main():\n async with create_task_group() as tg:\n task = Task(foo())\n assert await task.wait() == 1\n\n try:\n async with create_task_group() as tg:\n task = create_task(bar(), tg)\n await sleep(0.1)\n task.cancel()\n except BaseExceptionGroup as exc_group:\n assert len(exc_group.exceptions) == 1\n assert type(exc_group.exceptions[0]) == CancelledError\n\nrun(main)\n```\n\n## Future\n\n`anyioutils.Future` behaves the same as `asyncio.Future` except that:\n- you cannot directly await an `anyioutils.Future` object, but through its `.wait()` method (unlike an `asyncio.Future`, but like an `asyncio.Event`),\n- cancelling an `anyioutils.Future` doesn't raise an `anyio.get_cancelled_exc_class()`, but an `anyioutils.CancelledError`.\n\n```py\nfrom anyioutils import CancelledError, Future\nfrom anyio import create_task_group, run\n\nasync def set_result(future):\n future.set_result(\"done\")\n\nasync def cancel(future):\n future.cancel()\n\nasync def main():\n async with create_task_group() as tg:\n future0 = Future()\n tg.start_soon(set_result, future0)\n assert await future0.wait() == \"done\"\n\n future1 = Future()\n tg.start_soon(cancel, future1)\n try:\n await future1.wait()\n except CancelledError:\n assert future1.cancelled()\n\nrun(main)\n```\n\n## wait\n\n`anyioutils.wait(aws, task_group)` behaves the same as `asyncio.wait(aws)` except that an existing `task_group` has to be passed.\n\n```py\nfrom anyioutils import ALL_COMPLETED, Task, wait\nfrom anyio import create_task_group, run\n\nasync def foo():\n return \"foo\"\n\nasync def main():\n async with create_task_group() as tg:\n tasks = [Task(aw) for aw in (foo(), foo())]\n done, pending = await wait(tasks, tg, return_when=ALL_COMPLETED)\n assert done == set(tasks)\n assert not pending\n for task in done:\n assert task.result() == \"foo\"\n\nrun(main)\n```\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024 David Brochart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Utility classes and functions for AnyIO",
"version": "0.4.9",
"project_urls": {
"Repository": "https://github.com/davidbrochart/anyioutils.git"
},
"split_keywords": [
"asyncio",
" trio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21d0bbcf4ece1bdc48feade3dc187f3c27af12e24645002edb92dd30a05f1023",
"md5": "02b573bd07a8ecefe465efff938bbad3",
"sha256": "8117a12effd6b43604f0e26ee92b37c0bb9eab23f16125bcc62919b98d6facea"
},
"downloads": -1,
"filename": "anyioutils-0.4.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "02b573bd07a8ecefe465efff938bbad3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6924,
"upload_time": "2024-11-27T09:42:07",
"upload_time_iso_8601": "2024-11-27T09:42:07.776859Z",
"url": "https://files.pythonhosted.org/packages/21/d0/bbcf4ece1bdc48feade3dc187f3c27af12e24645002edb92dd30a05f1023/anyioutils-0.4.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e433eda515da647cdd4d43287871ea38254baff3e867d2c381fe52e0353af165",
"md5": "684a3cf936055804e20ed50e01b25dd7",
"sha256": "2acc14d81f94c0cdc526d37425dee38ebc0197dd99745f9d359a01dc42a174c4"
},
"downloads": -1,
"filename": "anyioutils-0.4.9.tar.gz",
"has_sig": false,
"md5_digest": "684a3cf936055804e20ed50e01b25dd7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6412,
"upload_time": "2024-11-27T09:42:09",
"upload_time_iso_8601": "2024-11-27T09:42:09.030763Z",
"url": "https://files.pythonhosted.org/packages/e4/33/eda515da647cdd4d43287871ea38254baff3e867d2c381fe52e0353af165/anyioutils-0.4.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 09:42:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davidbrochart",
"github_project": "anyioutils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "anyioutils"
}
