#! /usr/bin/env python
"""
Functions for timing other functions/procedures.
"""
__author__ = "Carlos Alberto Gomez Gonzalez"
__all__ = ["time_ini", "timing", "time_fin"]
from datetime import datetime
from .utils_conf import sep
[docs]
def time_ini(verbose=True):
"""
Set and print the time at which the script started.
Returns
-------
start_time : string
Starting time.
"""
start_time = datetime.now()
if verbose:
print(sep)
print("Starting time: " + start_time.strftime("%Y-%m-%d %H:%M:%S"))
print(sep)
return start_time
[docs]
def timing(start_time):
"""
Print the execution time of a script.
It requires the initialization with the function time_ini().
"""
print("Running time: " + str(datetime.now() - start_time))
print(sep)
[docs]
def time_fin(start_time):
"""
Return the execution time of a script.
It requires the initialization with the function time_ini().
"""
return str(datetime.now() - start_time)