aioshutil

Name	aioshutil JSON
Version	1.6 JSON
	download
home_page	https://github.com/kumaraditya303/aioshutil
Summary	Asynchronous shutil module.
upload_time	2025-10-21 08:42:23
maintainer	None
docs_url	None
author	Kumar Aditya
requires_python	>=3.8
license	BSD License
keywords	asyncio io shutil
VCS
bugtrack_url
requirements	pre-commit pytest pytest-asyncio pytest-cov
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # aioshutil: Asynchronous shutil module.

[![Downloads](https://static.pepy.tech/badge/aioshutil)](https://pepy.tech/project/aioshutil) ![](https://img.shields.io/pypi/v/aioshutil)  ![](https://img.shields.io/pypi/pyversions/aioshutil) ![](https://img.shields.io/pypi/implementation/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`
- `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/d3/bd/dcea5abb1792269e70cc75d5f9ae9adbdfba0f0d08a207eb788ec3b469b6/aioshutil-1.6.tar.gz",
    "platform": null,
    "description": "# aioshutil: Asynchronous shutil module.\n\n[![Downloads](https://static.pepy.tech/badge/aioshutil)](https://pepy.tech/project/aioshutil) ![](https://img.shields.io/pypi/v/aioshutil)  ![](https://img.shields.io/pypi/pyversions/aioshutil) ![](https://img.shields.io/pypi/implementation/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- `SameFileError`\n",
    "bugtrack_url": null,
    "license": "BSD License",
    "summary": "Asynchronous shutil module.",
    "version": "1.6",
    "project_urls": {
        "Homepage": "https://github.com/kumaraditya303/aioshutil"
    },
    "split_keywords": [
        "asyncio",
        " io",
        " shutil"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "68927020e67ad83095ecc2ce751c24a63df332fb9a34ebfe14bc12a6b21b8f58",
                "md5": "1604a506319ea897bf7884bdc2864704",
                "sha256": "e0711de25ade421b70094b2a27c69bef6356127013744fec05f019f36732c1bd"
            },
            "downloads": -1,
            "filename": "aioshutil-1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1604a506319ea897bf7884bdc2864704",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4705,
            "upload_time": "2025-10-21T08:42:22",
            "upload_time_iso_8601": "2025-10-21T08:42:22.892370Z",
            "url": "https://files.pythonhosted.org/packages/68/92/7020e67ad83095ecc2ce751c24a63df332fb9a34ebfe14bc12a6b21b8f58/aioshutil-1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d3bddcea5abb1792269e70cc75d5f9ae9adbdfba0f0d08a207eb788ec3b469b6",
                "md5": "9727baa34d7fbcb27fc4503a728e6406",
                "sha256": "9eae342b9a4cacc2c2c5877877a2d2f7a2b66c62aa1ab57d7e95c8cfd4ede507"
            },
            "downloads": -1,
            "filename": "aioshutil-1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "9727baa34d7fbcb27fc4503a728e6406",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7843,
            "upload_time": "2025-10-21T08:42:23",
            "upload_time_iso_8601": "2025-10-21T08:42:23.742080Z",
            "url": "https://files.pythonhosted.org/packages/d3/bd/dcea5abb1792269e70cc75d5f9ae9adbdfba0f0d08a207eb788ec3b469b6/aioshutil-1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-21 08:42:23",
    "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"
}