# aioshutil: Asynchronous shutil module.
[](https://pepy.tech/project/aioshutil)   
# Introduction
`aioshutil` is a Python library which provides asynchronous version of function of shutil module. `shutil` module is blocking and using it in asyncio applications will block the event loop and slow down the application, `aioshutil` provides asynchronous friendly versions of the functions of the `shutil` module as it performs blocking io in a thread pool.
# Installation
```console
$ pip install aioshutil
```
# Usage
The API of `aioshutil` module is same as `shutil` module except that it is asynchronous.
```python
from aioshutil import rmtree
await rmtree("/tmp")
```
`aioshutil` provides the following functions:
- `copyfileobj`
- `copyfile`
- `copymode`
- `copystat`
- `copy`
- `copy2`
- `copytree`
- `move`
- `rmtree`
- `make_archive`
- `get_archive_formats`
- `register_archive_format`
- `unregister_archive_format`
- `get_unpack_formats`
- `register_unpack_format`
- `unregister_unpack_format`
- `unpack_archive`
- `ignore_patterns`
- `chown`
- `which`
- `get_terminal_size`
`aioshutil` provides the following exceptions for consistency with `shutil` module:
- `Error`
- `SpecialFileError`
- `ExecError`
- `SameFileError`
Raw data
{
"_id": null,
"home_page": "https://github.com/kumaraditya303/aioshutil",
"name": "aioshutil",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "asyncio,io,shutil",
"author": "Kumar Aditya",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/49/b8/c1d4588d5c20a3e1d0f85f2cc0ad5d864c3a4d17d2120049e4a345cd07df/aioshutil-1.3.tar.gz",
"platform": null,
"description": "# aioshutil: Asynchronous shutil module.\n\n[](https://pepy.tech/project/aioshutil)   \n\n# Introduction\n\n`aioshutil` is a Python library which provides asynchronous version of function of shutil module. `shutil` module is blocking and using it in asyncio applications will block the event loop and slow down the application, `aioshutil` provides asynchronous friendly versions of the functions of the `shutil` module as it performs blocking io in a thread pool.\n\n# Installation\n\n```console\n$ pip install aioshutil\n```\n\n# Usage\n\nThe API of `aioshutil` module is same as `shutil` module except that it is asynchronous.\n\n```python\nfrom aioshutil import rmtree\nawait rmtree(\"/tmp\")\n```\n\n`aioshutil` provides the following functions:\n\n- `copyfileobj`\n- `copyfile`\n- `copymode`\n- `copystat`\n- `copy`\n- `copy2`\n- `copytree`\n- `move`\n- `rmtree`\n- `make_archive`\n- `get_archive_formats`\n- `register_archive_format`\n- `unregister_archive_format`\n- `get_unpack_formats`\n- `register_unpack_format`\n- `unregister_unpack_format`\n- `unpack_archive`\n- `ignore_patterns`\n- `chown`\n- `which`\n- `get_terminal_size`\n\n`aioshutil` provides the following exceptions for consistency with `shutil` module:\n\n- `Error`\n- `SpecialFileError`\n- `ExecError`\n- `SameFileError`\n\n\n",
"bugtrack_url": null,
"license": "BSD License",
"summary": "Asynchronous shutil module.",
"version": "1.3",
"project_urls": {
"Homepage": "https://github.com/kumaraditya303/aioshutil"
},
"split_keywords": [
"asyncio",
"io",
"shutil"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b8d22dbf3d70c2094b0b6a97ee33af2922fe5d5e3ccc9c4cf88f8e11bff840d",
"md5": "aaaed8c89c384c2399360948b88d9aa8",
"sha256": "a441c99ef5f9b77fdd429ea7d043b8a358aa9b0c87043868113f9790c9aea400"
},
"downloads": -1,
"filename": "aioshutil-1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aaaed8c89c384c2399360948b88d9aa8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4637,
"upload_time": "2023-03-14T14:01:44",
"upload_time_iso_8601": "2023-03-14T14:01:44.138317Z",
"url": "https://files.pythonhosted.org/packages/7b/8d/22dbf3d70c2094b0b6a97ee33af2922fe5d5e3ccc9c4cf88f8e11bff840d/aioshutil-1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49b8c1d4588d5c20a3e1d0f85f2cc0ad5d864c3a4d17d2120049e4a345cd07df",
"md5": "10a6743713e73abd46f06ef9a841f10e",
"sha256": "ddabe1748c8a71ec3c7d213a4d0cf58fb495c71419334a0575b1f8a3be8373e8"
},
"downloads": -1,
"filename": "aioshutil-1.3.tar.gz",
"has_sig": false,
"md5_digest": "10a6743713e73abd46f06ef9a841f10e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7851,
"upload_time": "2023-03-14T14:01:45",
"upload_time_iso_8601": "2023-03-14T14:01:45.704292Z",
"url": "https://files.pythonhosted.org/packages/49/b8/c1d4588d5c20a3e1d0f85f2cc0ad5d864c3a4d17d2120049e4a345cd07df/aioshutil-1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-14 14:01:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kumaraditya303",
"github_project": "aioshutil",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pre-commit",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-asyncio",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
}
],
"lcname": "aioshutil"
}
JSON
