nano-dev-utils 0.5.7__tar.gz → 0.5.8__tar.gz

{nano_dev_utils-0.5.7 → nano_dev_utils-0.5.8}/.idea/nano_dev_utils.iml

@@ -1,7 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module type="PYTHON_MODULE" version="4">
   <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+    </content>
     <orderEntry type="jdk" jdkName="Python 3.10 (nano_dev_utils)" jdkType="Python SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>

{nano_dev_utils-0.5.7 → nano_dev_utils-0.5.8}/.idea/workspace.xml

@@ -4,8 +4,11 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="1859e23b-7665-4b92-98cc-65e07a208923" name="Changes" comment="removed [tool.hatch.build]">
+    <list default="true" id="1859e23b-7665-4b92-98cc-65e07a208923" name="Changes" comment="corrected return types - complete">
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/pyproject.toml" beforeDir="false" afterPath="$PROJECT_DIR$/pyproject.toml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/nano_dev_utils/timers.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/nano_dev_utils/timers.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/tests/test_timer.py" beforeDir="false" afterPath="$PROJECT_DIR$/tests/test_timer.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -15,7 +18,7 @@
   <component name="Git.Settings">
     <option name="RECENT_BRANCH_BY_REPOSITORY">
       <map>
-        <entry key="$PROJECT_DIR$" value="yd_pre-commit" />
+        <entry key="$PROJECT_DIR$" value="FI" />
       </map>
     </option>
     <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
@@ -32,7 +35,9 @@
   </component>
   <component name="PropertiesComponent"><![CDATA[{
   "keyToString": {
+    "Python tests.Python tests in test_timer.py.executor": "Run",
     "Python tests.Python tests in tests.executor": "Run",
+    "Python.test_timer.executor": "Run",
     "RunOnceActivity.ShowReadmeOnStart": "true",
     "git-widget-placeholder": "master",
     "ignore.virus.scanning.warn.message": "true",
@@ -45,7 +50,44 @@
       <recent name="C:\GitHubWS\nano_dev_utils" />
     </key>
   </component>
-  <component name="RunManager">
+  <component name="RunManager" selected="Python tests.Python tests in tests">
+    <configuration name="test_timer" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
+      <module name="nano_dev_utils" />
+      <option name="ENV_FILES" value="" />
+      <option name="INTERPRETER_OPTIONS" value="" />
+      <option name="PARENT_ENVS" value="true" />
+      <envs>
+        <env name="PYTHONUNBUFFERED" value="1" />
+      </envs>
+      <option name="SDK_HOME" value="" />
+      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/tests" />
+      <option name="IS_MODULE_SDK" value="true" />
+      <option name="ADD_CONTENT_ROOTS" value="true" />
+      <option name="ADD_SOURCE_ROOTS" value="true" />
+      <option name="SCRIPT_NAME" value="$PROJECT_DIR$/tests/test_timer.py" />
+      <option name="PARAMETERS" value="" />
+      <option name="SHOW_COMMAND_LINE" value="false" />
+      <option name="EMULATE_TERMINAL" value="false" />
+      <option name="MODULE_MODE" value="false" />
+      <option name="REDIRECT_INPUT" value="false" />
+      <option name="INPUT_FILE" value="" />
+      <method v="2" />
+    </configuration>
+    <configuration name="Python tests in test_timer.py" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
+      <module name="nano_dev_utils" />
+      <option name="ENV_FILES" value="" />
+      <option name="INTERPRETER_OPTIONS" value="" />
+      <option name="PARENT_ENVS" value="true" />
+      <option name="SDK_HOME" value="" />
+      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/tests" />
+      <option name="IS_MODULE_SDK" value="true" />
+      <option name="ADD_CONTENT_ROOTS" value="true" />
+      <option name="ADD_SOURCE_ROOTS" value="true" />
+      <option name="_new_additionalArguments" value="&quot;&quot;" />
+      <option name="_new_target" value="&quot;$PROJECT_DIR$/tests/test_timer.py&quot;" />
+      <option name="_new_targetType" value="&quot;PATH&quot;" />
+      <method v="2" />
+    </configuration>
     <configuration name="Python tests in tests" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="nano_dev_utils" />
       <option name="ENV_FILES" value="" />
@@ -64,6 +106,9 @@
     <recent_temporary>
       <list>
         <item itemvalue="Python tests.Python tests in tests" />
+        <item itemvalue="Python tests.Python tests in tests" />
+        <item itemvalue="Python tests.Python tests in test_timer.py" />
+        <item itemvalue="Python.test_timer" />
       </list>
     </recent_temporary>
   </component>
@@ -139,9 +184,52 @@
       <option name="project" value="LOCAL" />
       <updated>1747321637844</updated>
     </task>
-    <option name="localTasksCounter" value="8" />
+    <task id="LOCAL-00008" summary="+iterations parameter">
+      <option name="closed" value="true" />
+      <created>1747660086270</created>
+      <option name="number" value="00008" />
+      <option name="presentableId" value="LOCAL-00008" />
+      <option name="project" value="LOCAL" />
+      <updated>1747660086270</updated>
+    </task>
+    <task id="LOCAL-00009" summary="minor update">
+      <option name="closed" value="true" />
+      <created>1747661192289</created>
+      <option name="number" value="00009" />
+      <option name="presentableId" value="LOCAL-00009" />
+      <option name="project" value="LOCAL" />
+      <updated>1747661192289</updated>
+    </task>
+    <task id="LOCAL-00010" summary="corrected return type">
+      <option name="closed" value="true" />
+      <created>1747665494128</created>
+      <option name="number" value="00010" />
+      <option name="presentableId" value="LOCAL-00010" />
+      <option name="project" value="LOCAL" />
+      <updated>1747665494128</updated>
+    </task>
+    <task id="LOCAL-00011" summary="corrected return types - complete">
+      <option name="closed" value="true" />
+      <created>1747666293914</created>
+      <option name="number" value="00011" />
+      <option name="presentableId" value="LOCAL-00011" />
+      <option name="project" value="LOCAL" />
+      <updated>1747666293914</updated>
+    </task>
+    <option name="localTasksCounter" value="12" />
     <servers />
   </component>
+  <component name="Vcs.Log.Tabs.Properties">
+    <option name="TAB_STATES">
+      <map>
+        <entry key="MAIN">
+          <value>
+            <State />
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
   <component name="VcsManagerConfiguration">
     <MESSAGE value="." />
     <MESSAGE value="license relative path" />
@@ -150,6 +238,10 @@
     <MESSAGE value="adding license url" />
     <MESSAGE value="+pre-commit config" />
     <MESSAGE value="removed [tool.hatch.build]" />
-    <option name="LAST_COMMIT_MESSAGE" value="removed [tool.hatch.build]" />
+    <MESSAGE value="+iterations parameter" />
+    <MESSAGE value="minor update" />
+    <MESSAGE value="corrected return type" />
+    <MESSAGE value="corrected return types - complete" />
+    <option name="LAST_COMMIT_MESSAGE" value="corrected return types - complete" />
   </component>
 </project>

{nano_dev_utils-0.5.7 → nano_dev_utils-0.5.8}/PKG-INFO

@@ -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.7 → nano_dev_utils-0.5.8}/README.md

@@ -16,10 +16,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:
@@ -31,7 +33,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.7 → nano_dev_utils-0.5.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nano_dev_utils"
-version = "0.5.7"
+version = "0.5.8"
 
 authors = [
   { name="Yaron Dayan", email="yaronday77@gmail.com" },

nano_dev_utils-0.5.8/src/nano_dev_utils/timers.py

@@ -0,0 +1,49 @@
+from functools import wraps
+import time
+from typing import Callable, ParamSpec, TypeVar
+
+P = ParamSpec('P')
+R = TypeVar('R')
+
+
+class Timer:
+    def __init__(self, precision=4, verbose=False):
+        self.precision = precision
+        self.verbose = verbose
+        self.units = [(1e9, 's'), (1e6, 'ms'), (1e3, 'μs'), (1.0, 'ns')]
+
+    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 → nano_dev_utils-0.5.8}/tests/test_timer.py

@@ -18,7 +18,7 @@ def test_timeit_simple(mocker):
     mock_time = mocker.patch('time.perf_counter_ns', side_effect=[0, 9.23467e5])
     timer = Timer(precision=2)
 
-    @timer.timeit
+    @timer.timeit()
     def sample_function():
         return 'result'
 
@@ -33,7 +33,7 @@ def test_timeit_no_args_kwargs(mocker):
     mock_time = mocker.patch('time.perf_counter_ns', side_effect=[1.0, 1.5])
     timer = Timer(precision=2, verbose=True)
 
-    @timer.timeit
+    @timer.timeit()
     def yet_another_function():
         return 'yet another result'
 
@@ -49,7 +49,7 @@ def test_multithreaded_timing(mocker):
     timer = Timer()
     results = []
 
-    @timer.timeit
+    @timer.timeit()
     def threaded_operation():
         time.sleep(0.1)
         return threading.get_ident()
@@ -77,7 +77,7 @@ def test_verbose_mode(mocker):
     mocker.patch('time.perf_counter_ns', side_effect=[1e4, 5.23456e4])
     verbose_timer = Timer(verbose=True)
 
-    @verbose_timer.timeit
+    @verbose_timer.timeit()
     def func_with_args(a, b, c=3):
         return a + b + c
 
@@ -96,9 +96,9 @@ def test_nested_timers(mocker):
     mock_print = mocker.patch('builtins.print')
     timer = Timer()
 
-    @timer.timeit
+    @timer.timeit()
     def outer():
-        @timer.timeit
+        @timer.timeit()
         def inner():
             time.sleep(0.1)
 
@@ -134,7 +134,7 @@ def test_unit_scaling(mocker):
         mocker.patch('time.perf_counter_ns', side_effect=[0, ns])
         timer = Timer(precision=2)
 
-        @timer.timeit
+        @timer.timeit()
         def dummy():
             pass
 
@@ -150,10 +150,32 @@ def test_function_metadata_preserved():
     """Test that function metadata (name, docstring) is preserved"""
     timer = Timer(precision=3)
 
-    @timer.timeit
+    @timer.timeit()
     def dummy_func():
         """Test docstring"""
         pass
 
     assert dummy_func.__name__ == 'dummy_func'
     assert dummy_func.__doc__ == 'Test docstring'
+
+
+def test_timeit_with_iterations(mocker):
+    mock_print = mocker.patch('builtins.print')
+    mock_time = mocker.patch(
+        'time.perf_counter_ns', side_effect=[0, 1000, 0, 2000, 0, 3000]
+    )
+
+    timer = Timer(precision=2)
+
+    @timer.timeit(iterations=3)
+    def sample_function():
+        return 'done'
+
+    result = sample_function()
+
+    assert result == 'done'
+    mock_time.assert_any_call()
+
+    mock_print.assert_called_once_with(
+        'sample_function took 2.00 [μs] (avg over 3 runs)'
+    )

nano_dev_utils-0.5.7/src/nano_dev_utils/timers.py

@@ -1,38 +0,0 @@
-from functools import wraps
-import time
-from typing import Callable, ParamSpec, TypeVar
-
-P = ParamSpec('P')
-R = TypeVar('R')
-
-
-class Timer:
-    def __init__(self, precision=4, verbose=False):
-        self.precision = precision
-        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