Add type alias and better naming

gregfurman · gregfurman · commit 6ed957beade9 · 2025-03-25T17:56:36.000+02:00
diff --git a/localstack-core/localstack/utils/batch_policy.py b/localstack-core/localstack/utils/batch_policy.py
@@ -7,6 +7,9 @@
 
 T = TypeVar("T")
 
+# alias to signify whether a batch policy has been triggered
+BatchPolicyTriggered = bool
+
 
 # TODO: Add batching on bytes as well.
 @dataclass
@@ -70,13 +73,19 @@ def _check_batch_policy(self) -> bool:
         return self._triggered
 
     @overload
-    def add(self, item: T, *, cache_deep_copy: bool = False) -> bool: ...
+    def add(self, item: T, *, deep_copy: bool = False) -> BatchPolicyTriggered: ...
 
     @overload
-    def add(self, items: List[T], *, cache_deep_copy: bool = False) -> bool: ...
+    def add(self, items: List[T], *, deep_copy: bool = False) -> BatchPolicyTriggered: ...
+
+    def add(self, item_or_items: T | list[T], *, deep_copy: bool = False) -> BatchPolicyTriggered:
+        """
+        Add an item or list of items to the collected batch.
 
-    def add(self, item_or_items: T | list[T], *, cache_deep_copy: bool = False) -> bool:
-        if cache_deep_copy:
+        Returns:
+            BatchPolicyTriggered: True if the batch policy was triggered during addition, False otherwise.
+        """
+        if deep_copy:
             item_or_items = copy.deepcopy(item_or_items)
 
         if isinstance(item_or_items, list):
