Live Chat

We'll need to share your messages (and your email address if you're logged in) with our live chat provider, Drift. Here's their privacy policy.

If you don't want to do this, you can email us instead at

Communicating with Background Tasks

Each instance of a Background Task is associated with a Task object that can be used to get the task’s current status, and any data the task has passed to the main program.

The Task object can also be used to control the running of the task.

Communicating back to the main program

From within the task, modify anvil.server.task_state to share data with the main program.

The main program gets a Task object as the return value of anvil.server.launch_background_task. This object has a get_state() method that returns the task_state.

By default, anvil.server.task_state is an empty dict, so you can immediately set key/value pairs: anvil.server.task_state['progress'] = 42.

The Task can also raise exceptions; the main program can access these using the is_completed and get_error methods of the Task object.

def launch_my_task():
  task = anvil.server.launch_background_task('train_my_network', 200)

  # Output some state from the task

  # Is the task complete yet?
  if task.is_completed():

  # Store the ID of the task so we can see it later

  # If the task raised an exception, re-raise it here

  # Otherwise, kill the task

  # Check the termination status
  if task.get_termination_status() == "killed":
    print("Yes, the task was killed!")

  # Finally, return the task to the client
  return task

Task object

The Task object reports on task status and gives you control over the task.

There are three ways to get the Task object for a particular task:

  • When launching a task. It is the return value of anvil.server.launch_background_task.
  • Later on, using anvil.server.get_background_task(task_id). You need to know the task_id, which you can get using task.get_id(). You may wish to store this ID in a Data Table or elsewhere.
  • Using anvil.server.list_background_tasks(). See “Listing Background Tasks from code”, below.

The Task object’s methods are:

  • get_state(): returns an object that you can modify from within the task (by modifying anvil.server.task_state inside the task).
  • get_id(): returns the ID of a task, which is a string.
  • get_task_name(): returns the name of the task. Usually the name of the function decorated with anvil.server.background_task.
  • get_start_time(): returns a DateTime representing the time this task was started.
  • get_return_value(): returns the return value of the task, or None if the task has not yet returned.
  • get_error(): re-throws whatever exception caused the task to terminate.
  • kill(): stops the task and makes its status "killed" rather than "failed". This can only be executed on the server side.
  • get_termination_status() returns:
    • None if the task is still running
    • "completed" if the task completed successfully
    • "failed" if the task terminated with an exception
    • "killed" if the task was explicitly killed with task.kill(), or by clicking “Kill” in the development environment
    • "missing" if an infrastructure failure caused us to lose track of the task.
  • is_running(): returns True if the task is still running. Otherwise returns False, regardless of how the task ended (completed, killed, failed or missing).
  • is_completed(): returns True if the task completed successfully, False if the task is still running. If the task has failed or been killed, it raises whatever caused the task to terminate.

When you run a print statement in a Background Task, the output is visible in the App Logs.