### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »

# lib.backgroundjobs

## Module: `lib.backgroundjobs`

Inheritance diagram for `IPython.lib.backgroundjobs`:

Manage background (threaded) jobs conveniently from an interactive shell.

This module provides a BackgroundJobManager class. This is the main class meant for public usage, it implements an object which can create and manage new background jobs.

It also provides the actual job classes managed by these BackgroundJobManager objects, see their docstrings below.

This system was inspired by discussions with B. Granger and the BackgroundCommand class described in the book Python Scripting for Computational Science, by H. P. Langtangen:

http://folk.uio.no/hpl/scripting

(although ultimately no code from this text was used, as IPython’s system is a separate implementation).

## Classes

### `BackgroundJobBase`

class `IPython.lib.backgroundjobs.``BackgroundJobBase`

  Bases: `threading.Thread`

  Base class to build BackgroundJob classes.

  The derived classes must implement:

  - Their own __init__, since the one here raises NotImplementedError. The

  derived constructor must call self._init() at the end, to provide common initialization.

  - A strform attribute used in calls to __str__.
  - A call() method, which will make the actual execution call and must

  return a value to be held in the ‘result’ field of the job object.

  `__init__`()
  `daemon`
  `getName`()
  `ident`
  `isAlive`()
  `isDaemon`()
  `is_alive`()
  `join`(timeout=None)
  `name`
  `run`()
  `setDaemon`(daemonic)
  `setName`(name)
  `start`()
  `stat_completed` = 'Completed'
  `stat_completed_c` = 2
  `stat_created` = 'Created'
  `stat_created_c` = 0
  `stat_dead` = 'Dead (Exception), call jobs.traceback() for details'
  `stat_dead_c` = -1
  `stat_running` = 'Running'
  `stat_running_c` = 1
  `traceback`()

### `BackgroundJobExpr`

class `IPython.lib.backgroundjobs.``BackgroundJobExpr`(expression, glob=None, loc=None)

  Bases: `IPython.lib.backgroundjobs.BackgroundJobBase`

  Evaluate an expression as a background job (uses a separate thread).

  `__init__`(expression, glob=None, loc=None)

    Create a new job from a string which can be fed to eval().

    global/locals dicts can be provided, which will be passed to the eval call.

  `call`()
  `daemon`
  `getName`()
  `ident`
  `isAlive`()
  `isDaemon`()
  `is_alive`()
  `join`(timeout=None)
  `name`
  `run`()
  `setDaemon`(daemonic)
  `setName`(name)
  `start`()
  `stat_completed` = 'Completed'
  `stat_completed_c` = 2
  `stat_created` = 'Created'
  `stat_created_c` = 0
  `stat_dead` = 'Dead (Exception), call jobs.traceback() for details'
  `stat_dead_c` = -1
  `stat_running` = 'Running'
  `stat_running_c` = 1
  `traceback`()

### `BackgroundJobFunc`

class `IPython.lib.backgroundjobs.``BackgroundJobFunc`(func, *args, **kwargs)

  Bases: `IPython.lib.backgroundjobs.BackgroundJobBase`

  Run a function call as a background job (uses a separate thread).

  `__init__`(func, *args, **kwargs)

    Create a new job from a callable object.

    Any positional arguments and keyword args given to this constructor after the initial callable are passed directly to it.

  `call`()
  `daemon`
  `getName`()
  `ident`
  `isAlive`()
  `isDaemon`()
  `is_alive`()
  `join`(timeout=None)
  `name`
  `run`()
  `setDaemon`(daemonic)
  `setName`(name)
  `start`()
  `stat_completed` = 'Completed'
  `stat_completed_c` = 2
  `stat_created` = 'Created'
  `stat_created_c` = 0
  `stat_dead` = 'Dead (Exception), call jobs.traceback() for details'
  `stat_dead_c` = -1
  `stat_running` = 'Running'
  `stat_running_c` = 1
  `traceback`()

### `BackgroundJobManager`

class `IPython.lib.backgroundjobs.``BackgroundJobManager`

  Class to manage a pool of backgrounded threaded jobs.

  Below, we assume that ‘jobs’ is a BackgroundJobManager instance.

  Usage summary (see the method docstrings for details):

  > jobs.new(...) -> start a new job

  > jobs() or jobs.status() -> print status summary of all jobs

  > jobs[N] -> returns job number N.

  > foo = jobs[N].result -> assign to variable foo the result of job N

  > jobs[N].traceback() -> print the traceback of dead job N

  > jobs.remove(N) -> remove (finished) job N

  > jobs.flush_finished() -> remove all finished jobs

  As a convenience feature, BackgroundJobManager instances provide the utility result and traceback methods which retrieve the corresponding information from the jobs list:

  > jobs.result(N) <–> jobs[N].result jobs.traceback(N) <–> jobs[N].traceback()

  While this appears minor, it allows you to use tab completion interactively on the job manager instance.

  In interactive mode, IPython provides the magic fuction %bg for quick creation of backgrounded expression-based jobs. Type bg? for details.

  `__init__`()
  `flush_finished`()

    Flush all jobs finished (completed and dead) from lists.

    Running jobs are never flushed.

    It first calls _status_new(), to update info. If any jobs have completed since the last _status_new() call, the flush operation aborts.

  `new`(func_or_exp, *args, **kwargs)

    Add a new background job and start it in a separate thread.

    There are two types of jobs which can be created:

    1. Jobs based on expressions which can be passed to an eval() call. The expression must be given as a string. For example:

    > job_manager.new(‘myfunc(x,y,z=1)’[,glob[,loc]])

    The given expression is passed to eval(), along with the optional global/local dicts provided. If no dicts are given, they are extracted automatically from the caller’s frame.

    A Python statement is NOT a valid eval() expression. Basically, you can only use as an eval() argument something which can go on the right of an ‘=’ sign and be assigned to a variable.

    For example,”print ‘hello’” is not valid, but ‘2+3’ is.

    2. Jobs given a function object, optionally passing additional positional arguments:

    > job_manager.new(myfunc,x,y)

    The function is called with the given arguments.

    If you need to pass keyword arguments to your function, you must supply them as a dict named kw:

    > job_manager.new(myfunc,x,y,kw=dict(z=1))

    The reason for this assymmetry is that the new() method needs to maintain access to its own keywords, and this prevents name collisions between arguments to new() and arguments to your own functions.

    In both cases, the result is stored in the job.result field of the background job object.

    Notes and caveats:

    1. All threads running share the same standard output. Thus, if your background jobs generate output, it will come out on top of whatever you are currently writing. For this reason, background jobs are best used with silent functions which simply return their output.

    2. Threads also all work within the same global namespace, and this system does not lock interactive variables. So if you send job to the background which operates on a mutable object for a long time, and start modifying that same mutable object interactively (or in another backgrounded job), all sorts of bizarre behaviour will occur.

    3. If a background job is spending a lot of time inside a C extension module which does not release the Python Global Interpreter Lock (GIL), this will block the IPython prompt. This is simply because the Python interpreter can only switch between threads at Python bytecodes. While the execution is inside C code, the interpreter must simply wait unless the extension module releases the GIL.

    4. There is no way, due to limitations in the Python threads library, to kill a thread once it has started.

  `remove`(num)

    Remove a finished (completed or dead) job.

  `result`(N) → return the result of job N.
  `status`(verbose=0)

    Print a status of all jobs currently being managed.

  `traceback`(num)

### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »