leaf_engine_flows.task
======================

.. py:module:: leaf_engine_flows.task


Attributes
----------

.. autoapisummary::

   leaf_engine_flows.task.logger


Classes
-------

.. autoapisummary::

   leaf_engine_flows.task.DatabaseReadTask
   leaf_engine_flows.task.LeafTask
   leaf_engine_flows.task.MappedDashboardTask
   leaf_engine_flows.task.MappedDatabaseReadTask


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

.. py:class:: DatabaseReadTask(function: Callable, read_cached_db_calls: bool = False, *args, **kwargs)

   Bases: :py:obj:`LeafTask`


   A thin wrapper around LeafTask to add database specific functionality.


   .. py:method:: enable_read_cached_db_calls()

      Enables reading cached DB calls for the task.



   .. py:attribute:: target
      :value: None



.. py:class:: LeafTask(function: Callable, read_checkpoint: bool = False, write_checkpoint: bool = False, serializer: prefect.engine.serializers.Serializer = None, file_type: str = 'csv', *args, **kwargs)

   Bases: :py:obj:`prefect.Task`


   A thin wrapper around Prefect's Task class.

   :param function: The function to execute when the task is run.
   :type function: Callable


   .. py:method:: enable_read_checkpoint()

      Enables reading a checkpoint file for the task.



   .. py:method:: enable_write_checkpoint()

      Enables writing a checkpoint file for the task.



   .. py:method:: run(**kwargs) -> Any


   .. py:attribute:: checkpoint
      :value: False



   .. py:attribute:: file_type


   .. py:attribute:: function


   .. py:attribute:: location


   .. py:attribute:: name


   .. py:attribute:: result
      :value: None



   .. py:attribute:: serializer


   .. py:attribute:: target
      :value: None



.. py:class:: MappedDashboardTask(function: Callable, *args, **kwargs)

   Bases: :py:obj:`LeafTask`


   A thin wrapper around LeafTask to add dashboard specific functionality.

   Will try to use a shipper-specific function if it exists, otherwise
   defers to the default function.


   .. py:method:: run(**kwargs) -> Any


   .. py:attribute:: serializer


.. py:class:: MappedDatabaseReadTask(function: Callable, read_cached_db_calls: bool = False, *args, **kwargs)

   Bases: :py:obj:`DatabaseReadTask`, :py:obj:`MappedDashboardTask`


   A mixin class of DatabaseReadTask and MappedDashboardTask.


   .. py:method:: init(*args, **kwargs)


.. py:data:: logger