Skip to content
This repository was archived by the owner on Apr 1, 2022. It is now read-only.

Commit 50d8115

Browse files
committed
Document the :setting:Event setting
1 parent 463d742 commit 50d8115

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

docs/userguide/settings.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1454,6 +1454,29 @@ Example using the string path to a class::
14541454

14551455
app = App(..., Agent='myproj.agents.Agent')
14561456

1457+
.. setting:: Event
1458+
1459+
``Event``
1460+
---------
1461+
1462+
:type: ``Union[str, Type]``
1463+
:default: :class:`faust.Event`
1464+
1465+
The :class:`~faust.Event` class to use for creating new event objects,
1466+
or the fully-qualified path to one (supported by
1467+
:func:`~mode.utils.imports.symbol_by_name`).
1468+
1469+
Example using a class::
1470+
1471+
class MyBaseEvent(faust.Event):
1472+
...
1473+
1474+
app = App(..., Event=MyBaseEvent)
1475+
1476+
Example using the string path to a class::
1477+
1478+
app = App(..., Event='myproj.events.Event')
1479+
14571480
.. setting:: Stream
14581481

14591482
``Stream``

0 commit comments

Comments
 (0)