QuantEcon / QuantEcon.py / 35824518239

94%

push

github

DEPR: deprecate Matlab-like tic/tac/toc/loop_timer timers (#786) (#833)

* DEPR: deprecate Matlab-like tic/tac/toc/loop_timer timers (#786)

Emit a DeprecationWarning from the public `tic`, `tac`, `toc` and
`loop_timer` functions, pointing users to the modern `Timer` context
manager and `timeit` function added in #783/#794. Removal is targeted
for v0.12.0.

- `__Timer__.loop_timer` now calls its own methods (`self.tic`/`tac`/
  `toc`) instead of the public wrappers, so a single `loop_timer` call
  emits exactly one warning rather than one per run.
- The warning uses `stacklevel=3` so it is attributed to the user's
  call site rather than the wrapper.
- Added `.. deprecated:: 0.12.0` directives to the module and the
  affected docstrings.
- Added tests asserting each function warns, that `loop_timer` warns
  only once, and that the warning points at the caller.

Note: the original issue mentioned removal in 0.9.*, but the library is
already at v0.11.2, so this targets v0.12.0 instead.

* Update deprecation removal target to v1.0

---------

Co-authored-by: Matt McKay <mmcky@users.noreply.github.com>

10 of 10 new or added lines in 1 file covered. (100.0%)

5515 of 5867 relevant lines covered (94.0%)

0.94 hits per line