states.py 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. """
  2. States
  3. ------
  4. .. data:: PENDING
  5. Task is waiting for execution or unknown.
  6. .. data:: STARTED
  7. Task has been started.
  8. .. data:: SUCCESS
  9. Task has been successfully executed.
  10. .. data:: FAILURE
  11. Task execution resulted in failure.
  12. .. data:: RETRY
  13. Task is being retried.
  14. .. data:: REVOKED
  15. Task has been revoked.
  16. Sets
  17. ----
  18. .. data:: READY_STATES
  19. Set of states meaning the task result is ready (has been executed).
  20. .. data:: UNREADY_STATES
  21. Set of states meaning the task result is not ready (has not been executed).
  22. .. data:: EXCEPTION_STATES
  23. Set of states meaning the task returned an exception.
  24. .. data:: PROPAGATE_STATES
  25. Set of exception states that should propagate exceptions to the user.
  26. .. data:: ALL_STATES
  27. Set of all possible states.
  28. """
  29. PENDING = "PENDING"
  30. STARTED = "STARTED"
  31. SUCCESS = "SUCCESS"
  32. FAILURE = "FAILURE"
  33. REVOKED = "REVOKED"
  34. RETRY = "RETRY"
  35. READY_STATES = frozenset([SUCCESS, FAILURE, REVOKED])
  36. UNREADY_STATES = frozenset([PENDING, STARTED, RETRY])
  37. EXCEPTION_STATES = frozenset([RETRY, FAILURE, REVOKED])
  38. PROPAGATE_STATES = frozenset([FAILURE, REVOKED])
  39. ALL_STATES = frozenset([PENDING, STARTED, SUCCESS, FAILURE, RETRY, REVOKED])