Skip to main content

pgnotify: Easily LISTEN to PostgreSQL NOTIFY notifications

LISTEN to and process NOTIFY events with a simple for loop, like so:

    from pgnotify import await_pg_notifications

    for notification in await_pg_notifications(
            'postgresql:///nameofdatabase',
            ['channel1', 'channel2']):

        print(notification.channel)
        print(notification.payload)

You can also handle timeouts and signals, as in this more fully-fleshed example:

import signal

from pgnotify import await_pg_notifications, get_dbapi_connection

# the first parameter of the await_pg_notifications
# loop is a dbapi connection in autocommit mode
CONNECT = "postgresql:///example"

# use this convenient method to create the right connection
# from a database URL
e = get_dbapi_connection(CONNECT)

SIGNALS_TO_HANDLE = [signal.SIGINT, signal.SIGTERM]

for n in await_pg_notifications(
    e,
    ["hello", "hello2"],
    timeout=10,
    yield_on_timeout=True,
    handle_signals=SIGNALS_TO_HANDLE,
):
    # the integer code of the signal is yielded on each
    # occurrence of a handled signal
    if isinstance(n, int):
        sig = signal.Signals(n)
        if n in SIGNALS_TO_HANDLE:
            print(f"handling {sig.name}")
        print("interrupted, stopping")
        break

    # the `yield_on_timeout` option makes the
    # loop yield `None` on timeout
    elif n is None:
        print("timeout, continuing")

    # handle the actual notify occurrences here
    else:
        print((n.pid, n.channel, n.payload))

Further documentation to come.

Metadata

Release files for pgnotify 0.1.1541160085

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pgnotify 0.1.1541160085
File Size Uploaded Provenance Actions
pgnotify-0.1.1541160085.tar.gz 4.0 kB Without provenance Details for pgnotify-0.1.1541160085.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pgnotify 0.1.1541160085
File Interpreter ABI Platform Actions
pgnotify-0.1.1541160085-py2.py3-none-any.whl Python 3, Python 2 none any Details for pgnotify-0.1.1541160085-py2.py3-none-any.whl

Total release size: 11.7 kB

Release files / pgnotify-0.1.1541160085.tar.gz

Download URL pgnotify-0.1.1541160085.tar.gz
Size 4.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4fd40b06e86ccd5aad1520a7ea67a8a0b071b8188d20dbfad39182a9dbae9d66
BLAKE2b-256 checksum
How to use checksums
22ff6d3d872c1a055f86a9aa906048132026eff3fa244b388a4a8b6b39ad7ab2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/0.12.5 CPython/3.7.0 Linux/4.4.0-137-generic

Release files / pgnotify-0.1.1541160085-py2.py3-none-any.whl

Download URL pgnotify-0.1.1541160085-py2.py3-none-any.whl
Size 7.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
de02e28a090669acb5a0558f1f6047d6a893309fb6278dfd158f92481e797166
BLAKE2b-256 checksum
How to use checksums
5d82284245d1036dab3d5d7846a6ae4c1f4f52ca9c99d4d07051bdd34f291783
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/0.12.5 CPython/3.7.0 Linux/4.4.0-137-generic

Security for pgnotify 0.1.1541160085

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page