diff --git a/docs/index.rst b/docs/index.rst index 393f81b..cbeaa40 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,7 +31,6 @@ The `modflow-devtools` package provides a set of tools for developing and testin md/download.md md/ostags.md md/zip.md - md/timeit.md .. toctree:: diff --git a/docs/md/timeit.md b/docs/md/timeit.md deleted file mode 100644 index c57ef85..0000000 --- a/docs/md/timeit.md +++ /dev/null @@ -1,17 +0,0 @@ -# `timeit` - -There is a `timeit` decorator function available in the `modflow_devtools.misc` module. Applying it to any function causes a (rough) runtime benchmark to be printed to `stdout` afterwards the function returns. For instance: - -```python -@timeit -def sleep1(): - sleep(0.001) - -sleep1() # prints e.g. "sleep1 took 1.26 ms" -``` - -`timeit` can also directly wrap a function: - -```python -timeit(sleep1)() # prints same as above -``` \ No newline at end of file diff --git a/modflow_devtools/misc.py b/modflow_devtools/misc.py index 284a6ed..7dd9210 100644 --- a/modflow_devtools/misc.py +++ b/modflow_devtools/misc.py @@ -1,10 +1,8 @@ import importlib import socket import sys -import time import traceback from contextlib import contextmanager -from functools import wraps from importlib import metadata from os import PathLike, chdir, environ, getcwd from os.path import basename, normpath @@ -444,38 +442,3 @@ def try_metadata() -> bool: _has_pkg_cache[pkg] = found return _has_pkg_cache[pkg] - - -def timeit(f): - """ - Decorator for estimating runtime of any function. - Prints estimated time to stdout, in milliseconds. - - Parameters - ---------- - f : function - Function to time. - - Notes - ----- - Adapted from https://stackoverflow.com/a/27737385/6514033. - - Returns - ------- - function - The decorated function. - """ - - @wraps(f) - def timed(*args, **kw): - ts = time.time() - res = f(*args, **kw) - te = time.time() - if "log_time" in kw: - name = kw.get("log_name", f.__name__.upper()) - kw["log_time"][name] = int((te - ts) * 1000) - else: - print(f"{f.__name__} took {(te - ts) * 1000:.2f} ms") - return res - - return timed diff --git a/modflow_devtools/test/test_misc.py b/modflow_devtools/test/test_misc.py index b8ebd40..79ea786 100644 --- a/modflow_devtools/test/test_misc.py +++ b/modflow_devtools/test/test_misc.py @@ -1,10 +1,8 @@ import os -import re import shutil from os import environ from pathlib import Path from pprint import pprint -from time import sleep from typing import List import pytest @@ -17,7 +15,6 @@ has_pkg, set_dir, set_env, - timeit, ) @@ -286,24 +283,3 @@ def test_has_pkg(virtualenv): ).strip() == exp ) - - -def test_timeit1(capfd): - def sleep1(): - sleep(0.001) - - timeit(sleep1)() - cap = capfd.readouterr() - print(cap.out) - assert re.match(r"sleep1 took \d+\.\d+ ms", cap.out) - - -def test_timeit2(capfd): - @timeit - def sleep1dec(): - sleep(0.001) - - sleep1dec() - cap = capfd.readouterr() - print(cap.out) - assert re.match(r"sleep1dec took \d+\.\d+ ms", cap.out)