home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2006 January / Gamestar_80_2006-01_dvd.iso / Dema / Civilization4 / data1.cab / Civ4DemoComponent / Assets / Python / System / timeit.pyc (.txt) < prev    next >
Encoding:
Python Compiled Bytecode  |  2005-11-09  |  10.0 KB  |  308 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.4)
  3.  
  4. """Tool for measuring execution time of small code snippets.
  5.  
  6. This module avoids a number of common traps for measuring execution
  7. times.  See also Tim Peters' introduction to the Algorithms chapter in
  8. the Python Cookbook, published by O'Reilly.
  9.  
  10. Library usage: see the Timer class.
  11.  
  12. Command line usage:
  13.     python timeit.py [-n N] [-r N] [-s S] [-t] [-c] [-h] [statement]
  14.  
  15. Options:
  16.   -n/--number N: how many times to execute 'statement' (default: see below)
  17.   -r/--repeat N: how many times to repeat the timer (default 3)
  18.   -s/--setup S: statement to be executed once initially (default 'pass')
  19.   -t/--time: use time.time() (default on Unix)
  20.   -c/--clock: use time.clock() (default on Windows)
  21.   -v/--verbose: print raw timing results; repeat for more digits precision
  22.   -h/--help: print this usage message and exit
  23.   statement: statement to be timed (default 'pass')
  24.  
  25. A multi-line statement may be given by specifying each line as a
  26. separate argument; indented lines are possible by enclosing an
  27. argument in quotes and using leading spaces.  Multiple -s options are
  28. treated similarly.
  29.  
  30. If -n is not given, a suitable number of loops is calculated by trying
  31. successive powers of 10 until the total time is at least 0.2 seconds.
  32.  
  33. The difference in default timer function is because on Windows,
  34. clock() has microsecond granularity but time()'s granularity is 1/60th
  35. of a second; on Unix, clock() has 1/100th of a second granularity and
  36. time() is much more precise.  On either platform, the default timer
  37. functions measure wall clock time, not the CPU time.  This means that
  38. other processes running on the same computer may interfere with the
  39. timing.  The best thing to do when accurate timing is necessary is to
  40. repeat the timing a few times and use the best time.  The -r option is
  41. good for this; the default of 3 repetitions is probably enough in most
  42. cases.  On Unix, you can use clock() to measure CPU time.
  43.  
  44. Note: there is a certain baseline overhead associated with executing a
  45. pass statement.  The code here doesn't try to hide it, but you should
  46. be aware of it.  The baseline overhead can be measured by invoking the
  47. program without arguments.
  48.  
  49. The baseline overhead differs between Python versions!  Also, to
  50. fairly compare older Python versions to Python 2.3, you may want to
  51. use python -O for the older versions to avoid timing SET_LINENO
  52. instructions.
  53. """
  54. import gc
  55. import sys
  56. import time
  57.  
  58. try:
  59.     import itertools
  60. except ImportError:
  61.     itertools = None
  62.  
  63. __all__ = [
  64.     'Timer']
  65. dummy_src_name = '<timeit-src>'
  66. default_number = 1000000
  67. default_repeat = 3
  68. if sys.platform == 'win32':
  69.     default_timer = time.clock
  70. else:
  71.     default_timer = time.time
  72. template = '\ndef inner(_it, _timer):\n    %(setup)s\n    _t0 = _timer()\n    for _i in _it:\n        %(stmt)s\n    _t1 = _timer()\n    return _t1 - _t0\n'
  73.  
  74. def reindent(src, indent):
  75.     '''Helper to reindent a multi-line statement.'''
  76.     return src.replace('\n', '\n' + ' ' * indent)
  77.  
  78.  
  79. class Timer:
  80.     """Class for timing execution speed of small code snippets.
  81.  
  82.     The constructor takes a statement to be timed, an additional
  83.     statement used for setup, and a timer function.  Both statements
  84.     default to 'pass'; the timer function is platform-dependent (see
  85.     module doc string).
  86.  
  87.     To measure the execution time of the first statement, use the
  88.     timeit() method.  The repeat() method is a convenience to call
  89.     timeit() multiple times and return a list of results.
  90.  
  91.     The statements may contain newlines, as long as they don't contain
  92.     multi-line string literals.
  93.     """
  94.     
  95.     def __init__(self, stmt = 'pass', setup = 'pass', timer = default_timer):
  96.         '''Constructor.  See class doc string.'''
  97.         self.timer = timer
  98.         stmt = reindent(stmt, 8)
  99.         setup = reindent(setup, 4)
  100.         src = template % {
  101.             'stmt': stmt,
  102.             'setup': setup }
  103.         self.src = src
  104.         code = compile(src, dummy_src_name, 'exec')
  105.         ns = { }
  106.         exec code in globals(), ns
  107.         self.inner = ns['inner']
  108.  
  109.     
  110.     def print_exc(self, file = None):
  111.         '''Helper to print a traceback from the timed code.
  112.  
  113.         Typical use:
  114.  
  115.             t = Timer(...)       # outside the try/except
  116.             try:
  117.                 t.timeit(...)    # or t.repeat(...)
  118.             except:
  119.                 t.print_exc()
  120.  
  121.         The advantage over the standard traceback is that source lines
  122.         in the compiled template will be displayed.
  123.  
  124.         The optional file argument directs where the traceback is
  125.         sent; it defaults to sys.stderr.
  126.         '''
  127.         import linecache
  128.         import traceback
  129.         linecache.cache[dummy_src_name] = (len(self.src), None, self.src.split('\n'), dummy_src_name)
  130.         traceback.print_exc(file = file)
  131.  
  132.     
  133.     def timeit(self, number = default_number):
  134.         """Time 'number' executions of the main statement.
  135.  
  136.         To be precise, this executes the setup statement once, and
  137.         then returns the time it takes to execute the main statement
  138.         a number of times, as a float measured in seconds.  The
  139.         argument is the number of times through the loop, defaulting
  140.         to one million.  The main statement, the setup statement and
  141.         the timer function to be used are passed to the constructor.
  142.         """
  143.         if itertools:
  144.             it = itertools.repeat(None, number)
  145.         else:
  146.             it = [
  147.                 None] * number
  148.         gcold = gc.isenabled()
  149.         gc.disable()
  150.         timing = self.inner(it, self.timer)
  151.         if gcold:
  152.             gc.enable()
  153.         
  154.         return timing
  155.  
  156.     
  157.     def repeat(self, repeat = default_repeat, number = default_number):
  158.         """Call timeit() a few times.
  159.  
  160.         This is a convenience function that calls the timeit()
  161.         repeatedly, returning a list of results.  The first argument
  162.         specifies how many times to call timeit(), defaulting to 3;
  163.         the second argument specifies the timer argument, defaulting
  164.         to one million.
  165.  
  166.         Note: it's tempting to calculate mean and standard deviation
  167.         from the result vector and report these.  However, this is not
  168.         very useful.  In a typical case, the lowest value gives a
  169.         lower bound for how fast your machine can run the given code
  170.         snippet; higher values in the result vector are typically not
  171.         caused by variability in Python's speed, but by other
  172.         processes interfering with your timing accuracy.  So the min()
  173.         of the result is probably the only number you should be
  174.         interested in.  After that, you should look at the entire
  175.         vector and apply common sense rather than statistics.
  176.         """
  177.         r = []
  178.         for i in range(repeat):
  179.             t = self.timeit(number)
  180.             r.append(t)
  181.         
  182.         return r
  183.  
  184.  
  185.  
  186. def main(args = None):
  187.     '''Main program, used when run as a script.
  188.  
  189.     The optional argument specifies the command line to be parsed,
  190.     defaulting to sys.argv[1:].
  191.  
  192.     The return value is an exit code to be passed to sys.exit(); it
  193.     may be None to indicate success.
  194.  
  195.     When an exception happens during timing, a traceback is printed to
  196.     stderr and the return value is 1.  Exceptions at other times
  197.     (including the template compilation) are not caught.
  198.     '''
  199.     if args is None:
  200.         args = sys.argv[1:]
  201.     
  202.     import getopt
  203.     
  204.     try:
  205.         (opts, args) = getopt.getopt(args, 'n:s:r:tcvh', [
  206.             'number=',
  207.             'setup=',
  208.             'repeat=',
  209.             'time',
  210.             'clock',
  211.             'verbose',
  212.             'help'])
  213.     except getopt.error:
  214.         err = None
  215.         print err
  216.         print 'use -h/--help for command line help'
  217.         return 2
  218.  
  219.     timer = default_timer
  220.     if not '\n'.join(args):
  221.         pass
  222.     stmt = 'pass'
  223.     number = 0
  224.     setup = []
  225.     repeat = default_repeat
  226.     verbose = 0
  227.     precision = 3
  228.     for o, a in opts:
  229.         if o in ('-n', '--number'):
  230.             number = int(a)
  231.         
  232.         if o in ('-s', '--setup'):
  233.             setup.append(a)
  234.         
  235.         if o in ('-r', '--repeat'):
  236.             repeat = int(a)
  237.             if repeat <= 0:
  238.                 repeat = 1
  239.             
  240.         
  241.         if o in ('-t', '--time'):
  242.             timer = time.time
  243.         
  244.         if o in ('-c', '--clock'):
  245.             timer = time.clock
  246.         
  247.         if o in ('-v', '--verbose'):
  248.             if verbose:
  249.                 precision += 1
  250.             
  251.             verbose += 1
  252.         
  253.         if o in ('-h', '--help'):
  254.             print __doc__,
  255.             return 0
  256.             continue
  257.     
  258.     if not '\n'.join(setup):
  259.         pass
  260.     setup = 'pass'
  261.     import os
  262.     sys.path.insert(0, os.curdir)
  263.     t = Timer(stmt, setup, timer)
  264.     if number == 0:
  265.         for i in range(1, 10):
  266.             number = 10 ** i
  267.             
  268.             try:
  269.                 x = t.timeit(number)
  270.             except:
  271.                 t.print_exc()
  272.                 return 1
  273.  
  274.             if verbose:
  275.                 print '%d loops -> %.*g secs' % (number, precision, x)
  276.             
  277.             if x >= 0.20000000000000001:
  278.                 break
  279.                 continue
  280.         
  281.     
  282.     
  283.     try:
  284.         r = t.repeat(repeat, number)
  285.     except:
  286.         t.print_exc()
  287.         return 1
  288.  
  289.     best = min(r)
  290.     if verbose:
  291.         print 'raw times:', []([ '%.*g' % (precision, x) for x in r ])
  292.     
  293.     print '%d loops,' % number,
  294.     usec = best * 1000000.0 / number
  295.     if usec < 1000:
  296.         print 'best of %d: %.*g usec per loop' % (repeat, precision, usec)
  297.     else:
  298.         msec = usec / 1000
  299.         if msec < 1000:
  300.             print 'best of %d: %.*g msec per loop' % (repeat, precision, msec)
  301.         else:
  302.             sec = msec / 1000
  303.             print 'best of %d: %.*g sec per loop' % (repeat, precision, sec)
  304.  
  305. if __name__ == '__main__':
  306.     sys.exit(main())
  307.  
  308.