geonature.utils.celery
======================

.. py:module:: geonature.utils.celery


Attributes
----------

.. autoapisummary::

   geonature.utils.celery.celery_app


Classes
-------

.. autoapisummary::

   geonature.utils.celery.FlaskCelery


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

.. py:class:: FlaskCelery(*args, **kwargs)

   Bases: :py:obj:`celery.Celery`


   Celery application.

   Arguments:
       main (str): Name of the main module if running as `__main__`.
           This is used as the prefix for auto-generated task names.

   Keyword Arguments:
       broker (str): URL of the default broker used.
       backend (Union[str, Type[celery.backends.base.Backend]]):
           The result store backend class, or the name of the backend
           class to use.

           Default is the value of the :setting:`result_backend` setting.
       autofinalize (bool): If set to False a :exc:`RuntimeError`
           will be raised if the task registry or tasks are used before
           the app is finalized.
       set_as_current (bool):  Make this the global current app.
       include (List[str]): List of modules every worker should import.

       amqp (Union[str, Type[AMQP]]): AMQP object or class name.
       events (Union[str, Type[celery.app.events.Events]]): Events object or
           class name.
       log (Union[str, Type[Logging]]): Log object or class name.
       control (Union[str, Type[celery.app.control.Control]]): Control object
           or class name.
       tasks (Union[str, Type[TaskRegistry]]): A task registry, or the name of
           a registry class.
       fixups (List[str]): List of fix-up plug-ins (e.g., see
           :mod:`celery.fixups.django`).
       config_source (Union[str, class]): Take configuration from a class,
           or object.  Attributes may include any settings described in
           the documentation.
       task_cls (Union[str, Type[celery.app.task.Task]]): base task class to
           use. See :ref:`this section <custom-task-cls-app-wide>` for usage.


   .. py:method:: patch_task()


   .. py:method:: init_app(app)


.. py:data:: celery_app