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 TestModel(AIOModel):
# Pay attention that we are using fields from Peewee-AIO for better typing support
id = fields.AutoField()
text = fields.CharField()
async def handler():
# Initialize the database's pool (optional)
async with manager:
# Acquire a connection
async with manager.connection():
# Create the table in database
await TestModel.create_table()
# Create a record
test = await TestModel.create(text="I'm working!")
assert test
assert test.id # Typechecking systems understands that test.id is string
# Iterate through records
async for test in TestModel.select():
assert test # Typechecking systems understands that the test is instance of Test
assert test.id
# Change records
test.text = "I'm changed"
await test.save()
# Update records
await TestModel.update({'text': "I'm updated!"}).where(TestModel.id == test.id)
# Delete records
await TestModel.delete().where(TestModel.id == test.id)
# Drop the table in database
await TestModel.drop_table()
# Run the handler with your async library
import asyncio
asyncio.run(handler())
Usage
TODO
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.3.0.tar.gz
(12.8 kB
view details)
Built Distribution
File details
Details for the file peewee_aio-1.3.0.tar.gz.
File metadata
- Download URL: peewee_aio-1.3.0.tar.gz
- Upload date:
- Size: 12.8 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 | 300add2fb753d58e578118a4aab0d240a503ea683aecd22f767499eaa7d92a09 |
|
| MD5 | 09bdedc04e6fa92f446b7c56e29426dc |
|
| BLAKE2b-256 | e664fed996327d2e5f559db69815fcf06d8e2846b533229ffe001d4fb3ba051c |
File details
Details for the file peewee_aio-1.3.0-py3-none-any.whl.
File metadata
- Download URL: peewee_aio-1.3.0-py3-none-any.whl
- Upload date:
- Size: 13.5 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 | 76cd6ab57eeee1f08e745cd9fc34a61bad1a28676322699ec85baef45249463c |
|
| MD5 | b7db935b6a12a07264591f25a53b9cef |
|
| BLAKE2b-256 | 79f219b282120ce810eb92435c78136d7621b1c08008dd226c5226b37d7a6c87 |
