docs(sqs-base): docstring for base class

Author: gmcrocetti

aws_lambda_powertools/utilities/batch/base.py

@@ -9,6 +9,10 @@
 
 
 class BaseProcessor(ABC):
+    """
+    Abstract class for batch processors.
+    """
+
     @abstractmethod
     def _prepare(self):
         """
@@ -24,10 +28,16 @@ def _clean(self):
         raise NotImplementedError()
 
     @abstractmethod
-    def _process_record(self, record):
+    def _process_record(self, record: Any):
+        """
+        Process record with handler.
+        """
         raise NotImplementedError()
 
     def process(self) -> List[Tuple]:
+        """
+        Call instance's handler for each record.
+        """
         return [self._process_record(record) for record in self.records]
 
     def __enter__(self):
@@ -43,7 +53,6 @@ def __call__(self, records: Iterable[Any], handler: Callable):
 
         Parameters
         ----------
-
         records: Iterable[Any]
             Iterable with objects to be processed.
         handler: Callable
@@ -59,15 +68,15 @@ class BasePartialProcessor(BaseProcessor):
     success_messages: MutableSequence = None
     fail_messages: MutableSequence = None
 
-    def success_handler(self, record, result):
+    def success_handler(self, record: Any, result: Any):
         """
         Success callback
         """
         entry = ("success", result, record)
         self.success_messages.append(record)
         return entry
 
-    def failure_handler(self, record, exception):
+    def failure_handler(self, record: Any, exception: Exception):
         """
         Failure callback
         """