asyncpg-engine
Little wrapper around asyncpg for specific experience.
Basic usage
from asyncpg_engine import Engine
engine = await Engine.create("postgres://guest:guest@localhost:5432/guest?sslmode=disable")
async with engine.acquire() as con:
# https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.connection.Connection
assert await con.fetchval("SELECT 1") == 1
Custom type conversions
You can specify custom encoder\decoder by subclassing Engine:
from asyncpg_engine import Engine
import orjson
class MyEngine(Engine):
@staticmethod
async def _set_codecs(con: Connection) -> None:
# https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.connection.Connection.set_type_codec
await con.set_type_codec(
"json", encoder=orjson.dumps, decoder=orjson.loads, schema="pg_catalog"
)
Development and contribution
First of all you should install Poetry using official instructions or solutions provided by your distro. Then install dependencies:
poetry install
Run PostgreSQL using provided docker-compose configuration:
docker-compose up # run it in another terminal or add `-d` to daemonize
Project uses combination of flake8, black, isort and mypy for linting and pytest for testing.
poetry run flake8
poetry run mypy ./
poetry run pytest
155 Dec 16, 2022
104 Nov 26, 2022
740 Dec 18, 2022
83 Dec 12, 2022
904 Jan 2, 2023
3.4k Jan 1, 2023
55 Dec 12, 2022
469 Jan 4, 2023
1.4k Jan 7, 2023
1.5k Jan 5, 2023
446 Dec 7, 2022
31 Dec 9, 2022
11.4k Jan 2, 2023
7 Dec 11, 2022
5 Jan 3, 2022
60 Jan 3, 2023
180 Jan 1, 2023
4 Jul 30, 2022
6 Jul 1, 2022
6 May 30, 2022
404 Dec 3, 2022
18 Dec 23, 2022
458 Dec 30, 2022
11.4k Jan 9, 2023
49 Sep 12, 2022
469 Jan 4, 2023