34

I need to have a base class which I will use to inherit other classes which I would like to measure execution time of its functions.

So intead of having something like this:

class Worker():
    def doSomething(self):
        start = time.time()
        ... do something
        elapsed = (time.time() - start)
        print "doSomething() took ", elapsed, " time to finish"

#outputs: doSomething() took XX time to finish

I would like to have something like this:

class Worker(BaseClass):
    def doSomething(self):
        ... do something

#outputs the same: doSomething() took XX time to finish

So the BaseClass needs to dealing with measuring time

pars
  • 3,700
  • 7
  • 38
  • 57

3 Answers3

64

One way to do this would be with a decorator (PEP for decorators) (first of a series of tutorial articles on decorators). Here's an example that does what you want.

from functools import wraps
from time import time

def timed(f):
  @wraps(f)
  def wrapper(*args, **kwds):
    start = time()
    result = f(*args, **kwds)
    elapsed = time() - start
    print "%s took %d time to finish" % (f.__name__, elapsed)
    return result
  return wrapper

This is an example of its use

@timed
def somefunction(countto):
  for i in xrange(countto):
    pass
  return "Done"

To show how it works I called the function from the python prompt:

>>> timedec.somefunction(10000000)
somefunction took 0 time to finish
'Done'
>>> timedec.somefunction(100000000)
somefunction took 2 time to finish
'Done'
>>> timedec.somefunction(1000000000)
somefunction took 22 time to finish
'Done'
Geoff Reedy
  • 34,891
  • 3
  • 56
  • 79
  • Great example of clean code to show how decorators are one of the best joys in Python – André Staltz May 02 '13 at 21:22
  • @ronnieaka I'ts just the module name. I wrote the definitions of `timed` and `somefunction` in timedec.py and imported it from the interpreter to test them. – Geoff Reedy Sep 06 '13 at 19:52
  • Good stuff. Thank you. One thing to share with other people. It makes more sense to measure the execution time in milliseconds. e.g. Geoff's answer worked for me, but I only saw the following. ```abc_function took 0 time to finish```. This change will convert the time to milliseconds ```print "%s took %d milliSeconds to finish" % (f.__name__, elapsed*1000)``` – Cullen SUN Aug 04 '21 at 17:05
10

Have you checked the "profile" module?

I.e. are you sure you need to implement your own custom framework instead of using the default profiling mechanism for the language?

You could also google for "python hotshot" for a similar solution.

p.marino
  • 6,244
  • 3
  • 25
  • 36
6

There is also timeit, which is part of the standard library, and is really easy to use. Remember: don't reinvent the wheel!

jathanism
  • 33,067
  • 9
  • 68
  • 86