states.py 1.2 KB

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