Project Links

Meta

Author: Kumar Aditya

Requires Python: >=3.8

Classifiers

Development Status

5 - Production/Stable

Framework

AsyncIO

Programming Language

Python
Python :: 3
Python :: 3.9
Python :: 3.10
Python :: 3.11
Python :: 3.12
Python :: 3.13
Python :: 3.14
Python :: 3 :: Only
Python :: Implementation :: CPython
Python :: Implementation :: PyPy

Operating System

OS Independent

License

OSI Approved :: BSD License

aioshutil: Asynchronous shutil module.

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

$ pip install aioshutil

Usage

The API of aioshutil module is same as shutil module except that it is asynchronous.

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

Wheel compatibility matrix

Platform	Python 3
any

Files in release

aioshutil-1.6-py3-none-any.whl (4.6KiB)

aioshutil-1.6.tar.gz (7.7KiB)

Extras: None

Dependencies:

typing-extensions

aioshutil 1.6