cardinal_pythonlib.timing

---

Original code copyright (C) 2009-2022 Rudolf Cardinal (rudolf@pobox.com).

This file is part of cardinal_pythonlib.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

---

Timers for performance tuning.

class cardinal_pythonlib.timing.MultiTimer(start: bool = True)

Mutually exclusive timing of a set of events.

Maintains a start count and times for a set of named timers.

See example in MultiTimerContext.

Parameters:

start – start the timer immediately?

report() → None

Finish and report to the log.

reset() → None

Reset the timers.

set_timing(timing: bool, reset: bool = False) → None

Manually set the timing parameter, and optionally reset the timers.

Parameters:

• timing – should we be timing?

• reset – reset the timers?

start(name: str, increment_count: bool = True) → None

Start a named timer.

Parameters:

• name – name of the timer

• increment_count – increment the start count for this timer

stop(name: str) → None

Stop a named timer.

Parameters:

name – timer to stop

class cardinal_pythonlib.timing.MultiTimerContext(multitimer: MultiTimer, name: str)

Context manager for MultiTimer.

Example:

import logging
from time import sleep
from cardinal_pythonlib.timing import MultiTimer, MultiTimerContext

timer = MultiTimer(start=True)

def f2():
    with MultiTimerContext(timer, "f2"):
        print("starting f2")
        sleep(1)
        print("finishing f2")

def f1():
    with MultiTimerContext(timer, "f1"):
        print("starting f1")
        sleep(0.25)
        f2()
        f2()
        print("finishing f1")

logging.basicConfig(level=logging.DEBUG)
f1()
timer.report()

Parameters:

• multitimer – MultiTimer to use

• name – name of timer to start as we enter, and stop as we exit