profile¶
- lsst.utils.timer.profile(filename: str | None, log: LsstLoggers | None = None) Iterator[cProfile.Profile | None] ¶
Profile the enclosed code block and save the result to a file.
- Parameters:
- filename
str
orNone
Filename to which to write profile (profiling disabled if
None
or empty string).- log
logging.Logger
orlsst.utils.logging.LsstLogAdapter
, optional Log object for logging the profile operations.
- filename
- Yields:
Examples
You can obtain the
cProfile.Profile
object using the “as” clause, e.g.:with profile(filename) as prof: runYourCodeHere()
The output cumulative profile can be printed with a command-line like:
python -c 'import pstats; pstats.Stats("<filename>").sort_stats("cumtime").print_stats(30)'