nano-dev-utils 0.5.7__py3-none-any.whl → 0.5.8__py3-none-any.whl

nano_dev_utils/timers.py

@@ -12,27 +12,38 @@ class Timer:
         self.verbose = verbose
         self.units = [(1e9, 's'), (1e6, 'ms'), (1e3, 'μs'), (1.0, 'ns')]
 
-    def timeit(self, func: Callable[P, R]) -> Callable[P, R]:
-        """Decorator that times function execution with automatic unit scaling."""
-
-        @wraps(func)
-        def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
-            start = time.perf_counter_ns()
-            result = func(*args, **kwargs)
-            elapsed = time.perf_counter_ns() - start
-
-            value = elapsed
-            unit = 'ns'
-
-            for divisor, unit in self.units:
-                if elapsed >= divisor or unit == 'ns':
-                    value = elapsed / divisor
-                    break
-
-            extra_info = f'{args} {kwargs} ' if self.verbose else ''
-            print(
-                f'{func.__name__} {extra_info}took {value:.{self.precision}f} [{unit}]'
-            )
-            return result
-
-        return wrapper
+    def timeit(
+        self, iterations: int = 1
+    ) -> Callable[[Callable[P, R]], Callable[P, R | None]]:
+        def decorator(func: Callable[P, R]) -> Callable[P, R | None]:
+            """Decorator that times function execution with automatic unit scaling and averaging."""
+
+            @wraps(func)
+            def wrapper(*args: P.args, **kwargs: P.kwargs) -> R | None:
+                total_elapsed = 0
+                result = None
+
+                for _ in range(iterations):
+                    start = time.perf_counter_ns()
+                    result = func(*args, **kwargs)
+                    total_elapsed += time.perf_counter_ns() - start
+
+                avg_elapsed = total_elapsed / iterations
+                value = avg_elapsed
+                unit = 'ns'
+
+                for divisor, unit in self.units:
+                    if avg_elapsed >= divisor or unit == 'ns':
+                        value = avg_elapsed / divisor
+                        break
+
+                extra_info = f'{args} {kwargs} ' if self.verbose else ''
+                iter_info = f' (avg over {iterations} runs)' if iterations > 1 else ''
+                print(
+                    f'{func.__name__} {extra_info}took {value:.{self.precision}f} [{unit}]{iter_info}'
+                )
+                return result
+
+            return wrapper
+
+        return decorator

{nano_dev_utils-0.5.7.dist-info → nano_dev_utils-0.5.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nano_dev_utils
-Version: 0.5.7
+Version: 0.5.8
 Summary: A collection of small Python utilities for developers.
 Project-URL: Homepage, https://github.com/yaronday/nano_utils
 Project-URL: Issues, https://github.com/yaronday/nano_utils/issues
@@ -34,10 +34,12 @@ This module provides a `Timer` class for measuring the execution time of code bl
     * `verbose`: Optionally displays the function's positional arguments (args) and keyword arguments (kwargs).       
        Defaults to `False`.
 
-* **`timeit(self, func: Callable[P, R]) -> Callable[P, R]`**:   
+* **`timeit(
+        self, iterations: int = 1
+    ) -> Callable[[Callable[P, R]], Callable[P, R | None]]`**:   
       Decorator that times function execution with automatic unit scaling.   
     * When the decorated function is called, this decorator records the start and end times,   
-      calculates the total execution time, prints the function name and execution    
+      calculates the average execution time, prints the function name and execution    
       time (optionally including arguments), and returns the result of the original function.
 
 #### Example Usage:
@@ -49,7 +51,7 @@ from nano_dev_utils.timers import Timer
 timer = Timer(precision=6, verbose=True)
 
 
-@timer.timeit
+@timer.timeit()
 def my_function(a, b=10):
   """A sample function."""
   time.sleep(0.1)

nano_dev_utils-0.5.8.dist-info/RECORD

@@ -0,0 +1,8 @@
+nano_dev_utils/__init__.py,sha256=imiI367TPj5s4IFmi-VrKJLbdkIxdIPISNscthoaS9U,454
+nano_dev_utils/dynamic_importer.py,sha256=cm2VwDYSGwhGZNO3uMX-O0LaKtEFtzkPm7BrZW4igG4,911
+nano_dev_utils/release_ports.py,sha256=sgmoPax9Hpcse1rHbBSnDJWTkvV6aWpZ5hQFxBKhGR8,5886
+nano_dev_utils/timers.py,sha256=IiCltOHRkYqfX_IzHQ2Xty4ptITBiaOldFO1HhQ6r_A,1748
+nano_dev_utils-0.5.8.dist-info/METADATA,sha256=KA_vxHbiStc8At1rFrWu2Rt8G_eJzyrRLeb3tYQWfUs,5550
+nano_dev_utils-0.5.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nano_dev_utils-0.5.8.dist-info/licenses/LICENSE,sha256=Muenl7Bw_LdtHZtlOMAP7Kt97gDCq8WWp2605eDWhHU,1089
+nano_dev_utils-0.5.8.dist-info/RECORD,,

nano_dev_utils-0.5.7.dist-info/RECORD

@@ -1,8 +0,0 @@
-nano_dev_utils/__init__.py,sha256=imiI367TPj5s4IFmi-VrKJLbdkIxdIPISNscthoaS9U,454
-nano_dev_utils/dynamic_importer.py,sha256=cm2VwDYSGwhGZNO3uMX-O0LaKtEFtzkPm7BrZW4igG4,911
-nano_dev_utils/release_ports.py,sha256=sgmoPax9Hpcse1rHbBSnDJWTkvV6aWpZ5hQFxBKhGR8,5886
-nano_dev_utils/timers.py,sha256=EJFFU9y5qv9w9mfjtBsrgyCXj7NoBpXH0AzPewFnRa0,1205
-nano_dev_utils-0.5.7.dist-info/METADATA,sha256=NsqOX4UXr2EhEW7qUkLz_5qL95B9PmqTuDLR4NsNkVY,5498
-nano_dev_utils-0.5.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nano_dev_utils-0.5.7.dist-info/licenses/LICENSE,sha256=Muenl7Bw_LdtHZtlOMAP7Kt97gDCq8WWp2605eDWhHU,1089
-nano_dev_utils-0.5.7.dist-info/RECORD,,