aiopathlib 0.2.1

Pathlib support for asyncio

aiopathlib: Pathlib support for asyncio

aiopathlib is written in Python, for handling local disk files in asyncio applications.

Base on aiofiles and just like pathlib, but use await.

with open('filename', 'w') as f:
    f.write('My file contents')

text = await aiopathlib.AsyncPath('filename').read_text()
print(text)
'My file contents'

content = await aiopathlib.AsyncPath(Path('filename')).read_bytes()
print(content)
b'My file contents'

Asynchronous interface to create folder.

apath = AsyncPath('dirname/subpath')
if not await apath.exists():
    await apath.mkdir(parents=True)

Features

• a file API very similar to Python's standard package pathlib, blocking API
• support for buffered and unbuffered binary files, and buffered text files
• support for async/await (:PEP:492) constructs

Installation

To install aiofiles, simply:

$ pip install aiopathlib

Usage

These functions are awaitable

• read_text
• read_bytes
• read_json
• write_text
• write_bytes
• write_json
• mkdir
• exists
• rename
• remove/unlink
• stat
• lstat
• is_file
• is_dir
• is_symlink
• is_fifo
• is_mount
• is_block_device
• is_char_device
• is_socket

History

0.2.0 (2021-08-29)

• Make AsyncPath be subclass of pathlib.Path.
• Add github action to show test coverage.

0.1.3 (2021-08-28)

• Add makefile.
• Test all functions.
• Fix rename method error.
• Support sync pathlib methods.

0.1.0 (2021-06-14)

• Introduced a changelog.
• Publish at gitee.

Contributing

Contributions are very welcome.