Source code for pyradar.utils.timeutils

#!/usr/bin/env python
# -*- coding: utf-8 -*-

# Copyright 2012 - 2013
# Matías Herranz <matiasherranz@gmail.com>
# Joaquín Tita <joaquintita@gmail.com>
#
# https://github.com/PyRadar/pyradar
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.


"""
Utils for calculating time periods for the runs of the algorithms.
"""
from datetime import datetime


[docs]class Timer(object):

    def __init__(self):
        self.start_instant = datetime.now()
        self.stop_instant = None

    def __unicode__(self):
        """
        Docs about timetuple:
        http://docs.python.org/library/datetime.html#datetime.datetime.strftime
        """
        tt = self.start_instant.timetuple()
        return 'Timer started at: hour: %s, min: %s, sec: %s' % \
                                        (tt.tm_hour, tt.tm_min, tt.tm_sec)

[docs]    def restart_timer(self):
        """
        Overwrite the start time of the timer.
        """
        self.start_instant = datetime.now()

[docs]    def stop_timer(self):
        self.stop_instant = datetime.now()

[docs]    def calculate_time_elapsed(self, print_value=False):

        start_time = self.start_instant
        time_now = datetime.now()

        diff = time_now - start_time

        mins = diff.min if diff.min.seconds else 0
        secs = diff.seconds if diff.seconds else 0
        microsecs = diff.microseconds if diff.microseconds else 0

        if secs > 60:
            mins = secs / 60
            secs = secs % 60

        if print_value:
            print "Run took: %s mins, %s secs, %s microsecs." \
                                                % (mins, secs, microsecs)

        time_diff = {'full_diff': diff,
                     'mins': mins,
                     'secs': secs,
                     'microsecs': microsecs,
                    }
        return time_diff