IPython Documentation

Table Of Contents

Previous topic

utils.text

Next topic

utils.traitlets

This Page

utils.timing

Module: utils.timing

Utilities for timing code execution.

Functions

IPython.utils.timing.timing(func, *args, **kw) → t_total

Execute a function once, return the elapsed total CPU time in seconds. This is just the first value in timings_out().

IPython.utils.timing.timings(reps, func, *args, **kw) -> (t_total, t_per_call)

Execute a function reps times, return a tuple with the elapsed total CPU time in seconds and the time per call. These are just the first two values in timings_out().

IPython.utils.timing.timings_out(reps, func, *args, **kw) -> (t_total, t_per_call, output)

Execute a function reps times, return a tuple with the elapsed total CPU time in seconds, the time per call and the function’s output.

Under Unix, the return value is the sum of user+system time consumed by the process, computed via the resource module. This prevents problems related to the wraparound effect which the time.clock() function has.

Under Windows the return value is in wall clock seconds. See the documentation for the time module for more details.