api.rst

Public API

• Publish/Subscribe
  • Event
  • Publisher
  • Subscriber
• Exceptions
• Utilities
  • Subscribe decorator
  • Asyncio context manager

Publish/Subscribe

Event

.. autoclass:: eeee.event.Event
   :member-order: bysource
   :members:

Publisher

.. autoclass:: eeee.event.Publisher
   :member-order: bysource
   :members:

Subscriber

.. autoclass:: eeee.event.Subscriber
   :member-order: bysource
   :members:

Exceptions

.. py:module:: eeee.exceptions

.. autoexception:: EeeeException
   :members:

.. autoexception:: EeeeTypeError
   :members:

.. autoexception:: NamingError
   :members:

.. autoexception:: HandlerError
   :members:

.. autoexception:: NotCallableError
   :members:

.. autoexception:: NotCoroutineError
   :members:

.. inheritance-diagram:: eeee.exceptions

Utilities

Subscribe decorator

.. py:module:: eeee.event

.. autofunction:: subscribe

Asyncio context manager

Provided by Context Loop can be imported from eeee as well. Context loop allow to execute asynchronous code ad-hoc.

import eeee import Loop

>>> my_event = Event('MyEvent')
>>> with Loop(my_event.publish({'message': 'secret'})) as loop:
...   result = loop.run_until_complete()
...