# 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": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "asyncio, io, shutil",
"author": "Kumar Aditya",
"author_email": "kumaraditya@python.org",
"download_url": "https://files.pythonhosted.org/packages/75/e4/ef86f1777a9bc0c51d50487b471644ae20941afe503591d3a4c86e456dac/aioshutil-1.5.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.5",
"project_urls": {
"Homepage": "https://github.com/kumaraditya303/aioshutil"
},
"split_keywords": [
"asyncio",
" io",
" shutil"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "183deb3c7106c4672c19280515b759b674daafd2d570c952e5491faeca157ffd",
"md5": "f5b09eb08af808fcb78cf7df2442332c",
"sha256": "bc2a6cdcf1a8615b62f856154fd81131031d03f2834912ebb06d8a2391253652"
},
"downloads": -1,
"filename": "aioshutil-1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5b09eb08af808fcb78cf7df2442332c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4657,
"upload_time": "2024-07-20T07:02:40",
"upload_time_iso_8601": "2024-07-20T07:02:40.028810Z",
"url": "https://files.pythonhosted.org/packages/18/3d/eb3c7106c4672c19280515b759b674daafd2d570c952e5491faeca157ffd/aioshutil-1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "75e4ef86f1777a9bc0c51d50487b471644ae20941afe503591d3a4c86e456dac",
"md5": "cd468cff0293c84e1cf48faceb3884f5",
"sha256": "2756d6cd3bb03405dc7348ac11a0b60eb949ebd63cdd15f56e922410231c1201"
},
"downloads": -1,
"filename": "aioshutil-1.5.tar.gz",
"has_sig": false,
"md5_digest": "cd468cff0293c84e1cf48faceb3884f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7770,
"upload_time": "2024-07-20T07:02:41",
"upload_time_iso_8601": "2024-07-20T07:02:41.364722Z",
"url": "https://files.pythonhosted.org/packages/75/e4/ef86f1777a9bc0c51d50487b471644ae20941afe503591d3a4c86e456dac/aioshutil-1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-20 07:02:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kumaraditya303",
"github_project": "aioshutil",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "aioshutil"
}
JSON
