pylemetry 0.1.3__tar.gz → 0.1.4__tar.gz

{pylemetry-0.1.3 → pylemetry-0.1.4}/.github/workflows/release.yaml

@@ -42,6 +42,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v5
+        with:
+          ssh-key: ${{ secrets.DEPLOY_KEY }}
 
       - uses: ./.github/actions/configure-uv
 
@@ -72,4 +74,5 @@ jobs:
       - name: Commit Version Bump
         uses: EndBug/add-and-commit@v9
         with:
-          message: "Bump project version following release"
+          message: "Bump project version following release [skip ci]"
+          default_author: github_actions

{pylemetry-0.1.3 → pylemetry-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pylemetry
-Version: 0.1.3
+Version: 0.1.4
 Summary: A Python metrics library
 Project-URL: Homepage, https://pypi.org/project/pylemetry/
 Project-URL: Repository, https://github.com/amurphy4/pylemetry
@@ -22,6 +22,13 @@ Description-Content-Type: text/markdown
 
 # Pylemetry
 
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![image](https://img.shields.io/pypi/v/pylemetry.svg)](https://pypi.python.org/pypi/pylemetry)
+[![image](https://img.shields.io/pypi/l/pylemetry.svg)](https://pypi.python.org/pypi/pylemetry)
+[![image](https://img.shields.io/pypi/pyversions/pylemetry.svg)](https://pypi.python.org/pypi/pylemetry)
+[![Release](https://github.com/amurphy4/pylemetry/actions/workflows/release.yaml/badge.svg?branch=main)](https://github.com/amurphy4/pylemetry/actions/workflows/release.yaml)
+
 Add metrics to your Python applications with Pylemetry
 
 Currently, three meters are supported, `Counter`, `Gauge`, and `Timer`
@@ -51,20 +58,29 @@ from pylemetry import Registry
 from pylemetry.decorators import count
 
 
-@count
+@count()
 def some_method() -> None:
     ...
 
 
+@count("named_counter")
+def another_method() -> None:
+    ...
+
+
 def main() -> None:
     for _ in range(100):
         some_method()
+        another_method()
 
     counter = Registry().get_counter("some_method")
     counter.get_count()  # 100
+
+    counter = Registry.get_counter("named_counter")
+    counter.get_count()  # 100
 ```
 
-When using this meter via a decorator, the meter gets added to the global `Registry`, with the method name it's decorating as the meter name
+When using this meter via a decorator, the meter gets added to the global `Registry`, with the method name it's decorating as the meter name. Alternatively, you can provide a name for the meter as a parameter to the decorator
 
 ## Gauge
 
@@ -95,7 +111,7 @@ gauge.get_value()  # 11.5
 
 gauge.subtract(10)
 gauge -= 8.5
-gauge.get_value()  # -7.5
+gauge.get_value()  # -8
 
 gauge.set_value(7.5)
 gauge.get_value()  # 7.5
@@ -127,20 +143,34 @@ from pylemetry import Registry
 from pylemetry.decorators import time
 
 
-@time
+@time()
 def some_method() -> None:
     ...
 
 
+@time("named_timer")
+def another_method() -> None:
+    ...
+
+
 def main() -> None:
     for _ in range(100):
         some_method()
+        another_method()
         
     timer = Registry().get_timer("some_method")
     timer.get_count()  # 100
     timer.get_mean_tick_time()  # Mean execution time of the some_method function
+    timer.get_max_tick_time()  # Maximum execution time of the some_method function
+    timer.get_min_tick_time()  # Minimum execution time of the some_method function
+
+    timer = Registry().get_timer("named_timer")
+    timer.get_count()  # 100
+    ...
 ```
 
+When using this meter via a decorator, the meter gets added to the global `Registry`, with the method name it's decorating as the meter name. Alternatively, you can provide a name for the meter as a parameter to the decorator
+
 ## The Registry
 
 Pylemetry maintains a global registry of meters, allowing you to share a meter across multiple files, or reference metrics from a central location.

{pylemetry-0.1.3 → pylemetry-0.1.4}/README.md

@@ -1,5 +1,12 @@
 # Pylemetry
 
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![image](https://img.shields.io/pypi/v/pylemetry.svg)](https://pypi.python.org/pypi/pylemetry)
+[![image](https://img.shields.io/pypi/l/pylemetry.svg)](https://pypi.python.org/pypi/pylemetry)
+[![image](https://img.shields.io/pypi/pyversions/pylemetry.svg)](https://pypi.python.org/pypi/pylemetry)
+[![Release](https://github.com/amurphy4/pylemetry/actions/workflows/release.yaml/badge.svg?branch=main)](https://github.com/amurphy4/pylemetry/actions/workflows/release.yaml)
+
 Add metrics to your Python applications with Pylemetry
 
 Currently, three meters are supported, `Counter`, `Gauge`, and `Timer`
@@ -29,20 +36,29 @@ from pylemetry import Registry
 from pylemetry.decorators import count
 
 
-@count
+@count()
 def some_method() -> None:
     ...
 
 
+@count("named_counter")
+def another_method() -> None:
+    ...
+
+
 def main() -> None:
     for _ in range(100):
         some_method()
+        another_method()
 
     counter = Registry().get_counter("some_method")
     counter.get_count()  # 100
+
+    counter = Registry.get_counter("named_counter")
+    counter.get_count()  # 100
 ```
 
-When using this meter via a decorator, the meter gets added to the global `Registry`, with the method name it's decorating as the meter name
+When using this meter via a decorator, the meter gets added to the global `Registry`, with the method name it's decorating as the meter name. Alternatively, you can provide a name for the meter as a parameter to the decorator
 
 ## Gauge
 
@@ -73,7 +89,7 @@ gauge.get_value()  # 11.5
 
 gauge.subtract(10)
 gauge -= 8.5
-gauge.get_value()  # -7.5
+gauge.get_value()  # -8
 
 gauge.set_value(7.5)
 gauge.get_value()  # 7.5
@@ -105,20 +121,34 @@ from pylemetry import Registry
 from pylemetry.decorators import time
 
 
-@time
+@time()
 def some_method() -> None:
     ...
 
 
+@time("named_timer")
+def another_method() -> None:
+    ...
+
+
 def main() -> None:
     for _ in range(100):
         some_method()
+        another_method()
         
     timer = Registry().get_timer("some_method")
     timer.get_count()  # 100
     timer.get_mean_tick_time()  # Mean execution time of the some_method function
+    timer.get_max_tick_time()  # Maximum execution time of the some_method function
+    timer.get_min_tick_time()  # Minimum execution time of the some_method function
+
+    timer = Registry().get_timer("named_timer")
+    timer.get_count()  # 100
+    ...
 ```
 
+When using this meter via a decorator, the meter gets added to the global `Registry`, with the method name it's decorating as the meter name. Alternatively, you can provide a name for the meter as a parameter to the decorator
+
 ## The Registry
 
 Pylemetry maintains a global registry of meters, allowing you to share a meter across multiple files, or reference metrics from a central location.

{pylemetry-0.1.3 → pylemetry-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pylemetry"
-version = "0.1.3"
+version = "0.1.4"
 description = "A Python metrics library"
 readme = "README.md"
 requires-python = ">=3.9"

pylemetry-0.1.4/src/pylemetry/decorators/count.py

@@ -0,0 +1,35 @@
+from typing import Callable, Any, Optional
+
+from functools import wraps
+
+from pylemetry import Registry
+from pylemetry.meters import Counter
+
+
+def count(name: Optional[str] = None) -> Callable[..., Any]:
+    """
+    Decorator to count the number of invocations of a given callable. Creates a Counter meter in the Registry
+    with either the provided name or the fully qualified name of the callable object as the metric name.
+
+    :param name: Name of the meter to create, if None the function name is used
+    :return: Result of the wrapped function
+    """
+
+    def decorator(f: Callable[..., Any]) -> Callable[..., Any]:
+        @wraps(f)
+        def wrapper() -> Any:
+            counter_name = f.__qualname__ if name is None else name
+
+            counter = Registry().get_counter(counter_name)
+
+            if not counter:
+                counter = Counter()
+                Registry().add_counter(counter_name, counter)
+
+            counter += 1
+
+            return f()
+
+        return wrapper
+
+    return decorator

pylemetry-0.1.4/src/pylemetry/decorators/time.py

@@ -0,0 +1,34 @@
+from typing import Callable, Any, Optional
+
+from functools import wraps
+
+from pylemetry import Registry
+from pylemetry.meters import Timer
+
+
+def time(name: Optional[str] = None) -> Callable[..., Any]:
+    """
+    Decorator to time the invocations of a given callable. Creates a Timer meter in the Registry with either the
+    provided name or the fully qualified name of the callable object as the metric name.
+
+    :param name: Name of the meter to create, if None the function name is used
+    :return: Result of the wrapped function
+    """
+
+    def decorator(f: Callable[..., Any]) -> Callable[..., Any]:
+        @wraps(f)
+        def wrapper() -> Any:
+            time_name = f.__qualname__ if name is None else name
+
+            _timer = Registry().get_timer(time_name)
+
+            if not _timer:
+                _timer = Timer()
+                Registry().add_timer(time_name, _timer)
+
+            with _timer.time():
+                return f()
+
+        return wrapper
+
+    return decorator

{pylemetry-0.1.3 → pylemetry-0.1.4}/src/pylemetry/meters/timer.py

@@ -24,7 +24,7 @@ class Timer:
     @contextmanager
     def time(self) -> Generator[None, None, None]:
         """
-        Context manager to time a code block and add the result to the internal ticks list
+        Context manager to time in seconds a code block and add the result to the internal ticks list
         """
 
         start_time = time.perf_counter()
@@ -53,3 +53,21 @@ class Timer:
         """
 
         return sum(self.ticks) / len(self.ticks)
+
+    def get_max_tick_time(self) -> float:
+        """
+        Get the maximum tick time from the list of ticks within this timer
+
+        :return: Maximum tick time
+        """
+
+        return max(self.ticks)
+
+    def get_min_tick_time(self) -> float:
+        """
+        Get the minimum tick time from the list of ticks within this timer
+
+        :return: Minimum tick time
+        """
+
+        return min(self.ticks)

{pylemetry-0.1.3 → pylemetry-0.1.4}/test/test_pylemetry/decorators/test_count.py

@@ -5,7 +5,7 @@ from pylemetry.decorators import count
 from pylemetry.meters import Counter
 
 
-@count
+@count()
 def mock_function() -> str:
     return "A function decorated with the count decorator"
 
@@ -36,3 +36,13 @@ def test_count_decorator_updates_existing_counter(call_count: int) -> None:
 
     assert isinstance(counter, Counter)
     assert counter.get_count() == call_count
+
+
+def test_count_decorator_with_name() -> None:
+    @count(name="test_count_meter")
+    def mock() -> None:
+        print("Mock method")
+
+    mock()
+
+    assert "test_count_meter" in Registry().counters

{pylemetry-0.1.3 → pylemetry-0.1.4}/test/test_pylemetry/decorators/test_time.py

@@ -5,7 +5,7 @@ from pylemetry.decorators import time
 from pylemetry.meters import Timer
 
 
-@time
+@time()
 def mock_function() -> str:
     return "A function decorated with the timer decorator"
 
@@ -38,3 +38,13 @@ def test_count_decorator_updates_existing_counter(call_count: int) -> None:
     assert isinstance(timer, Timer)
     assert timer.get_count() == call_count
     assert 0 < timer.get_mean_tick_time() < 0.05
+
+
+def test_time_decorator_with_name() -> None:
+    @time(name="test_timer_meter")
+    def mock() -> None:
+        print("Mock method")
+
+    mock()
+
+    assert "test_timer_meter" in Registry().timers

{pylemetry-0.1.3 → pylemetry-0.1.4}/test/test_pylemetry/meters/test_timer.py

@@ -36,3 +36,19 @@ def test_get_mean_tick_time() -> None:
     timer.ticks = [1, 2, 3, 4, 5]
 
     assert timer.get_mean_tick_time() == 3
+
+
+def test_get_max_tick_time() -> None:
+    timer = Timer()
+
+    timer.ticks = [1, 2, 3, 4, 5]
+
+    assert timer.get_max_tick_time() == 5
+
+
+def test_get_min_tick_time() -> None:
+    timer = Timer()
+
+    timer.ticks = [1, 2, 3, 4, 5]
+
+    assert timer.get_min_tick_time() == 1

{pylemetry-0.1.3 → pylemetry-0.1.4}/uv.lock

@@ -246,7 +246,7 @@ wheels = [
 
 [[package]]
 name = "pylemetry"
-version = "0.1.3"
+version = "0.1.4"
 source = { editable = "." }
 
 [package.dev-dependencies]

pylemetry-0.1.3/src/pylemetry/decorators/count.py

@@ -1,32 +0,0 @@
-from typing import Callable, Any
-
-from functools import wraps
-
-from pylemetry import Registry
-from pylemetry.meters import Counter
-
-
-def count(f: Callable[..., Any]) -> Callable[..., Any]:
-    """
-    Decorator to count the number of invocations of a given callable. Creates a Counter meter in the Registry
-    with the fully qualified name of the callable object as the metric name.
-
-    :param f: Callable to wrap
-    :return: Result of f
-    """
-
-    @wraps(f)
-    def wrapper() -> Any:
-        counter_name = f.__qualname__
-
-        counter = Registry().get_counter(counter_name)
-
-        if not counter:
-            counter = Counter()
-            Registry().add_counter(counter_name, counter)
-
-        counter += 1
-
-        return f()
-
-    return wrapper

pylemetry-0.1.3/src/pylemetry/decorators/time.py

@@ -1,31 +0,0 @@
-from typing import Callable, Any
-
-from functools import wraps
-
-from pylemetry import Registry
-from pylemetry.meters import Timer
-
-
-def time(f: Callable[..., Any]) -> Callable[..., Any]:
-    """
-    Decorator to time the invocations of a given callable. Creates a Timer meter in the Registry with the fully
-    qualified name of the callable object as the metric name.
-
-    :param f: Callable to wrap
-    :return: Result of f
-    """
-
-    @wraps(f)
-    def wrapper() -> Any:
-        time_name = f.__qualname__
-
-        _timer = Registry().get_timer(time_name)
-
-        if not _timer:
-            _timer = Timer()
-            Registry().add_timer(time_name, _timer)
-
-        with _timer.time():
-            return f()
-
-    return wrapper