lsst.dax.apdb.timer.Timer Class Reference

Public Member Functions
	__init__ (self, str name="", bool doPrint=True)
Timer	start (self)
Timer	stop (self)
Timer	dump (self)
str	__str__ (self)
Timer	__enter__ (self)
Any	__exit__ (self, type|None exc_type, Any exc_val, Any exc_tb)

Protected Attributes
	_name
	_print
	_startReal
	_startUser
	_startSys
	_sumReal
	_sumUser
	_sumSys

Detailed Description

Instance of this class can be used to track consumed time.

This class is also a context manager and can be used in
a `with` statement. By default it prints consumed CPU time
and real time spent in a context.

Example:

    with Timer('SelectTimer'):
        engine.execute('SELECT ...')

Definition at line 38 of file timer.py.

Constructor & Destructor Documentation

__init__()

lsst.dax.apdb.timer.Timer.__init__	(		self,
		str	name = "",
		bool	doPrint = True )

Parameters
----------
name : `str`
    Timer name, will be printed together with statistics.
doPrint : `bool`
    If True then print statistics on exist from context.

Definition at line 53 of file timer.py.

    def __init__(self, name: str = "", doPrint: bool = True):
        """
        Parameters
        ----------
        name : `str`
            Timer name, will be printed together with statistics.
        doPrint : `bool`
            If True then print statistics on exist from context.
        """
        self._name = name
        self._print = doPrint
 
        self._startReal = -1.0
        self._startUser = -1.0
        self._startSys = -1.0
        self._sumReal = 0.0
        self._sumUser = 0.0
        self._sumSys = 0.0
 

Member Function Documentation

__enter__()

Timer lsst.dax.apdb.timer.Timer.__enter__

(

self

)

Enter context, start timer

Definition at line 117 of file timer.py.

    def __enter__(self) -> Timer:
        """
        Enter context, start timer
        """
        self.start()
        return self
 

__exit__()

Any lsst.dax.apdb.timer.Timer.__exit__	(		self,
		type | None	exc_type,
		Any	exc_val,
		Any	exc_tb )

Exit context, stop and dump timer

Definition at line 124 of file timer.py.

    def __exit__(self, exc_type: type | None, exc_val: Any, exc_tb: Any) -> Any:
        """
        Exit context, stop and dump timer
        """
        if exc_type is None:
            self.stop()
            if self._print:
                self.dump()
        return False

__str__()

str lsst.dax.apdb.timer.Timer.__str__

(

self

)

Definition at line 103 of file timer.py.

    def __str__(self) -> str:
        real = self._sumReal
        user = self._sumUser
        sys = self._sumSys
        if self._startReal > 0:
            real += time.time() - self._startReal
            ru = resource.getrusage(resource.RUSAGE_SELF)
            user += ru.ru_utime - self._startUser
            sys += ru.ru_stime - self._startSys
        info = "real=%.3f user=%.3f sys=%.3f" % (real, user, sys)
        if self._name:
            info = self._name + ": " + info
        return info
 

dump()

Timer lsst.dax.apdb.timer.Timer.dump

(

self

)

Dump timer statistics

Definition at line 96 of file timer.py.

    def dump(self) -> Timer:
        """
        Dump timer statistics
        """
        _LOG.info("%s", self)
        return self
 

start()

Timer lsst.dax.apdb.timer.Timer.start

(

self

)

Start timer.

Definition at line 72 of file timer.py.

    def start(self) -> Timer:
        """
        Start timer.
        """
        self._startReal = time.time()
        ru = resource.getrusage(resource.RUSAGE_SELF)
        self._startUser = ru.ru_utime
        self._startSys = ru.ru_stime
        return self
 

stop()

Timer lsst.dax.apdb.timer.Timer.stop

(

self

)

Stop timer.

Definition at line 82 of file timer.py.

    def stop(self) -> Timer:
        """
        Stop timer.
        """
        if self._startReal > 0:
            self._sumReal += time.time() - self._startReal
            ru = resource.getrusage(resource.RUSAGE_SELF)
            self._sumUser += ru.ru_utime - self._startUser
            self._sumSys += ru.ru_stime - self._startSys
            self._startReal = -1.0
            self._startUser = -1.0
            self._startSys = -1.0
        return self
 

Member Data Documentation

_name

lsst.dax.apdb.timer.Timer._name

protected

Definition at line 62 of file timer.py.

_print

lsst.dax.apdb.timer.Timer._print

protected

Definition at line 63 of file timer.py.

_startReal

lsst.dax.apdb.timer.Timer._startReal

protected

Definition at line 65 of file timer.py.

_startSys

lsst.dax.apdb.timer.Timer._startSys

protected

Definition at line 67 of file timer.py.

_startUser

lsst.dax.apdb.timer.Timer._startUser

protected

Definition at line 66 of file timer.py.

_sumReal

lsst.dax.apdb.timer.Timer._sumReal

protected

Definition at line 68 of file timer.py.

_sumSys

lsst.dax.apdb.timer.Timer._sumSys

protected

Definition at line 70 of file timer.py.

_sumUser

lsst.dax.apdb.timer.Timer._sumUser

protected

Definition at line 69 of file timer.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/dax_apdb/g295015adf3+b67ee847e5/python/lsst/dax/apdb/timer.py