Async support for Peewee ORM
Project description
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:
Requirements
- python >= 3.8
Installation
peewee-aio should be installed using pip:
$ pip install peewee-aio
You can install optional database drivers with:
$ pip install peewee-aio[aiosqlite]
$ pip install peewee-aio[aiomysql]
$ pip install peewee-aio[aiopg]
$ pip install peewee-aio[asyncpg]
$ pip install peewee-aio[trio_mysql]
$ pip install peewee-aio[triopg]
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
TODO
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
peewee_aio-1.4.2.tar.gz
(13.5 kB
view details)
Built Distribution
File details
Details for the file peewee_aio-1.4.2.tar.gz.
File metadata
- Download URL: peewee_aio-1.4.2.tar.gz
- Upload date:
- Size: 13.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.10.6 Linux/5.15.0-1034-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 60065f3e47655d2454762df6c7b4532658a58b4938e615a5203a51216af4a32f |
|
| MD5 | d7ec662d01484742d1b5cf89ed7484b7 |
|
| BLAKE2b-256 | 0aa981f69253154728920b1774aaa796f16b3b5b1b1840e5237fe00e15921711 |
File details
Details for the file peewee_aio-1.4.2-py3-none-any.whl.
File metadata
- Download URL: peewee_aio-1.4.2-py3-none-any.whl
- Upload date:
- Size: 13.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.10.6 Linux/5.15.0-1034-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6344b34ff23b1e52c9356cfc134cbab176cc91ad9156fbed235e47f5796f451f |
|
| MD5 | 249fb4208ac5bc2d01cd5b26ab8581f6 |
|
| BLAKE2b-256 | 6bf9af28050d815013afb58a7bb7aa7bb33c7e2d9ca094af53c157a14f0dfb1b |
