lsst.dax.apdb.timer.Timer Class Reference

Public Member Functions
	__init__ (self, str name, *MonAgent|logging.Logger args, _TagsType|None tags=None, int log_level=logging.INFO)
None	add_values (self, **int|float values)
Timer	start (self)
Timer	stop (self)
Timer	dump (self)
tuple[float, float, float]	accumulated (self)
dict[str, int|float]	as_dict (self, str prefix="")
str	__str__ (self)
Timer	__enter__ (self)
Any	__exit__ (self, type|None exc_type, Any exc_val, Any exc_tb)

Protected Attributes
	_name
	_tags
	_log_level
	_startReal
	_startUser
	_startSys
	_sumReal
	_sumUser
	_sumSys
	_extra_values

Detailed Description

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

Parameters
----------
name : `str`
    Timer name, will be use for reporting to both monitoring and logging.
    Typically the name should look like an identifier for ease of use with
    downstream monitoring software.
*args : `MonAgent` or `logging.Logger`
    Positional arguments can include a combination of `MonAgent` and
    `logging.Logger` instances. They will be used to report accumulated
    times on exit from context or by calling `dump` method directly.
tags : `~collections.abc.Mapping` [`str`, `str` or `int`], optional
    Keyword argument, additional tags added to monitoring report and
    logging output.
log_level : `int`, optional
    Keyword argument, level used for logging output, default is
    `logging.INFO`.

Notes
-----
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", logger):
        engine.execute('SELECT ...')

Definition at line 41 of file timer.py.

Constructor & Destructor Documentation

__init__()

lsst.dax.apdb.timer.Timer.__init__	(		self,
		str	name,
		*MonAgent | logging.Logger	args,
		_TagsType | None	tags = None,
		int	log_level = logging.INFO )

Definition at line 73 of file timer.py.

    ):
        self._name = name
        self._mon_agents: list[MonAgent] = []
        self._loggers: list[logging.Logger] = []
        self._tags = tags
        self._log_level = log_level
 
        for arg in args:
            if isinstance(arg, MonAgent):
                self._mon_agents.append(arg)
            elif isinstance(arg, logging.Logger):
                self._loggers.append(arg)
 
        self._startReal = -1.0
        self._startUser = -1.0
        self._startSys = -1.0
        self._sumReal = 0.0
        self._sumUser = 0.0
        self._sumSys = 0.0
 
        self._extra_values: dict[str, int | float] = {}
 

Member Function Documentation

__enter__()

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

(

self

)

Enter context, start timer

Definition at line 171 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 176 of file timer.py.

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

__str__()

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

(

self

)

Definition at line 162 of file timer.py.

    def __str__(self) -> str:
        real, user, sys = self.accumulated()
        info = "real=%.3f user=%.3f sys=%.3f" % (real, user, sys)
        if self._name:
            info = self._name + ": " + info
        if self._tags:
            info += f" (tags={self._tags})"
        return info
 

accumulated()

tuple[float, float, float] lsst.dax.apdb.timer.Timer.accumulated

(

self

)

Return accumulated real, user, and system times in seconds.

Definition at line 139 of file timer.py.

    def accumulated(self) -> tuple[float, float, float]:
        """Return accumulated real, user, and system times in seconds."""
        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
        return (real, user, sys)
 

add_values()

None lsst.dax.apdb.timer.Timer.add_values	(		self,
		**int | float	values )

Add values to dump together with timing information.

Parameters
----------
**values : int | float
    Key/values to add to timer information.

Definition at line 101 of file timer.py.

    def add_values(self, **values: int | float) -> None:
        """Add values to dump together with timing information.
 
        Parameters
        ----------
        **values : int | float
            Key/values to add to timer information.
        """
        self._extra_values.update(values)
 

as_dict()

dict[str, int | float] lsst.dax.apdb.timer.Timer.as_dict	(		self,
		str	prefix = "" )

Return timers and extra values as dictionary.

Definition at line 151 of file timer.py.

    def as_dict(self, prefix: str = "") -> dict[str, int | float]:
        """Return timers and extra values as dictionary."""
        real, user, sys = self.accumulated()
        values = {
            f"{prefix}real": real,
            f"{prefix}user": user,
            f"{prefix}sys": sys,
        }
        values.update(self._extra_values)
        return values
 

dump()

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

(

self

)

Dump timer statistics

Definition at line 131 of file timer.py.

    def dump(self) -> Timer:
        """Dump timer statistics"""
        for logger in self._loggers:
            logger.log(self._log_level, "%s", self)
        for agent in self._mon_agents:
            agent.add_record(self._name, values=self.as_dict(), tags=self._tags)
        return self
 

start()

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

(

self

)

Start timer.

Definition at line 111 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 119 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

_extra_values

lsst.dax.apdb.timer.Timer._extra_values

protected

Definition at line 159 of file timer.py.

_log_level

lsst.dax.apdb.timer.Timer._log_level

protected

Definition at line 84 of file timer.py.

_name

lsst.dax.apdb.timer.Timer._name

protected

Definition at line 80 of file timer.py.

_startReal

lsst.dax.apdb.timer.Timer._startReal

protected

Definition at line 92 of file timer.py.

_startSys

lsst.dax.apdb.timer.Timer._startSys

protected

Definition at line 94 of file timer.py.

_startUser

lsst.dax.apdb.timer.Timer._startUser

protected

Definition at line 93 of file timer.py.

_sumReal

lsst.dax.apdb.timer.Timer._sumReal

protected

Definition at line 95 of file timer.py.

_sumSys

lsst.dax.apdb.timer.Timer._sumSys

protected

Definition at line 97 of file timer.py.

_sumUser

lsst.dax.apdb.timer.Timer._sumUser

protected

Definition at line 96 of file timer.py.

_tags

lsst.dax.apdb.timer.Timer._tags

protected

Definition at line 83 of file timer.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/dax_apdb/gf3967379c6+02b11634a5/python/lsst/dax/apdb/timer.py