timer-for-python 0.9.1__tar.gz → 0.9.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. {timer_for_python-0.9.1/src/timer_for_python.egg-info → timer_for_python-0.9.3}/PKG-INFO +4 -4
  2. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/README.md +1 -1
  3. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/setup.cfg +3 -3
  4. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/decorator/function.py +28 -2
  5. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/error/__init__.py +2 -2
  6. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/helper/decimals.py +1 -1
  7. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/helper/thread/list.py +3 -3
  8. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/model/thread_item.py +1 -1
  9. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/model/timer.py +14 -14
  10. timer_for_python-0.9.3/src/timer/model/timer_base.py +32 -0
  11. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/version.py +1 -1
  12. {timer_for_python-0.9.1 → timer_for_python-0.9.3/src/timer_for_python.egg-info}/PKG-INFO +4 -4
  13. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer_for_python.egg-info/requires.txt +2 -2
  14. timer_for_python-0.9.1/src/timer/model/timer_base.py +0 -25
  15. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/LICENSE.md +0 -0
  16. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/MANIFEST.in +0 -0
  17. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/pyproject.toml +0 -0
  18. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/__init__.py +0 -0
  19. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/constant/__init__.py +0 -0
  20. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/constant/decimals.py +0 -0
  21. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/constant/various.py +0 -0
  22. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/controller/__init__.py +0 -0
  23. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/decorator/__init__.py +0 -0
  24. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/helper/__init__.py +0 -0
  25. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/helper/output.py +0 -0
  26. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/helper/thread/__init__.py +0 -0
  27. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/helper/time_fractions.py +0 -0
  28. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/model/__init__.py +0 -0
  29. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/model/abc/mkdocstrings.py +0 -0
  30. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/model/elapsed_time_fractions.py +0 -0
  31. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/model/time_fractions.py +0 -0
  32. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer/py.typed +0 -0
  33. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer_for_python.egg-info/SOURCES.txt +0 -0
  34. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer_for_python.egg-info/dependency_links.txt +0 -0
  35. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer_for_python.egg-info/not-zip-safe +0 -0
  36. {timer_for_python-0.9.1 → timer_for_python-0.9.3}/src/timer_for_python.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: timer-for-python
3
- Version: 0.9.1
3
+ Version: 0.9.3
4
4
  Summary: Timer for Python
5
5
  Home-page: https://jakob-bagterp.github.io/timer-for-python/
6
6
  Download-URL: https://pypi.org/project/timer-for-python/
@@ -27,15 +27,15 @@ Description-Content-Type: text/markdown
27
27
  License-File: LICENSE.md
28
28
  Requires-Dist: colorist==1.8.3
29
29
  Provides-Extra: testing
30
- Requires-Dist: coverage==7.6.8; extra == "testing"
30
+ Requires-Dist: coverage==7.6.9; extra == "testing"
31
31
  Requires-Dist: flake8==7.1.1; extra == "testing"
32
32
  Requires-Dist: mypy==1.13.0; extra == "testing"
33
- Requires-Dist: numpy==2.1.3; extra == "testing"
33
+ Requires-Dist: numpy==2.2.0; extra == "testing"
34
34
  Requires-Dist: pytest==8.3.4; extra == "testing"
35
35
  Requires-Dist: pytest-cov==6.0.0; extra == "testing"
36
36
  Requires-Dist: tox==4.23.2; extra == "testing"
37
37
 
38
- [![Latest version](https://img.shields.io/static/v1?label=version&message=0.9.1&color=yellowgreen)](https://github.com/jakob-bagterp/timer-for-python/releases/latest)
38
+ [![Latest version](https://img.shields.io/static/v1?label=version&message=0.9.3&color=yellowgreen)](https://github.com/jakob-bagterp/timer-for-python/releases/latest)
39
39
  [![Python 3.10 | 3.11 | 3.12 | 3.13+](https://img.shields.io/static/v1?label=python&message=3.10%20|%203.11%20|%203.12%20|%203.13%2B&color=blueviolet)](https://www.python.org)
40
40
  [![MIT license](https://img.shields.io/static/v1?label=license&message=MIT&color=blue)](https://github.com/jakob-bagterp/timer-for-python/blob/master/LICENSE.md)
41
41
  [![Codecov](https://codecov.io/gh/jakob-bagterp/timer-for-python/branch/master/graph/badge.svg?token=P4IT8WQO0R)](https://codecov.io/gh/jakob-bagterp/timer-for-python)
@@ -1,4 +1,4 @@
1
- [![Latest version](https://img.shields.io/static/v1?label=version&message=0.9.1&color=yellowgreen)](https://github.com/jakob-bagterp/timer-for-python/releases/latest)
1
+ [![Latest version](https://img.shields.io/static/v1?label=version&message=0.9.3&color=yellowgreen)](https://github.com/jakob-bagterp/timer-for-python/releases/latest)
2
2
  [![Python 3.10 | 3.11 | 3.12 | 3.13+](https://img.shields.io/static/v1?label=python&message=3.10%20|%203.11%20|%203.12%20|%203.13%2B&color=blueviolet)](https://www.python.org)
3
3
  [![MIT license](https://img.shields.io/static/v1?label=license&message=MIT&color=blue)](https://github.com/jakob-bagterp/timer-for-python/blob/master/LICENSE.md)
4
4
  [![Codecov](https://codecov.io/gh/jakob-bagterp/timer-for-python/branch/master/graph/badge.svg?token=P4IT8WQO0R)](https://codecov.io/gh/jakob-bagterp/timer-for-python)
@@ -1,6 +1,6 @@
1
1
  [metadata]
2
2
  name = timer-for-python
3
- version = 0.9.1
3
+ version = 0.9.3
4
4
  author = Jakob Bagterp
5
5
  author_email = jakob_bagterp@hotmail.com
6
6
  maintainer = Jakob Bagterp
@@ -44,10 +44,10 @@ include_package_data = True
44
44
 
45
45
  [options.extras_require]
46
46
  testing =
47
- coverage==7.6.8
47
+ coverage==7.6.9
48
48
  flake8==7.1.1
49
49
  mypy==1.13.0
50
- numpy==2.1.3
50
+ numpy==2.2.0
51
51
  pytest==8.3.4
52
52
  pytest-cov==6.0.0
53
53
  tox==4.23.2
@@ -9,10 +9,20 @@ from ..model.timer import Timer
9
9
  def function_timer(thread: str | None = None, decimals: int = 2) -> Callable[..., Any]:
10
10
  """Function decorator to measure the performance of a function."""
11
11
 
12
+ def get_function_with_arguments_as_thread_name(function: Callable[..., Any], args: tuple[Any, ...], kwargs: dict[str, Any]) -> str:
13
+ thread_name = function.__name__
14
+ if args or kwargs:
15
+ arg_names = function.__code__.co_varnames[:function.__code__.co_argcount]
16
+ mapped_args = [f"{name}={value!r}" for name, value in zip(arg_names, args)]
17
+ mapped_kwargs = [f"{key}={value!r}" for key, value in kwargs.items()]
18
+ all_mapped_args = ", ".join(mapped_args + mapped_kwargs)
19
+ thread_name += f"({all_mapped_args})"
20
+ return thread_name
21
+
12
22
  def decorator(function: Callable[..., Any]) -> Callable[..., Any]:
13
23
  @functools.wraps(function)
14
24
  def wrapper(*args: Any, **kwargs: Any) -> Any:
15
- thread_name = thread if thread else function.__name__
25
+ thread_name = thread if thread else get_function_with_arguments_as_thread_name(function, args, kwargs)
16
26
  with Timer(thread=thread_name, decimals=decimals):
17
27
  return function(*args, **kwargs)
18
28
  return wrapper
@@ -59,6 +69,22 @@ class MkDocstringsWrapper(MkDocstringsWrapper_ABC):
59
69
  How it appears in the terminal:
60
70
 
61
71
  <pre><code>% Elapsed time: 0.12345 seconds for thread <span class="fg-green">CUSTOM</span></code></pre>
72
+
73
+ The `@function_timer` automatically names the function and its arguments as thread name. For example:
74
+
75
+ ```python linenums="1" hl_lines="3-4"
76
+ from timer import function_timer
77
+
78
+ @function_timer()
79
+ def sum_numbers(a, b):
80
+ return a + b
81
+
82
+ sum_numbers(1, 2)
83
+ ```
84
+
85
+ How it appears in the terminal:
86
+
87
+ <pre><code>% Elapsed time: 0.12 seconds for thread <span class="fg-green">SUM_NUMBERS(A=1, B=2)</span></code></pre>
62
88
  """
63
89
 
64
- return function_timer(thread=thread, decimals=decimals)
90
+ return function_timer(thread=thread, decimals=decimals) # pragma: no cover
@@ -18,8 +18,8 @@ def stop_controller(timer: TimerBase, thread: str | None) -> None:
18
18
  print(f"{Color.YELLOW}Timer is not running. Use .start() to start it.{Color.OFF}")
19
19
  else:
20
20
  print(f"{Color.YELLOW}Timer for thread {thread} is not running. Use .start({thread=}) to start it.{Color.OFF}")
21
- if len(timer.threads) > 0:
22
- open_threads = [thread_item.name for thread_item in timer.threads]
21
+ if len(timer._threads) > 0:
22
+ open_threads = [thread_item.name for thread_item in timer._threads]
23
23
  print(f"Or maybe you aren't stopping the right thread? Currently open threads: {', '.join(open_threads)}")
24
24
 
25
25
 
@@ -8,7 +8,7 @@ from ..model.timer_base import TimerBase
8
8
  def mediate(timer: TimerBase, decimals: int | None) -> int:
9
9
  """If the start function doesn't have decimals defined, then use the decimals value defined when the Timer() was initiated."""
10
10
 
11
- return timer.decimals if decimals is None else validate_and_normalise(decimals)
11
+ return timer._decimals if decimals is None else validate_and_normalise(decimals)
12
12
 
13
13
 
14
14
  def validate_and_normalise(decimals: int | float | None) -> int:
@@ -6,7 +6,7 @@ from ...model.timer_base import TimerBase
6
6
  def try_get_thread_item_and_index(timer: TimerBase, thread: str) -> tuple[ThreadItem, int] | tuple[None, None]:
7
7
  try:
8
8
  index_counter = 0
9
- for thread_item in timer.threads:
9
+ for thread_item in timer._threads:
10
10
  # Check if thread already exists in list. Note that this expects a normalised thread (i.e. string and not None) and already in uppercase so it evaluates as intended.
11
11
  if thread_item.name == thread:
12
12
  # Make sure only the first match is returned, yet the main function is not designed to allow input of duplicates.
@@ -21,14 +21,14 @@ def try_get_thread_item_and_index(timer: TimerBase, thread: str) -> tuple[Thread
21
21
 
22
22
  def add(timer: TimerBase, thread: str, start_time: int, decimals: int) -> None:
23
23
  try:
24
- timer.threads.append(ThreadItem(name=thread, start_time=start_time, decimals=decimals))
24
+ timer._threads.append(ThreadItem(name=thread, start_time=start_time, decimals=decimals))
25
25
  except Exception:
26
26
  error.message_for_action("when trying to add entry to the Timer's thread list", thread)
27
27
 
28
28
 
29
29
  def remove(timer: TimerBase, entry_index: int) -> None:
30
30
  try:
31
- timer.threads.pop(entry_index)
31
+ timer._threads.pop(entry_index)
32
32
  except Exception:
33
33
  error.message_for_action(
34
34
  f"when trying to remove entry from the Timer's thread list for entry index \"{entry_index}\"")
@@ -1,7 +1,7 @@
1
1
  from dataclasses import dataclass
2
2
 
3
3
 
4
- @dataclass(frozen=True, slots=True)
4
+ @dataclass(slots=True)
5
5
  class ThreadItem:
6
6
  """Class to define a thread's name, start time, and decimals."""
7
7
 
@@ -9,8 +9,8 @@ from .timer_base import TimerBase
9
9
 
10
10
 
11
11
  class Timer(TimerBase):
12
- __slots__ = ["threads", "decimals",
13
- "context_manager_threads", "context_manager_latest_thread", "context_manager_latest_decimals",
12
+ __slots__ = ["_threads", "_decimals",
13
+ "_context_manager_threads", "_context_manager_latest_thread", "_context_manager_latest_decimals",
14
14
  "__dict__"]
15
15
 
16
16
  _instance = None
@@ -85,21 +85,21 @@ class Timer(TimerBase):
85
85
  """
86
86
 
87
87
  if not self._lock_init: # Ensure that initialisation of the lists only runs the first time.
88
- self.threads: list[ThreadItem] = []
89
- self.context_manager_threads: list[str] = []
88
+ self._threads: list[ThreadItem] = []
89
+ self._context_manager_threads: list[str] = []
90
90
  self._lock_init = True
91
- self.decimals: int = decimals if decimals == constant.decimals.DEFAULT else helper.decimals.validate_and_normalise(
91
+ self._decimals: int = decimals if decimals == constant.decimals.DEFAULT else helper.decimals.validate_and_normalise(
92
92
  decimals)
93
- self.context_manager_latest_thread: str = helper.thread.normalise_to_string_and_uppercase(thread)
94
- self.context_manager_latest_decimals: int = self.decimals
93
+ self._context_manager_latest_thread: str = helper.thread.normalise_to_string_and_uppercase(thread)
94
+ self._context_manager_latest_decimals: int = self._decimals
95
95
 
96
96
  def __enter__(self) -> Timer:
97
- self.context_manager_threads.append(self.context_manager_latest_thread)
98
- self.start(self.context_manager_latest_thread, self.context_manager_latest_decimals)
97
+ self._context_manager_threads.append(self._context_manager_latest_thread)
98
+ self.start(self._context_manager_latest_thread, self._context_manager_latest_decimals)
99
99
  return self
100
100
 
101
101
  def __exit__(self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None) -> None:
102
- last_context_manager_thread = self.context_manager_threads.pop()
102
+ last_context_manager_thread = self._context_manager_threads.pop()
103
103
  self.stop(last_context_manager_thread)
104
104
 
105
105
  def start(self, thread: str | None = None, decimals: int | None = None) -> None:
@@ -150,8 +150,8 @@ class Timer(TimerBase):
150
150
  try:
151
151
  start_time = time.perf_counter_ns() # For precision, this is the first operation of the function.
152
152
  controller.start(self, thread, start_time, decimals)
153
- except Exception:
154
- error.message_for_action("when trying to start the Timer", thread)
153
+ except Exception: # pragma: no cover
154
+ error.message_for_action("when trying to start the Timer", thread) # pragma: no cover
155
155
 
156
156
  def stop(self, thread: str | None = None) -> None:
157
157
  """Stops the Timer. Should always be called after `timer.start()`.
@@ -200,5 +200,5 @@ class Timer(TimerBase):
200
200
  try:
201
201
  stop_time = time.perf_counter_ns() # For precision, this is the first operation of the function.
202
202
  controller.stop(self, thread, stop_time)
203
- except Exception:
204
- error.message_for_action("when trying to stop the Timer", thread)
203
+ except Exception: # pragma: no cover
204
+ error.message_for_action("when trying to stop the Timer", thread) # pragma: no cover
@@ -0,0 +1,32 @@
1
+ from abc import ABC, abstractmethod
2
+ from types import TracebackType
3
+
4
+ from .thread_item import ThreadItem
5
+
6
+
7
+ class TimerBase(ABC):
8
+ """Abstract base class of Timer object."""
9
+
10
+ __slots__ = ["_decimals", "_threads"]
11
+
12
+ def __init__(self) -> None:
13
+ self._decimals: int # pragma: no cover
14
+ self._threads: list[ThreadItem] # pragma: no cover
15
+
16
+ def __enter__(self) -> "TimerBase":
17
+ raise NotImplementedError # pragma: no cover
18
+
19
+ def __exit__(self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None) -> None:
20
+ raise NotImplementedError # pragma: no cover
21
+
22
+ @abstractmethod
23
+ def start(self, thread: str | None = None, decimals: int | None = None) -> None:
24
+ """Starts the Timer."""
25
+
26
+ raise NotImplementedError # pragma: no cover
27
+
28
+ @abstractmethod
29
+ def stop(self, thread: str | None = None) -> None:
30
+ """Stops the Timer."""
31
+
32
+ raise NotImplementedError # pragma: no cover
@@ -1,2 +1,2 @@
1
- __version_info__ = (0, 9, 1)
1
+ __version_info__ = (0, 9, 3)
2
2
  __version__ = ".".join(map(str, __version_info__))
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: timer-for-python
3
- Version: 0.9.1
3
+ Version: 0.9.3
4
4
  Summary: Timer for Python
5
5
  Home-page: https://jakob-bagterp.github.io/timer-for-python/
6
6
  Download-URL: https://pypi.org/project/timer-for-python/
@@ -27,15 +27,15 @@ Description-Content-Type: text/markdown
27
27
  License-File: LICENSE.md
28
28
  Requires-Dist: colorist==1.8.3
29
29
  Provides-Extra: testing
30
- Requires-Dist: coverage==7.6.8; extra == "testing"
30
+ Requires-Dist: coverage==7.6.9; extra == "testing"
31
31
  Requires-Dist: flake8==7.1.1; extra == "testing"
32
32
  Requires-Dist: mypy==1.13.0; extra == "testing"
33
- Requires-Dist: numpy==2.1.3; extra == "testing"
33
+ Requires-Dist: numpy==2.2.0; extra == "testing"
34
34
  Requires-Dist: pytest==8.3.4; extra == "testing"
35
35
  Requires-Dist: pytest-cov==6.0.0; extra == "testing"
36
36
  Requires-Dist: tox==4.23.2; extra == "testing"
37
37
 
38
- [![Latest version](https://img.shields.io/static/v1?label=version&message=0.9.1&color=yellowgreen)](https://github.com/jakob-bagterp/timer-for-python/releases/latest)
38
+ [![Latest version](https://img.shields.io/static/v1?label=version&message=0.9.3&color=yellowgreen)](https://github.com/jakob-bagterp/timer-for-python/releases/latest)
39
39
  [![Python 3.10 | 3.11 | 3.12 | 3.13+](https://img.shields.io/static/v1?label=python&message=3.10%20|%203.11%20|%203.12%20|%203.13%2B&color=blueviolet)](https://www.python.org)
40
40
  [![MIT license](https://img.shields.io/static/v1?label=license&message=MIT&color=blue)](https://github.com/jakob-bagterp/timer-for-python/blob/master/LICENSE.md)
41
41
  [![Codecov](https://codecov.io/gh/jakob-bagterp/timer-for-python/branch/master/graph/badge.svg?token=P4IT8WQO0R)](https://codecov.io/gh/jakob-bagterp/timer-for-python)
@@ -1,10 +1,10 @@
1
1
  colorist==1.8.3
2
2
 
3
3
  [testing]
4
- coverage==7.6.8
4
+ coverage==7.6.9
5
5
  flake8==7.1.1
6
6
  mypy==1.13.0
7
- numpy==2.1.3
7
+ numpy==2.2.0
8
8
  pytest==8.3.4
9
9
  pytest-cov==6.0.0
10
10
  tox==4.23.2
@@ -1,25 +0,0 @@
1
- from abc import ABC, abstractmethod
2
-
3
- from .thread_item import ThreadItem
4
-
5
-
6
- class TimerBase(ABC):
7
- """Abstract base class of Timer object."""
8
-
9
- __slots__ = ["decimals", "threads"]
10
-
11
- def __init__(self) -> None:
12
- self.decimals: int
13
- self.threads: list[ThreadItem]
14
-
15
- @abstractmethod
16
- def start(self, thread: str, decimals: int) -> None:
17
- """Starts the Timer."""
18
-
19
- raise NotImplementedError
20
-
21
- @abstractmethod
22
- def stop(self, thread: str) -> None:
23
- """Stops the Timer."""
24
-
25
- raise NotImplementedError