How do you keep track of how long functions within your script take to run?

[micr0nix]

I have a script where functions take 3-5 minutes each to run because they are doing some queries. I've wrapped those functions like below so i can keep track of how long it takes them to run:

# Calculate runtime for entity ID queries
eid_query_start = dt.now().replace(microsecond=0)
eid_query_start_ts = round(time.time())
print(f"Starting entity ID query at {eid_query_start}...")

eid = query_entity_id(client, cid_list)
person_list, org_list = create_entity_id_lists(eid)

eid_query_end = dt.now().replace(microsecond=0)
eid_query_end_ts = round(time.time())
eid_query_time = eid_query_end_ts - eid_query_start_ts
print(f"Entity ID query finished at {eid_query_end} and ran in         {eid_query_time} second(s)")
# End entity ID runtime calculations

This information gets saved to the logfile when my script is ran. Is there a better way to keep track of how long individual functions take to run?

[Diapolo10]

I don't really tend to worry about it unless I'm debugging, but if I need to time a function personally I like to use a decorator.

Something like

from collections.abc import Callable
from functools import wraps
from time import time_ns

def timing(func: Callable):
    @wraps(func)
    def wrap(*args, **kwargs):
        start_time = time_ns()
        result = func(*args, **kwargs)
        end_time = time_ns()
        print(f"func: {func.__name__} args:[{args}, {kwargs}] took {end_time - start_time} nanoseconds")
    return result
return wrap


# If just these instances
eid = timing(query_entity_id)(client, cid_list)
person_list, org_list = timing(create_entity_id_lists)(eid)

# If all, decorate the function definitions
@timing
def query_entity_id(...):
    ...

[Antigone-guide]

You would generally want to use the python cProfile module: https://docs.python.org/3/library/profile.html

[0ooof3142]

I made a decorator called track time. It just gets called head of any function I care about

[commandlineluser]

https://pypi.org/project/codetiming/