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

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

2related to VOEvents. 

3 

4These signals allow us to keep the VOEvent 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 

10voevent_received = Signal( 

11 name='voevent_received', providing_args=('xml_document',)) 

12"""Fired whenever a VOEvent is received. 

13 

14Parameters 

15---------- 

16xml_document : :class:`comet.utility.xml.xml_document` 

17 The XML document that was received. The raw file contents are available as 

18 ``xml_document.raw_bytes``. The ``lxml.etree`` representation of the 

19 document is available as ``xml_document.element``. 

20"""