Peewee support for async frameworks (Asyncio, Trio)
Project description
aio-peewee – Peewee support for async frameworks (Asyncio, Trio)
The library doesn’t make peewee work async, but allows you to use Peewee with your asyncio based libraries correctly.
Features
Tasks Safety. The library tracks of the connection state using Task-local storage, making the Peewee Database object safe to use with multiple tasks inside a loop.
Async support for connections. Connect to database asyncroniously
Async support for Peewee Connections Pool
Requirements
python >= 3.8
Installation
aio-peewee should be installed using pip:
pip install aio-peewee
QuickStart
from aiopeewee import db_url
db = db_url.connect('postgres+async://locahost:5432/database')
async def main(id=1):
async with db:
item = Model.get(Model.id == 1)
return item.nameUsage
Initialization
from aiopeewee import PostgresqlDatabaseAsync, SqliteDatabaseAsync, MySQLDatabaseAsync, CockroachDatabaseAsync
db = PostgresqlDatabaseAsync('my_app', user='app', password='db_password', host='10.1.0.8', port=3306)Async Connect
# Manual
async def main():
await db.connect_async()
# ...
db.close()
# Context manager
async def main():
async with db:
# ...Connection Pooling
from aiopeewee import PooledPostgresqlDatabaseAsync, PooledSqliteDatabaseAsync, PooledMySQLDatabaseAsync, PooledCockroachDatabaseAsync
db = PooledPostgresqlDatabase('my_database', max_connections=8, stale_timeout=300, user='postgres')Database URL
from aiopeewee import db_url
db0 = db_url.connect('cockroachdb+async://localhost/db', **db_params)
db1 = db_url.connect('cockroachdb+pool+async://localhost/db', **db_params)
db2 = db_url.connect('mysql+async://localhost/db', **db_params)
db3 = db_url.connect('mysql+pool+async://localhost/db', **db_params)
db4 = db_url.connect('postgres+async://localhost/db', **db_params)
db5 = db_url.connect('postgres+pool+async://localhost/db', **db_params)
db6 = db_url.connect('sqlite+async://localhost/db', **db_params)
db7 = db_url.connect('sqlite+pool+async://localhost/db', **db_params)
db8 = db_url.connect('sqliteexc+async://localhost/db', **db_params)
db9 = db_url.connect('sqliteexc+pool+async://localhost/db', **db_params)ASGI Middleware
import datetime as dt
from asgi_tools import App
from aiopeewee import PeeweeASGIPlugin
import peewee as pw
db = PeeweeASGIPlugin(url='sqlite+async:///db.sqlite')
@db.register
class Visit(pw.Model):
created = pw.DateTimeField(default=dt.datetime.utcnow())
address = pw.CharField()
db.create_tables()
app = App()
@app.route('/')
async def visits_json(request):
"""Store the visit and load latest 10 visits."""
Visit.create(address=request.client[0])
return [{
'id': v.id, 'address': v.address, 'timestamp': round(v.created.timestamp()),
} for v in Visit.select().order_by(Visit.id.desc()).limit(10)]
app = db.middleware(app)Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/aio-peewee/issues
Contributing
Development of the project happens at: https://github.com/klen/aio-peewee
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 Distributions
Built Distribution
File details
Details for the file aio_peewee-0.1.5-py3-none-any.whl.
File metadata
- Download URL: aio_peewee-0.1.5-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae7340ebb02cff4957db0405869db34132dac6347dfeb6ee1ea609bfb931be5f |
|
| MD5 | 0ab2577e59b0f127a52f4ff84310aadf |
|
| BLAKE2b-256 | 228972c5ec2535f4a534814db7dce693c274b5e416ba662be9f0cc85de7b28da |
