pylemetry 1.1.2__tar.gz → 1.1.4__tar.gz

{pylemetry-1.1.2 → pylemetry-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pylemetry
-Version: 1.1.2
+Version: 1.1.4
 Summary: A Python metrics library
 Project-URL: Homepage, https://pypi.org/project/pylemetry/
 Project-URL: Repository, https://github.com/amurphy4/pylemetry
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.10
+Requires-Dist: typing-extensions>=4.15.0
 Description-Content-Type: text/markdown
 
 # Pylemetry
@@ -265,4 +266,8 @@ logger = logging.getLogger()
 with LoggingReporter(10, logger, logging.INFO, ReportingType.CUMULATIVE) as reporter:
     reporter.configure_message_format("{name} - {value}", MeterType.COUNTER)
     ...
-```
+```
+
+When using a reporter as a context manager there is an additional optional parameter you can set,
+`clear_registry_on_exit` which is set to `False` by default. When set to `True`, this will
+clear the registry (via `registry.clear()`) when the context manager exits

{pylemetry-1.1.2 → pylemetry-1.1.4}/README.md

@@ -243,4 +243,8 @@ logger = logging.getLogger()
 with LoggingReporter(10, logger, logging.INFO, ReportingType.CUMULATIVE) as reporter:
     reporter.configure_message_format("{name} - {value}", MeterType.COUNTER)
     ...
-```
+```
+
+When using a reporter as a context manager there is an additional optional parameter you can set,
+`clear_registry_on_exit` which is set to `False` by default. When set to `True`, this will
+clear the registry (via `registry.clear()`) when the context manager exits

{pylemetry-1.1.2 → pylemetry-1.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pylemetry"
-version = "1.1.2"
+version = "1.1.4"
 description = "A Python metrics library"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -25,7 +25,9 @@ classifiers = [
     "Programming Language :: Python :: 3.14",
 ]
 
-dependencies = []
+dependencies = [
+    "typing-extensions>=4.15.0",
+]
 
 [project.urls]
 Homepage = "https://pypi.org/project/pylemetry/"
@@ -58,7 +60,7 @@ explicit_package_bases = true
 line-length = 120
 
 [tool.ruff.lint]
-extend-select = ["E501"]
+select = ["E", "F", "B"]
 
 [tool.pytest.ini_options]
 addopts = "--cov=pylemetry --cov-report=html"

{pylemetry-1.1.2 → pylemetry-1.1.4}/src/pylemetry/meters/counter.py

@@ -2,7 +2,7 @@ from pylemetry.meters.meter import Meter, MeterType
 
 
 class Counter(Meter):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(MeterType.COUNTER)
 
     def add(self, value: int = 1) -> None:

{pylemetry-1.1.2 → pylemetry-1.1.4}/src/pylemetry/meters/gauge.py

@@ -2,7 +2,7 @@ from pylemetry.meters.meter import Meter, MeterType
 
 
 class Gauge(Meter):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(MeterType.GAUGE)
 
     def set_value(self, value: float):

{pylemetry-1.1.2 → pylemetry-1.1.4}/src/pylemetry/meters/meter.py

@@ -9,7 +9,7 @@ class MeterType(Enum):
 
 
 class Meter:
-    def __init__(self, meter_type: MeterType):
+    def __init__(self, meter_type: MeterType) -> None:
         self.lock = Lock()
         self.value = 0.0
         self.last_interval_value = 0.0

{pylemetry-1.1.2 → pylemetry-1.1.4}/src/pylemetry/meters/timer.py

@@ -8,10 +8,10 @@ from pylemetry.meters.meter import Meter, MeterType
 
 
 class Timer(Meter):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(MeterType.TIMER)
 
-        self.ticks = []
+        self.ticks: list[float] = []
 
     def tick(self, tick: float) -> None:
         """
@@ -49,7 +49,7 @@ class Timer(Meter):
 
         ticks = self.get_ticks_since_last_interval() if since_last_interval else self.ticks
 
-        return sum(ticks)
+        return sum(ticks)  # type: ignore
 
     def get_count(self, since_last_interval: bool = False) -> int:
         """

{pylemetry-1.1.2 → pylemetry-1.1.4}/src/pylemetry/reporting/logging.py

@@ -23,8 +23,10 @@ class Loggable(Protocol[P, R]):
 
 
 class LoggingReporter(Reporter):
-    def __init__(self, interval: float, logger: Loggable, level: int, _type: ReportingType):
-        super().__init__(interval)
+    def __init__(
+        self, interval: float, logger: Loggable, level: int, _type: ReportingType, clear_registry_on_exit: bool = False
+    ) -> None:
+        super().__init__(interval, clear_registry_on_exit)
 
         self.logger = logger
         self.level = level

{pylemetry-1.1.2 → pylemetry-1.1.4}/src/pylemetry/reporting/reporter.py

@@ -4,14 +4,16 @@ from types import TracebackType
 
 import threading
 
+from pylemetry import registry
 from pylemetry.meters import Counter, Gauge, Timer, Meter
 
 
 class Reporter:
-    def __init__(self, interval: float):
+    def __init__(self, interval: float, clear_registry_on_exit: bool = False) -> None:
         self.interval = interval
         self.__timer_thread: Optional[threading.Timer] = None
         self.running = False
+        self.clear_registry_on_exit = clear_registry_on_exit
 
     def __enter__(self) -> Self:
         self.start()
@@ -23,6 +25,9 @@ class Reporter:
     ):
         self.stop()
 
+        if self.clear_registry_on_exit:
+            registry.clear()
+
     def flush(self) -> None:
         """
         Flush all meter values in the registry. If the reporter is configured using `ReporterType.INTERVAL`, this will

{pylemetry-1.1.2 → pylemetry-1.1.4}/test/test_pylemetry/reporting/test_reporter.py

@@ -51,6 +51,25 @@ def test_reporter_context_manager(caplog) -> None:
         assert caplog.records[0].msg == "test_counter - 1.0"
 
 
+def test_reporter_context_manager_clear_registry_on_exit(caplog) -> None:
+    logger = logging.getLogger(__name__)
+
+    counter = Counter()
+    counter += 1
+
+    registry.add_counter("test_counter", counter)
+
+    with LoggingReporter(0.1, logger, logging.INFO, ReportingType.CUMULATIVE):
+        counter += 1
+
+    assert registry.get_counter("test_counter") == counter
+
+    with LoggingReporter(0.1, logger, logging.INFO, ReportingType.CUMULATIVE, clear_registry_on_exit=True):
+        counter += 1
+
+    assert registry.get_counter("test_counter") is None
+
+
 def test_message_format_counter() -> None:
     message_format = (
         "{{'name': '{name}', 'type': '{type}', 'value': {value}, 'min': {min}, 'max': {max}, 'average': {avg}}}"

{pylemetry-1.1.2 → pylemetry-1.1.4}/uv.lock

@@ -257,8 +257,11 @@ wheels = [
 
 [[package]]
 name = "pylemetry"
-version = "1.1.2"
+version = "1.1.4"
 source = { editable = "." }
+dependencies = [
+    { name = "typing-extensions" },
+]
 
 [package.dev-dependencies]
 dev = [
@@ -272,6 +275,7 @@ dev = [
 ]
 
 [package.metadata]
+requires-dist = [{ name = "typing-extensions", specifier = ">=4.15.0" }]
 
 [package.metadata.requires-dev]
 dev = [