API Reference
=============

App
---

.. autoclass:: procrastinate.App
    :members: open, open_async, task, run_worker, run_worker_async, configure_task,
              from_path, add_tasks_from, add_task_alias, with_connector, periodic,

Connectors
----------
.. autoclass:: procrastinate.PsycopgConnector
    :members:
    :exclude-members: open_async, close_async

.. autoclass:: procrastinate.SyncPsycopgConnector
    :members:
    :exclude-members: open, close

.. autoclass:: procrastinate.contrib.aiopg.AiopgConnector
    :members:
    :exclude-members: open_async, close_async

.. autoclass:: procrastinate.contrib.psycopg2.Psycopg2Connector
    :members:
    :exclude-members: open, close

.. autoclass:: procrastinate.testing.InMemoryConnector
    :members: reset


Tasks
-----
.. autoclass:: procrastinate.tasks.Task
    :members: defer, defer_async, configure

When tasks are created with argument ``pass_context``, they are provided a
`JobContext` argument:

.. autoclass:: procrastinate.JobContext
    :members: app, worker_name, worker_queues, job, task

Blueprints
----------

.. autoclass:: procrastinate.blueprints.Blueprint
    :members: task, periodic, add_tasks_from, add_task_alias


Builtin tasks
-------------

Procrastinate has builtin tasks that are all available from the CLI.
For all tasks, the context argument will be passed automatically.
The name of the tasks will be: ``builtin:procrastinate.builtin.<task_name>``

.. automodule:: procrastinate.builtin_tasks
    :members:

Jobs
----

.. autoclass:: procrastinate.jobs.Job


Retry strategies
----------------

.. automodule:: procrastinate.retry

.. autoclass:: procrastinate.RetryStrategy

.. autoclass:: procrastinate.BaseRetryStrategy
    :members: get_schedule_in


Exceptions
----------

.. automodule:: procrastinate.exceptions
    :members: ProcrastinateException, LoadFromPathError,
              ConnectorException, AlreadyEnqueued, AppNotOpen, TaskNotFound,
              UnboundTaskError

Job statuses
------------

.. autoclass:: procrastinate.jobs.Status
    :members:


Accessing the jobs in the Database
----------------------------------

.. autoclass:: procrastinate.manager.JobManager
    :members:

Django
------

.. automodule:: procrastinate.contrib.django


SQLAlchemy
----------

.. autoclass:: procrastinate.contrib.sqlalchemy.SQLAlchemyPsycopg2Connector