logInfo

lsst.pipe.base.logInfo(obj, prefix, logLevel=10, metadata=None, logger=None)

Log timer information to obj.metadata and obj.log.

Parameters:
obj : lsst.pipe.base.Task-type or None

A Task or any other object with these two attributes:

  • metadata an instance of lsst.daf.base.PropertyList` (or other object with add(name, value) method).
  • log an instance of logging.Logger or subclass.

If None, at least one of metadata or logger should be passed or this function will do nothing.

prefix : str

Name prefix, the resulting entries are CpuTime, etc.. For example timeMethod uses prefix = Start when the method begins and prefix = End when the method ends.

logLevel : int, optional

Log level (an logging level constant, such as logging.DEBUG).

metadata : lsst.daf.base.PropertyList, optional

Metadata object to write entries to, overriding obj.metadata.

logger : logging.Logger

Log object to write entries to, overriding obj.log.

Deprecated since version v24: logInfo has been replaced by lsst.utils.timer.logInfo. Will be removed after v25.