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

CONNECT = "postgresql:///example"
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,
  ):
      # when n is an integer, a signal has been has been caught for further handling.
      if isinstance(n, int):
          sig = signal.Signals(n)
          if n in SIGNALS_TO_HANDLE:
              print(f"handling {sig.name}")
          print("interrupted, stopping")
          break

      # if `yield_on_timeout` has been set to True, the loop returns None after the timeout has been reached
      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.1541159130

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.1541159130
File Size Uploaded Provenance Actions
pgnotify-0.1.1541159130.tar.gz 3.9 kB Without provenance Details for pgnotify-0.1.1541159130.tar.gz

Built distribution (wheel)

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

Total release size: 11.5 kB

Release files / pgnotify-0.1.1541159130.tar.gz

Download URL pgnotify-0.1.1541159130.tar.gz
Size 3.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b5136c51801438ebf5ca20b09334a7722e9dfd9a532e591d3ab0d66555134a67
BLAKE2b-256 checksum
How to use checksums
5542c2db6daa18226b47062b364fc8884b5822fb7c716d290e8a15317b16ae15
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.1541159130-py2.py3-none-any.whl

Download URL pgnotify-0.1.1541159130-py2.py3-none-any.whl
Size 7.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
1f7ba4615000f9bde93df2c05d7d2987d427703bfed4da72a2f2df2ff31eca03
BLAKE2b-256 checksum
How to use checksums
e55d71c535ac32dffb390f9152712cb22e03320353ce0060373b04970371dd16
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.1541159130

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