Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Tinche/aiofiles

File support for asyncio
https://github.com/Tinche/aiofiles

asyncio

Last synced: about 2 months ago
JSON representation

File support for asyncio

Host: GitHub
URL: https://github.com/Tinche/aiofiles
Owner: Tinche
License: apache-2.0
Created: 2015-03-29T20:28:14.000Z (over 9 years ago)
Default Branch: main
Last Pushed: 2024-02-06T15:59:00.000Z (10 months ago)
Last Synced: 2024-05-23T07:47:58.058Z (7 months ago)
Topics: asyncio
Language: Python
Size: 183 KB
Stars: 2,560
Watchers: 36
Forks: 148
Open Issues: 49
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md

Awesome Lists containing this project

stars - Tinche/aiofiles
awesomeLibrary - aiofiles - File support for asyncio. (语言资源库 / python)
best-of-python - GitHub - 42% open · ⏱️ 06.02.2024): (File & Path Utilities)
awesome-list - aiofiles - An Apache2 licensed library, written in Python, for handling local disk files in asyncio applications. (Data Format & I/O / For Python)
starred-awesome - aiofiles - File support for asyncio (Python)

README

        # aiofiles: file support for asyncio

[![PyPI](https://img.shields.io/pypi/v/aiofiles.svg)](https://pypi.python.org/pypi/aiofiles)

[![Build](https://github.com/Tinche/aiofiles/workflows/CI/badge.svg)](https://github.com/Tinche/aiofiles/actions)

[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Tinche/882f02e3df32136c847ba90d2688f06e/raw/covbadge.json)](https://github.com/Tinche/aiofiles/actions/workflows/main.yml)

[![Supported Python versions](https://img.shields.io/pypi/pyversions/aiofiles.svg)](https://github.com/Tinche/aiofiles)

[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

**aiofiles** is an Apache2 licensed library, written in Python, for handling local

disk files in asyncio applications.

Ordinary local file IO is blocking, and cannot easily and portably be made

asynchronous. This means doing file IO may interfere with asyncio applications,

which shouldn't block the executing thread. aiofiles helps with this by

introducing asynchronous versions of files that support delegating operations to

a separate thread pool.

```python

async with aiofiles.open('filename', mode='r') as f:

    contents = await f.read()

print(contents)

'My file contents'

```

Asynchronous iteration is also supported.

```python

async with aiofiles.open('filename') as f:

    async for line in f:

        ...

```

Asynchronous interface to tempfile module.

```python

async with aiofiles.tempfile.TemporaryFile('wb') as f:

    await f.write(b'Hello, World!')

```

## Features

- a file API very similar to Python's standard, blocking API

- support for buffered and unbuffered binary files, and buffered text files

- support for `async`/`await` ([PEP 492](https://peps.python.org/pep-0492/)) constructs

- async interface to tempfile module

## Installation

To install aiofiles, simply:

```bash

$ pip install aiofiles

```

## Usage

Files are opened using the `aiofiles.open()` coroutine, which in addition to

mirroring the builtin `open` accepts optional `loop` and `executor`

arguments. If `loop` is absent, the default loop will be used, as per the

set asyncio policy. If `executor` is not specified, the default event loop

executor will be used.

In case of success, an asynchronous file object is returned with an

API identical to an ordinary file, except the following methods are coroutines

and delegate to an executor:

- `close`

- `flush`

- `isatty`

- `read`

- `readall`

- `read1`

- `readinto`

- `readline`

- `readlines`

- `seek`

- `seekable`

- `tell`

- `truncate`

- `writable`

- `write`

- `writelines`

In case of failure, one of the usual exceptions will be raised.

`aiofiles.stdin`, `aiofiles.stdout`, `aiofiles.stderr`,

`aiofiles.stdin_bytes`, `aiofiles.stdout_bytes`, and

`aiofiles.stderr_bytes` provide async access to `sys.stdin`,

`sys.stdout`, `sys.stderr`, and their corresponding `.buffer` properties.

The `aiofiles.os` module contains executor-enabled coroutine versions of

several useful `os` functions that deal with files:

- `stat`

- `statvfs`

- `sendfile`

- `rename`

- `renames`

- `replace`

- `remove`

- `unlink`

- `mkdir`

- `makedirs`

- `rmdir`

- `removedirs`

- `link`

- `symlink`

- `readlink`

- `listdir`

- `scandir`

- `access`

- `getcwd`

- `path.abspath`

- `path.exists`

- `path.isfile`

- `path.isdir`

- `path.islink`

- `path.ismount`

- `path.getsize`

- `path.getatime`

- `path.getctime`

- `path.samefile`

- `path.sameopenfile`

### Tempfile

**aiofiles.tempfile** implements the following interfaces:

- TemporaryFile

- NamedTemporaryFile

- SpooledTemporaryFile

- TemporaryDirectory

Results return wrapped with a context manager allowing use with async with and async for.

```python

async with aiofiles.tempfile.NamedTemporaryFile('wb+') as f:

    await f.write(b'Line1\n Line2')

    await f.seek(0)

    async for line in f:

        print(line)

async with aiofiles.tempfile.TemporaryDirectory() as d:

    filename = os.path.join(d, "file.ext")

```

### Writing tests for aiofiles

Real file IO can be mocked by patching `aiofiles.threadpool.sync_open`

as desired. The return type also needs to be registered with the

`aiofiles.threadpool.wrap` dispatcher:

```python

aiofiles.threadpool.wrap.register(mock.MagicMock)(

    lambda *args, **kwargs: aiofiles.threadpool.AsyncBufferedIOBase(*args, **kwargs)

)

async def test_stuff():

    write_data = 'data'

    read_file_chunks = [

        b'file chunks 1',

        b'file chunks 2',

        b'file chunks 3',

        b'',

    ]

    file_chunks_iter = iter(read_file_chunks)

    mock_file_stream = mock.MagicMock(

        read=lambda *args, **kwargs: next(file_chunks_iter)

    )

    with mock.patch('aiofiles.threadpool.sync_open', return_value=mock_file_stream) as mock_open:

        async with aiofiles.open('filename', 'w') as f:

            await f.write(write_data)

            assert await f.read() == b'file chunks 1'

        mock_file_stream.write.assert_called_once_with(write_data)

```

### History

#### 24.1.0 (2024-06-24)

- Import `os.link` conditionally to fix importing on android.

  [#175](https://github.com/Tinche/aiofiles/issues/175)

- Remove spurious items from `aiofiles.os.__all__` when running on Windows.

- Switch to more modern async idioms: Remove types.coroutine and make AiofilesContextManager an awaitable instead a coroutine.

- Add `aiofiles.os.path.abspath` and `aiofiles.os.getcwd`.

  [#174](https://github.com/Tinche/aiofiles/issues/181)

- _aiofiles_ is now tested on Python 3.13 too.

  [#184](https://github.com/Tinche/aiofiles/pull/184)

- Dropped Python 3.7 support. If you require it, use version 23.2.1.

#### 23.2.1 (2023-08-09)

- Import `os.statvfs` conditionally to fix importing on non-UNIX systems.

  [#171](https://github.com/Tinche/aiofiles/issues/171) [#172](https://github.com/Tinche/aiofiles/pull/172)

- aiofiles is now also tested on Windows.

#### 23.2.0 (2023-08-09)

- aiofiles is now tested on Python 3.12 too.

  [#166](https://github.com/Tinche/aiofiles/issues/166) [#168](https://github.com/Tinche/aiofiles/pull/168)

- On Python 3.12, `aiofiles.tempfile.NamedTemporaryFile` now accepts a `delete_on_close` argument, just like the stdlib version.

- On Python 3.12, `aiofiles.tempfile.NamedTemporaryFile` no longer exposes a `delete` attribute, just like the stdlib version.

- Added `aiofiles.os.statvfs` and `aiofiles.os.path.ismount`.

  [#162](https://github.com/Tinche/aiofiles/pull/162)

- Use [PDM](https://pdm.fming.dev/latest/) instead of Poetry.

  [#169](https://github.com/Tinche/aiofiles/pull/169)

#### 23.1.0 (2023-02-09)

- Added `aiofiles.os.access`.

  [#146](https://github.com/Tinche/aiofiles/pull/146)

- Removed `aiofiles.tempfile.temptypes.AsyncSpooledTemporaryFile.softspace`.

  [#151](https://github.com/Tinche/aiofiles/pull/151)

- Added `aiofiles.stdin`, `aiofiles.stdin_bytes`, and other stdio streams.

  [#154](https://github.com/Tinche/aiofiles/pull/154)

- Transition to `asyncio.get_running_loop` (vs `asyncio.get_event_loop`) internally.

#### 22.1.0 (2022-09-04)

- Added `aiofiles.os.path.islink`.

  [#126](https://github.com/Tinche/aiofiles/pull/126)

- Added `aiofiles.os.readlink`.

  [#125](https://github.com/Tinche/aiofiles/pull/125)

- Added `aiofiles.os.symlink`.

  [#124](https://github.com/Tinche/aiofiles/pull/124)

- Added `aiofiles.os.unlink`.

  [#123](https://github.com/Tinche/aiofiles/pull/123)

- Added `aiofiles.os.link`.

  [#121](https://github.com/Tinche/aiofiles/pull/121)

- Added `aiofiles.os.renames`.

  [#120](https://github.com/Tinche/aiofiles/pull/120)

- Added `aiofiles.os.{listdir, scandir}`.

  [#143](https://github.com/Tinche/aiofiles/pull/143)

- Switched to CalVer.

- Dropped Python 3.6 support. If you require it, use version 0.8.0.

- aiofiles is now tested on Python 3.11.

#### 0.8.0 (2021-11-27)

- aiofiles is now tested on Python 3.10.

- Added `aiofiles.os.replace`.

  [#107](https://github.com/Tinche/aiofiles/pull/107)

- Added `aiofiles.os.{makedirs, removedirs}`.

- Added `aiofiles.os.path.{exists, isfile, isdir, getsize, getatime, getctime, samefile, sameopenfile}`.

  [#63](https://github.com/Tinche/aiofiles/pull/63)

- Added `suffix`, `prefix`, `dir` args to `aiofiles.tempfile.TemporaryDirectory`.

  [#116](https://github.com/Tinche/aiofiles/pull/116)

#### 0.7.0 (2021-05-17)

- Added the `aiofiles.tempfile` module for async temporary files.

  [#56](https://github.com/Tinche/aiofiles/pull/56)

- Switched to Poetry and GitHub actions.

- Dropped 3.5 support.

#### 0.6.0 (2020-10-27)

- `aiofiles` is now tested on ppc64le.

- Added `name` and `mode` properties to async file objects.

  [#82](https://github.com/Tinche/aiofiles/pull/82)

- Fixed a DeprecationWarning internally.

  [#75](https://github.com/Tinche/aiofiles/pull/75)

- Python 3.9 support and tests.

#### 0.5.0 (2020-04-12)

- Python 3.8 support. Code base modernization (using `async/await` instead of `asyncio.coroutine`/`yield from`).

- Added `aiofiles.os.remove`, `aiofiles.os.rename`, `aiofiles.os.mkdir`, `aiofiles.os.rmdir`.

  [#62](https://github.com/Tinche/aiofiles/pull/62)

#### 0.4.0 (2018-08-11)

- Python 3.7 support.

- Removed Python 3.3/3.4 support. If you use these versions, stick to aiofiles 0.3.x.

#### 0.3.2 (2017-09-23)

- The LICENSE is now included in the sdist.

  [#31](https://github.com/Tinche/aiofiles/pull/31)

#### 0.3.1 (2017-03-10)

- Introduced a changelog.

- `aiofiles.os.sendfile` will now work if the standard `os` module contains a `sendfile` function.

### Contributing

Contributions are very welcome. Tests can be run with `tox`, please ensure

the coverage at least stays the same before you submit a pull request.