INFR: write a Timer context manager

[mmcky]

There are a lot of code patterns that use a timer such as

start_time = time()
freq = compute_freq(params, key).block_until_ready()
end_time = time()
print(f"Elapsed time: {(end_time - start_time) * 1000:.6f} ms")

We could modernise the QuantEcon timer by writing a simple context manager such as

import time


class Timer:
    def __enter__(self):
        self._enter_time = time.time()

    def __exit__(self, *exc_args):
        self._exit_time = time.time()
        print(f"{self._exit_time - self._enter_time:.2f} seconds elapsed")


if __name__ == "__main__":
    with Timer():
        # ...

that would print the time elapsed using a context manager.

[jstac]

Thanks @mmcky, nice idea.

We should optionally be able to store the returned elapsed time so we can compare across different methods.

[jstac]

It's super helpful to have you looking through the lectures and suggesting global improvements @mmcky

[mmcky]

👍 @jstac -- my thinking here is to update tic and toc and then update the style guide for a broad based improvements and modernisation of the code.

The plan here is to have:

with Timer():
     code_to_time

and then for comparisons

with Timer() as result:
     code_to_time

result # would be the total time elapsed

[jstac]

Perfect, thanks @mmcky !

Great idea to put it in the style guide.

I really hope we can use AI to match the lectures to the style guide over the long run :-)

[mmcky]

@jstac it is almost ready for review 😮 (see #783)