22 """Utilities for measuring execution time.
24 __all__ = [
"logInfo",
"timeMethod"]
35 """Log ``(name, value)`` pairs to ``obj.metadata`` and ``obj.log``
39 obj : `lsst.pipe.base.Task`-type
40 A `~lsst.pipe.base.Task` or any other object with these two attributes:
42 - ``metadata`` an instance of `lsst.daf.base.PropertyList`` (or other object with
43 ``add(name, value)`` method).
44 - ``log`` an instance of `lsst.log.Log`.
47 A sequence of ``(name, value)`` pairs, with value typically numeric.
49 Log level (an `lsst.log` level constant, such as `lsst.log.Log.DEBUG`).
52 for name, value
in pairs:
55 obj.metadata.addLongLong(name, value)
57 obj.metadata.add(name, value)
58 strList.append(f
"{name}={value}")
59 log(
"timer." + obj.log.getName(), logLevel,
"; ".join(strList))
62 def logInfo(obj, prefix, logLevel=Log.DEBUG):
63 """Log timer information to ``obj.metadata`` and ``obj.log``.
67 obj : `lsst.pipe.base.Task`-type
68 A `~lsst.pipe.base.Task` or any other object with these two attributes:
70 - ``metadata`` an instance of `lsst.daf.base.PropertyList`` (or other object with
71 ``add(name, value)`` method).
72 - ``log`` an instance of `lsst.log.Log`.
75 Name prefix, the resulting entries are ``CpuTime``, etc.. For example timeMethod uses
76 ``prefix = Start`` when the method begins and ``prefix = End`` when the method ends.
78 Log level (an `lsst.log` level constant, such as `lsst.log.Log.DEBUG`).
84 - ``Utc``: UTC date in ISO format (only in metadata since log entries have timestamps).
85 - ``CpuTime``: System + User CPU time (seconds). This should only be used
86 in differential measurements; the time reference point is undefined.
87 - ``MaxRss``: maximum resident set size.
89 All logged resource information is only for the current process; child processes are excluded.
91 cpuTime = time.process_time()
92 utcStr = datetime.datetime.utcnow().isoformat()
93 res = resource.getrusage(resource.RUSAGE_SELF)
94 obj.metadata.add(name=prefix +
"Utc", value=utcStr)
97 (prefix +
"CpuTime", cpuTime),
98 (prefix +
"UserTime", res.ru_utime),
99 (prefix +
"SystemTime", res.ru_stime),
100 (prefix +
"MaxResidentSetSize", int(res.ru_maxrss)),
101 (prefix +
"MinorPageFaults", int(res.ru_minflt)),
102 (prefix +
"MajorPageFaults", int(res.ru_majflt)),
103 (prefix +
"BlockInputs", int(res.ru_inblock)),
104 (prefix +
"BlockOutputs", int(res.ru_oublock)),
105 (prefix +
"VoluntaryContextSwitches", int(res.ru_nvcsw)),
106 (prefix +
"InvoluntaryContextSwitches", int(res.ru_nivcsw)),
113 """Decorator to measure duration of a task method.
122 Writes various measures of time and possibly memory usage to the task's metadata; all items are prefixed
123 with the function name.
127 This decorator only works with instance methods of Task, or any class with these attributes:
129 - ``metadata``: an instance of `lsst.daf.base.PropertyList` (or other object with
130 ``add(name, value)`` method).
131 - ``log``: an instance of `lsst.log.Log`.
137 import lsst.pipe.base as pipeBase
138 class FooTask(pipeBase.Task):
142 def run(self, ...): # or any other instance method you want to time
146 @functools.wraps(func)
147 def wrapper(self, *args, **keyArgs):
148 logInfo(obj=self, prefix=func.__name__ +
"Start")
150 res = func(self, *args, **keyArgs)
152 logInfo(obj=self, prefix=func.__name__ +
"End")