Peewee-AIO

Async support for Peewee ORM

Features

Make Peewee ORM to work async
Supports PostgresQL, MySQL, SQLite
Supports asyncio and trio
Contains types as well
Drivers supported:
- aiosqlite
- aiomysql
- aiopg
- asyncpg
- triopg
- trio_mysql

Requirements

python >= 3.10

Installation

peewee-aio should be installed using pip:

pip install peewee-aio

You can install optional database drivers with:

pip install peewee-aio[aiosqlite]   # for SQLite (asyncio)
pip install peewee-aio[aiomysql]    # for MySQL (asyncio)
pip install peewee-aio[aiopg]       # for Postgresql (asyncio)
pip install peewee-aio[asyncpg]     # for Postgresql (asyncio)
pip install peewee-aio[trio_mysql]  # for MySQL (trio)
pip install peewee-aio[triopg]      # for PostgresQL (trio)

Quickstart

    import peewee
    from peewee_aio import Manager, AIOModel, fields

    manager = Manager('aiosqlite:///:memory:')

    @manager.register
    class Role(AIOModel):
        # Pay attention that we are using fields from Peewee-AIO for better typing support
        id = fields.AutoField()
        name = fields.CharField()

    @manager.register
    class User(AIOModel):

        # Pay attention that we are using fields from Peewee-AIO for better typing support
        id = fields.AutoField()
        name = fields.CharField()
        role = fields.ForeignKeyField(Role)

    async def handler():

        # Initialize the database's pool (optional)
        async with manager:

            # Acquire a connection
            async with manager.connection():

                # Create the tables in database
                await Role.create_table()
                await User.create_table()

                # Create a record
                role = await Role.create(name='user')
                assert role
                assert role.id  # role.id contains correct string type
                user = await User.create(name="Andrey", role=role)
                assert user
                assert user.id
                role = await user.role  # Load role from DB using the foreign key
                assert role  # role has a correct Role Type

                # Iterate through records
                async for user in User.select(User, Role).join(Role):
                    assert user  # user has a corrent User Type
                    assert user.id
                    role = await user.role  # No DB query here, because the fk is preloaded

                # Change records
                user.name = "Dmitry"
                await user.save()

                # Update records
                await User.update({"name": "Anonimous"}).where(User.id == user.id)

                # Delete records
                await User.delete().where(User.id == user.id)

                # Drop the tables in database
                await User.drop_table()
                await Role.drop_table()

    # Run the handler with your async library
    import asyncio

    asyncio.run(handler())

Usage

Supported schemas

aiomyql
aiomyql+pool
aiopg
aiopg+pool
asyncpg
asyncpg+pool
aioodbc
aioodbc+pool
aiosqlite
trio-mysql
triopg

Sync usage

The library still supports sync mode (use manager.allow_sync):

class Test(peewee.Model):
  data = peewee.CharField()

with manager.allow_sync():
  Test.create_table()
  Test.create(data='test')
  assert Test.select().count()
  Test.update(data='new-test').execute()

Get prefetched relations

TODO

# We prefetched roles here
async for user in User.select(User, Role).join(Role):
  role = user.fetch(User.role)  # get role from user relations cache

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/peewee-aio/issues

Contributing

Development of the project happens at: https://github.com/klen/peewee-aio

License

Licensed under a MIT License

Metadata

Release files for peewee-aio 3.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for peewee-aio 3.1.7
File	Size	Uploaded
peewee_aio-3.1.7.tar.gz	13.4 kB	Oct 5, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for peewee-aio 3.1.7
File	Interpreter	ABI	Platform	Reset
peewee_aio-3.1.7-py3-none-any.whl 15.3 kB Oct 5, 2026	Python 3	none	any	Details

Total release size: 28.8 kB

Release files / peewee_aio-3.1.7.tar.gz

Download URL	peewee_aio-3.1.7.tar.gz
Size	13.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`463a68965e9c8f0afe23462a102203564f27fdae682f47e47bedda51cbb8642c`
BLAKE2b-256 checksum How to use checksums	`6e997f9045a551ba7b91163588a4ce21c98d66e82ea4929522345f9b4eaf6212`
Upload date	Oct 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}`

Release files / peewee_aio-3.1.7-py3-none-any.whl

Download URL	peewee_aio-3.1.7-py3-none-any.whl
Size	15.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b7ebe3f7e89e0822733bfa9c72aec6e49e166b9f952a19fa2d80000a35681f16`
BLAKE2b-256 checksum How to use checksums	`4355c66e4ccab521dd6c97bf80e6fb704f598e08a7d588da9344ff387e48cdbd`
Upload date	Oct 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}`