resourcecap 0.2.2__tar.gz → 0.2.3__tar.gz

{resourcecap-0.2.2 → resourcecap-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: resourcecap
-Version: 0.2.2
+Version: 0.2.3
 Summary: A python package to limit the resource usage of any program
 Author: purushottam-dafure
 Author-email: purushottam-dafure <purushottamdafure@gmail.com>
@@ -97,6 +97,17 @@ Each call to `foo()` logs something like:
 the above code will stop execution at that point and raise BudgetExhaustedError,
 after the 4th call to `foo()` pushes the spend from 30 to 40.
 
+`BudgetExhaustedError` carries structured fields, not just a message, so you
+can handle it programmatically without parsing text:
+
+```python
+try:
+    with Budget(amount = 30):
+        [foo() for i in range(5)]
+except BudgetExhaustedError as e:
+    print(e.resource, e.limit, e.spent)  # "cost" 30 40.0
+```
+
 A `Budget` instance can be reused across separate, non-overlapping `with`
 blocks (its spend resets each time), but it can't be open twice at once —
 entering it while it's already open, from a concurrent task/thread or

{resourcecap-0.2.2 → resourcecap-0.2.3}/README.md

@@ -83,6 +83,17 @@ Each call to `foo()` logs something like:
 the above code will stop execution at that point and raise BudgetExhaustedError,
 after the 4th call to `foo()` pushes the spend from 30 to 40.
 
+`BudgetExhaustedError` carries structured fields, not just a message, so you
+can handle it programmatically without parsing text:
+
+```python
+try:
+    with Budget(amount = 30):
+        [foo() for i in range(5)]
+except BudgetExhaustedError as e:
+    print(e.resource, e.limit, e.spent)  # "cost" 30 40.0
+```
+
 A `Budget` instance can be reused across separate, non-overlapping `with`
 blocks (its spend resets each time), but it can't be open twice at once —
 entering it while it's already open, from a concurrent task/thread or

{resourcecap-0.2.2 → resourcecap-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "resourcecap"
-version = "0.2.2"
+version = "0.2.3"
 description = "A python package to limit the resource usage of any program"
 readme = "README.md"
 license = "MIT"

{resourcecap-0.2.2 → resourcecap-0.2.3}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "resourcecap"
-version = "0.2.2"
+version = "0.2.3"
 description = "A python package to limit the resource usage of any program"
 readme = "README.md"
 license = "MIT"

{resourcecap-0.2.2 → resourcecap-0.2.3}/src/resourcecap/_budget.py

@@ -11,7 +11,19 @@ logger = logging.getLogger("resourcecap")
 
 
 class BudgetExhaustedError(Exception):
-    """Raised when a `Budget`'s limit for some resource is exceeded."""
+    """Raised when a `Budget`'s limit for some resource is exceeded.
+
+    Attributes:
+        resource: the key of the resource whose limit was exceeded.
+        limit: that resource's limit.
+        spent: how much had been spent when the limit was exceeded.
+    """
+
+    def __init__(self, resource: Hashable, limit: float, spent: float) -> None:
+        super().__init__(f"budget for resource {resource!r} of {limit} exhausted: spent {spent}")
+        self.resource = resource
+        self.limit = limit
+        self.spent = spent
 
 
 class BudgetReentryError(RuntimeError):
@@ -100,9 +112,7 @@ class Budget:
                     "resource=%s limit=%s exhausted: spent=%s", key, limit.amount, spent
                 )
             else:
-                raise BudgetExhaustedError(
-                    f"budget for resource {key!r} of {limit.amount} exhausted: spent {spent}"
-                )
+                raise BudgetExhaustedError(key, limit.amount, spent)
 
     def __enter__(self) -> "Budget":
         with self._lock: