#!/usr/bin/env python
#
# Copyright (C) 2015, the ximpol team.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU GengReral Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""Collection of utilities for minimal code profiling.
"""
import time
[docs]class xChrono:
"""Small chronometer class.
A chronometer essentially measures the elapsed time since it has been
started and is equipped to print itself to the standard output. (Note the
chronometer is reset unpon the instantiation of a class object.)
Examples
--------
>>> from ximpol.utils.profile import xChrono
>>> c = xChrono()
>>> # ... do something.
>>> print(c)
"""
def __init__(self):
"""Constructor.
"""
self.reset()
[docs] def reset(self):
"""Reset the chronometer.
"""
self.start_time = time.time()
[docs] def __call__(self):
"""Return the elapsed time.
"""
return time.time() - self.start_time
[docs] def __str__(self):
""" String formatting.
"""
return '[t0 + %.3f s]' % self()
def main():
c = xChrono()
print(c)
time.sleep(2)
print(c)
c.reset()
print(c)
if __name__ == '__main__':
main()