asyncpg-listen

asyncpg-listen

This library simplifies usage of listen/notify with asyncpg:

• Handles loss of a connection
• Simplifies notifications processing from multiple channels
• Setups a timeout for receiving a notification
• Allows to receive all notifications/only last notification depending on ListenPolicy.

import asyncio
import asyncpg
import asyncpg_listen


async def handle_notifications(notification: asyncpg_listen.NotificationOrTimeout) -> None:
    print(f"{notification} has been received")


async def main():
    listener = asyncpg_listen.NotificationListener(asyncpg_listen.connect_func(user="postgres"))
    listener_task = asyncio.create_task(
        listener.run(
            {"simple": handle_notifications},
            policy=asyncpg_listen.ListenPolicy.LAST,
            notification_timeout=5
        )
    )

    await asyncio.sleep(1)

    connection = await asyncpg.connect(user="postgres")
    try:
        for i in range(42):
            await connection.execute(f"NOTIFY simple, '{i}'")
    finally:
        await connection.close()

    await asyncio.sleep(1)

    listener_task.cancel()


asyncio.run(main())

v0.0.9 (2025-07-16)

SELECT 1 only if we haven't seen any events

No need to wait for a connection closure

v0.0.8 (2025-05-25)

• Support python 3.13

v0.0.7 (2024-09-07)

• Support python 3.12 and end support of 3.8
• End support of python 3.9 and 3.10
• Eagerly start notification processing with Python 3.12+
• Switch to asyncio.TaskGroup

v0.0.6 (2022-11-02)

• Add support of python 3.11

v0.0.5 (2022-05-23)

• Wait for tasks cancellation

v0.0.4 (2022-01-24)

• Reset failed attempts counter on successful connection

v0.0.3 (2022-01-23)

• Support python 3.8

v0.0.2 (2021-11-02)

• Support async-timeout 4.0+

v0.0.1 (2021-10-27)

• A first version