This document describes the current stable version of Celery (5.6). For development docs, go here.

# `celery.events.event`

Creating events, and event exchange definition.

celery.events.event.Event(type, _fields=None, __dict__=<class 'dict'>, __now__=<built-in function time>, **fields)

  Create an event.

  Notes

  An event is simply a dictionary: the only required field is `type`. A `timestamp` field will be set to the current time if not provided.

celery.events.event.event_exchange = <unbound Exchange celeryev(topic)>

  Exchange used to send events on. Note: Use `get_exchange()` instead, as the type of exchange will vary depending on the broker connection.

celery.events.event.get_exchange(conn, name='celeryev')

  Get exchange used for sending events.

  Parameters:

    - conn (kombu.Connection) – Connection used for sending/receiving events.

    - name (str) – Name of the exchange. Default is `celeryev`.

  Note

  The event type changes if Redis is used as the transport (from topic -> fanout).

celery.events.event.group_from(type)

  Get the group part of an event type name.

  Example

      >>> group_from('task-sent')
      'task'

      >>> group_from('custom-my-event')
      'custom'