Coverage for gwcelery/igwn_alert/signals.py: 100%

1"""Definitions of custom :doc:`Celery signals <celery:userguide/signals>` 

2related to IGWN alerts. 

3 

4These signals allow us to keep the IGWN alert broker code decoupled from any 

5GCN-specific logic. Notably, it allows us to keep all of the details of 

6the GCN-specific "Notice Type" concept out of :mod:`gwcelery.voevent`. 

7""" 

8from celery.utils.dispatch import Signal 

9 

10igwn_alert_received = Signal( 

11 name='igwn_alert_received', providing_args=('topic', 'payload')) 

12"""Fired whenever a IGWN alert is received. 

13 

14Parameters 

15---------- 

16topic : str 

17 The igwn alert topic 

18payload : dict 

19 Alert dictionary 

20"""