leaf_engine_flows.notify
========================

.. py:module:: leaf_engine_flows.notify


Functions
---------

.. autoapisummary::

   leaf_engine_flows.notify._get_flow_success_message
   leaf_engine_flows.notify._get_task_failure_message
   leaf_engine_flows.notify.notify_slack


Module Contents
---------------

.. py:function:: _get_flow_success_message(flow: prefect.Flow, old_state: prefect.engine.state.State, new_state: prefect.engine.state.State) -> Optional[str]

.. py:function:: _get_task_failure_message(task: prefect.Task, old_state: prefect.engine.state.State, new_state: prefect.engine.state.State) -> Optional[str]

.. py:function:: notify_slack(tracked_obj: Union[prefect.Flow, prefect.Task], old_state: prefect.engine.state.State, new_state: prefect.engine.state.State) -> prefect.engine.state.State

   Custom Slack notification method. Can be used as state_handler for both
   flows and tasks.

   :param tracked_obj: Flow or Task to notify about. Passed in by Prefect.
   :type tracked_obj: Union[Flow, Task]
   :param old_state: State object passed in by Prefect.
   :type old_state: State
   :param new_state: State object passed in by Prefect.
   :type new_state: State

   :returns: State object used by Prefect.
   :rtype: State