Merge pull request #42 from ayasyrev/dev

0.2.4

Author: ayasyrev

.flake8

@@ -2,7 +2,8 @@
 select = C,E,F,W
 max-complexity = 10
 max-line-length = 120
-
+extend-ignore = W503
+disable-noqa = True
 application-import-names = benchmark_utils, tests
 import-order-style = google
 

.github/workflows/coverage.yml

@@ -8,12 +8,12 @@ jobs:
   coverage:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v1
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v2
       with:
-        python-version: "3.10"
+        python-version: "3.11"
         architecture: x64
     - run: pip install nox
-    - run: nox -f noxfile_cov.py -p "3.10"
+    - run: nox -f noxfile_cov.py -p "3.11"
       env:
         CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

.github/workflows/deploy_docs.yml

@@ -8,7 +8,7 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x

.github/workflows/lint.yml

@@ -8,10 +8,10 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v1
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v2
       with:
-        python-version: "3.10"
+        python-version: "3.11"
         architecture: x64
     - run: pip install nox
-    - run: nox -p "3.10" -f noxfile_lint.py
+    - run: nox -p "3.11" -f noxfile_lint.py

.github/workflows/tests.yml

@@ -9,11 +9,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python: ["3.8", "3.9", "3.10", "3.11",]
     name: Python ${{ matrix.python }}
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v1
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python }}
         architecture: x64

README.md

@@ -6,7 +6,7 @@ Utils for benchmark - wrapper over python timeit.
 [![PyPI Status](https://badge.fury.io/py/benchmark-utils.svg)](https://badge.fury.io/py/benchmark-utils)  
 [![Tests](https://github.com/ayasyrev/benchmark_utils/workflows/Tests/badge.svg)](https://github.com/ayasyrev/benchmark_utils/actions?workflow=Tests)  [![Codecov](https://codecov.io/gh/ayasyrev/benchmark_utils/branch/main/graph/badge.svg)](https://codecov.io/gh/ayasyrev/benchmark_utils)  
 
-Tested on python 3.7 - 3.11
+Tested on python 3.7 - 3.12
 
 ## Install
 
@@ -20,12 +20,13 @@ Or install from github repo:
 
 ## Basic use.
 
-Lets benchmark some (dump) functions.
+Lets benchmark some (dummy) functions.
 
 
 ```python
 from time import sleep
 
+
 def func_to_test_1(sleep_time: float = 0.1, mult: int = 1) -> None:
     """simple 'sleep' func for test"""
     sleep(sleep_time * mult)
@@ -34,7 +35,6 @@ def func_to_test_1(sleep_time: float = 0.1, mult: int = 1) -> None:
 def func_to_test_2(sleep_time: float = 0.11, mult: int = 1) -> None:
     """simple 'sleep' func for test"""
     sleep(sleep_time * mult)
-
 ```
 
 Let's create benchmark.
@@ -56,7 +56,9 @@ bench = Benchmark(
 bench
 ```
 <details open> <summary>output</summary>  
-    <pre>Benchmark(func_to_test_1, func_to_test_2)</pre>
+    <pre>
+    Benchmark(func_to_test_1, func_to_test_2)
+    </pre>
 </details>
 
 
@@ -65,6 +67,7 @@ Now we can benchmark that functions.
 
 
 ```python
+# we can run bench.run() or just:
 bench()
 ```
 <details open> <summary>output</summary>  
@@ -80,7 +83,7 @@ bench()
 
 
 
-<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">func_to_test_2:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.11</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">-9.6</span>%
+<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">func_to_test_2:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.11</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">-8.9</span>%
 </pre>
 
 </details>
@@ -105,7 +108,7 @@ bench.run(num_repeats=10)
 
 
 
-<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">func_to_test_2:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.11</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">-8.8</span>%
+<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">func_to_test_2:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.11</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">-9.3</span>%
 </pre>
 
 </details>
@@ -130,30 +133,33 @@ bench.print_results(reverse=True)
 
 
 
-<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">func_to_test_1:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.10</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">9.7</span>%
+<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace">func_to_test_1:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.10</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">10.2</span>%
 </pre>
 
 </details>
 
 
-We can add functions to bencmark as list of funtions (or partial) ar as dictionary: `{"name": function}`.
+We can add functions to benchmark as list of functions (or partial) or as dictionary: `{"name": function}`.
 
 
 ```python
-bench = Benchmark([
-    func_to_test_1,
-    partial(func_to_test_1, 0.12),
-    partial(func_to_test_1, sleep_time=0.11),
-])
-
+bench = Benchmark(
+    [
+        func_to_test_1,
+        partial(func_to_test_1, 0.12),
+        partial(func_to_test_1, sleep_time=0.11),
+    ]
+)
 ```
 
 
 ```python
 bench
 ```
 <details open> <summary>output</summary>  
-    <pre>Benchmark(func_to_test_1, func_to_test_1(0.12), func_to_test_1(sleep_time=0.11))</pre>
+    <pre>
+    Benchmark(func_to_test_1, func_to_test_1(0.12), func_to_test_1(sleep_time=0.11))
+    </pre>
 </details>
 
 
@@ -175,32 +181,132 @@ bench.run()
 
 
 
-<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"><span style="color: #800080; text-decoration-color: #800080; font-weight: bold">func_to_test_1</span><span style="font-weight: bold">(</span><span style="color: #808000; text-decoration-color: #808000">sleep_time</span>=<span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.11</span><span style="font-weight: bold">)</span>:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.11</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">-8.9</span>%
+<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"><span style="color: #800080; text-decoration-color: #800080; font-weight: bold">func_to_test_1</span><span style="font-weight: bold">(</span><span style="color: #808000; text-decoration-color: #808000">sleep_time</span>=<span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.11</span><span style="font-weight: bold">)</span>:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.11</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">-8.8</span>%
 </pre>
 
 
 
 
-<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"><span style="color: #800080; text-decoration-color: #800080; font-weight: bold">func_to_test_1</span><span style="font-weight: bold">(</span><span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.12</span><span style="font-weight: bold">)</span>:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.12</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">-16.5</span>%
+<pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"><span style="color: #800080; text-decoration-color: #800080; font-weight: bold">func_to_test_1</span><span style="font-weight: bold">(</span><span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.12</span><span style="font-weight: bold">)</span>:   <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">0.12</span> <span style="color: #008080; text-decoration-color: #008080; font-weight: bold">-16.4</span>%
 </pre>
 
 </details>
 
 
 
 ```python
-bench = Benchmark({
-    "func_1": func_to_test_1,
-    "func_2": func_to_test_2,
-})
+bench = Benchmark(
+    {
+        "func_1": func_to_test_1,
+        "func_2": func_to_test_2,
+    }
+)
 ```
 
 
 ```python
 bench
 ```
 <details open> <summary>output</summary>  
-    <pre>Benchmark(func_1, func_2)</pre>
+    <pre>
+    Benchmark(func_1, func_2)
+    </pre>
+</details>
+
+
+
+When we run benchmark script in terminal, we got pretty progress thanks to rich. Lets run example_1.py from example folder:
+
+![exaple_1](images/run_example_1.gif)
+
+# BenchmarkIter
+
+With BenchmarkIter we can benchmark functions over iterables, for example read list of files or run functions with different arguments.
+
+
+```python
+def func_to_test_1(x: int) -> None:
+    """simple 'sleep' func for test"""
+    sleep(0.01)
+
+
+def func_to_test_2(x: int) -> None:
+    """simple 'sleep' func for test"""
+    sleep(0.015)
+
+
+dummy_params = list(range(10))
+```
+
+
+```python
+from benchmark_utils import BenchmarkIter
+
+bench = BenchmarkIter(
+    func=[func_to_test_1, func_to_test_2],
+    item_list=dummy_params,
+)
+```
+
+
+```python
+bench()
+```
+<details open> <summary>output</summary>  
+    <pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"> Func name  | Items/sec
+</pre>
+
+</details>
+
+
+
+
+
+
+
+
+
+
+We can run it again, all functions, some of it, exclude some and change number of repeats.
+And we can limit number of items with `num_samples` argument:
+`bench.run(num_samples=5)`
+
+# Multiprocessing
+
+By default we tun functions in one thread.  
+But we can use multiprocessing with `multiprocessing=True` argument:
+`bench.run(multiprocessing=True)`
+It will use all available cpu cores.
+And we can use `num_workers` argument to limit used cpu cores:
+`bench.run(multiprocessing=True, num_workers=2)`
+
+
+```python
+bench.run(multiprocessing=True, num_workers=2)
+```
+<details open> <summary>output</summary>  
+    <pre style="white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace"> Func name  | Items/sec
+</pre>
+
+</details>
+
+
+
+
+
+
+
+
+
+
+
+```python
+0.1022316165981465 / 0.09319195459829643
+```
+<details open> <summary>output</summary>  
+    <pre>
+    1.0970004550158379
+    </pre>
 </details>