~/python/python-timeit-impl-get-method-performance.md

Implementation of Timeit function, Get performance numbers for a function

1 min readJuly 30, 2019by Gorav Singal#python-3#python
// TL;DR

Create a Python decorator that wraps any function to measure its execution time using time.time(), enabling easy performance profiling across your codebase.

Implementation of Timeit function, Get performance numbers for a function

This is regarding the timeit implementation in python. The basic requirement comes when you want to see how much time your methods are taking. And, on the basis on those numbers you would want to take some action in optimising them.

You should use it on almost every method, and you can use any graphical tool to get the statistics per method. And, you can identify the area which needs improvement.

Implementation of timeit

Below is one implementation of timeit functionality, which implements it as a decorator.

"""
Decorator for taking performance numbers
"""
import time

def perf(method):
    """
    A decorator for fetching time taken by methods
    """
    def timed(*args, **kw):
        # get start time
        start_time = time.time()
        
        # calling the method
        result = method(*args, **kw)
        
        # get end time
        end_time = time.time()

        stats = {}
        stats['method'] = f'{method.__module__}::{method.__qualname__}'
        stats['timetaken'] = '%2.2f' % int((end_time-start_time)*1000)

        print(f'Performance numbers, method={stats["method"]}, timetaken={stats["timetaken"]}')
        return result

    return timed

How to use it

@perf
def test1():
    print('Im in method test1')
    time.sleep(2);

test1()

# Output
Performance numbers, method=__main__::test1, timetaken=2001.00

You can change logging with whatever suits you. I have used print(), but you can use logger to log this in your standard log stream.

$ subscribe --weekly

One deep dive a week, in your inbox

System design, AI engineering, trading systems and interview prep. Tested code, real numbers. Free, and you can unsubscribe any time.

or read it on gyanbyte.substack.com

Share

Related Posts

Python SMTP Email Code - How to Send HTML Email from Python Code with Authentication at SMTP Server

Python SMTP Email Code - How to Send HTML Email from Python Code with Authentication at SMTP Server

Introduction This post has the complete code to send email through smtp server…

Python: How to generate string of arbitrary length of any alphabet characters

Python: How to generate string of arbitrary length of any alphabet characters

I was testing a bug where a field was limited to 255 characters only. I needed…

Python Build Quality Gates with Pylint and Unittest Coverage Thresholds

Python Build Quality Gates with Pylint and Unittest Coverage Thresholds

Introduction It is very important to introduce few process so that your code and…

Python - How to Implement Timed-Function which gets Timeout After Specified Max Timeout Value

Python - How to Implement Timed-Function which gets Timeout After Specified Max Timeout Value

Introduction We often require to execute in timed manner, i.e. to specify a max…

How to Solve Circular Import Error in Python

How to Solve Circular Import Error in Python

Introduction To give some context, I have two python files. (Both in same folder…

Python Code - How To Read CSV with Headers into an Array of Dictionary

Python Code - How To Read CSV with Headers into an Array of Dictionary

Introduction Lets assume we have a csv something similar to following: Python…

Latest Posts

How to Stay Valuable as a Software Engineer in the AI Era: A Practical Playbook

How to Stay Valuable as a Software Engineer in the AI Era: A Practical Playbook

In the previous article I argued that AI is not killing software engineering…

How to Review AI-Generated Code: A Checklist for Catching What the Model Missed

How to Review AI-Generated Code: A Checklist for Catching What the Model Missed

A few months back I approved a PR that was almost entirely AI-generated. It…

How to Debug AI-Generated Code: Understand First, Fix Last

How to Debug AI-Generated Code: Understand First, Fix Last

In the last article I wrote about reviewing AI code before it goes in. This one…

The Future of Software Engineering: What AI Changes, What Stays, and Where the Jobs Go

The Future of Software Engineering: What AI Changes, What Stays, and Where the Jobs Go

Every few weeks somebody sends me a scary headline — “AI will replace all…

The Transactional Outbox Pattern: Never Lose an Event Again

The Transactional Outbox Pattern: Never Lose an Event Again

This is one of those patterns that looks like nothing until you get burnt once…

Event Sourcing, Explained: Store What Happened, Not Just the Final State

Event Sourcing, Explained: Store What Happened, Not Just the Final State

Here is a question I like to ask in interviews: your bank account shows a…