chore: fix typos, docstrings and type hints (#154)

Changes:
* Fix some of the type hints
* Add missing docstrings for parameters
* Fix typos

Author: Michael Brewer

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 # We use poetry to run formatting and linting before commit/push
-# Longers checks such as tests, security and complexity baseline
+# Longer checks such as tests, security and complexity baseline
 # are run as part of CI to prevent slower feedback loop
 # All checks can be run locally via `make pr`
 

aws_lambda_powertools/metrics/base.py

@@ -112,7 +112,7 @@ def add_metric(self, name: str, unit: MetricUnit, value: Union[float, int]):
             Metric name
         unit : MetricUnit
             `aws_lambda_powertools.helper.models.MetricUnit`
-        value : float
+        value : Union[float, int]
             Metric value
 
         Raises
@@ -146,6 +146,8 @@ def serialize_metric_set(self, metrics: Dict = None, dimensions: Dict = None, me
             Dictionary of metrics to serialize, by default None
         dimensions : Dict, optional
             Dictionary of dimensions to serialize, by default None
+        metadata: Dict, optional
+            Dictionary of metadata to serialize, by default None
 
         Example
         -------
@@ -183,7 +185,7 @@ def serialize_metric_set(self, metrics: Dict = None, dimensions: Dict = None, me
         metric_names_and_values: Dict[str, str] = {}  # { "metric_name": 1.0 }
 
         for metric_name in metrics:
-            metric: str = metrics[metric_name]
+            metric: dict = metrics[metric_name]
             metric_value: int = metric.get("Value", 0)
             metric_unit: str = metric.get("Unit", "")
 
@@ -257,7 +259,7 @@ def add_metadata(self, key: str, value: Any):
 
         Parameters
         ----------
-        name : str
+        key : str
             Metadata key
         value : any
             Metadata value

aws_lambda_powertools/utilities/batch/sqs.py

@@ -55,7 +55,7 @@ def __init__(self, config: Optional[Config] = None):
 
         super().__init__()
 
-    def _get_queue_url(self) -> str:
+    def _get_queue_url(self) -> Optional[str]:
         """
         Format QueueUrl from first records entry
         """

docs/content/utilities/batch.mdx

@@ -28,7 +28,7 @@ SQS integration with Lambda is one of the most well established ones and pretty
 
 As any function call, you may face errors during execution, in one or more records belonging to a batch. SQS's native behavior is to redrive the **whole** batch to the queue again, reprocessing all of them again, including successful ones. This cycle can happen multiple times depending on your [configuration][3], until the whole batch succeeds or the maximum number of attempts is reached. Your application may face some problems with such behavior, especially if there's no idempotency.
 
-A *naive* approach to solving this problem is to delete successful records from the queue before redriving's phase. The `PartialSQSProcessor` class offers this solution both as context manager and middleware, removing all successful messages from the queue case one or more failures ocurred during lambda's execution. Two examples are provided below, displaying the behavior of this class.
+A *naive* approach to solving this problem is to delete successful records from the queue before redriving's phase. The `PartialSQSProcessor` class offers this solution both as context manager and middleware, removing all successful messages from the queue case one or more failures occurred during lambda's execution. Two examples are provided below, displaying the behavior of this class.
 
 **Examples:**
 

example/hello_world/app.py

@@ -14,7 +14,7 @@
 set_package_logger()  # Enable package diagnostics (DEBUG log)
 
 # tracer = Tracer() # patches all available modules # noqa: E800
-tracer = Tracer(patch_modules=("aioboto3", "boto3", "requests"))  # ~90-100ms faster in perf depending on set of libs
+tracer = Tracer(patch_modules=["aioboto3", "boto3", "requests"])  # ~90-100ms faster in perf depending on set of libs
 logger = Logger()
 metrics = Metrics()
 
@@ -114,13 +114,13 @@ def lambda_handler(event, context):
 
     try:
         ip = requests.get("http://checkip.amazonaws.com/")
-        metrics.add_metric(name="SuccessfulLocations", unit="Count", value=1)
+        metrics.add_metric(name="SuccessfulLocations", unit=MetricUnit.Count, value=1)
     except requests.RequestException as e:
         # Send some context about this error to Lambda Logs
         logger.exception(e)
         raise
 
-    with single_metric(name="UniqueMetricDimension", unit="Seconds", value=1) as metric:
+    with single_metric(name="UniqueMetricDimension", unit=MetricUnit.Seconds, value=1) as metric:
         metric.add_dimension(name="unique_dimension", value="for_unique_metric")
 
     resp = {"message": "hello world", "location": ip.text.replace("\n", ""), "async_http": async_http_ret}