Skip to content

Commit b037568

Browse files
leandrodamascenasinofseven
leandrodamascena
authored and
sinofseven
committed
docs(api): migrating the batch utility to mkdocstrings (aws-powertools#6016)
* Mkdocstrings - Batch module * Mkdocstrings - Batch module
1 parent d8263ad commit b037568

File tree

13 files changed

+37
-29
lines changed

13 files changed

+37
-29
lines changed

‎aws_lambda_powertools/logging/__init__.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
"""Logging utility
2-
"""
1+
"""Logging utility"""
32

43
from .logger import Logger
54

‎aws_lambda_powertools/metrics/__init__.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
"""CloudWatch Embedded Metric Format utility
2-
"""
1+
"""CloudWatch Embedded Metric Format utility"""
32

43
from aws_lambda_powertools.metrics.base import MetricResolution, MetricUnit, single_metric
54
from aws_lambda_powertools.metrics.exceptions import (

‎aws_lambda_powertools/middleware_factory/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
""" Utilities to enhance middlewares """
1+
"""Utilities to enhance middlewares"""
22

33
from .factory import lambda_handler_decorator
44

‎aws_lambda_powertools/tracing/__init__.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
"""Tracing utility
2-
"""
1+
"""Tracing utility"""
32

43
from .extensions import aiohttp_trace_config
54
from .tracer import Tracer

‎aws_lambda_powertools/utilities/batch/base.py

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
"""
22
Batch processing utilities
3+
!!! abstract "Usage Documentation"
4+
[`Batch processing`](../../utilities/batch.md)
35
"""
46

57
from __future__ import annotations

‎aws_lambda_powertools/utilities/batch/decorators.py

+4-5
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,8 @@ def async_batch_processor(
5151
processor: AsyncBatchProcessor
5252
Batch Processor to handle partial failure cases
5353
54-
Examples
54+
Example
5555
--------
56-
**Processes Lambda's event with a BasePartialProcessor**
5756
>>> from aws_lambda_powertools.utilities.batch import async_batch_processor, AsyncBatchProcessor
5857
>>> from aws_lambda_powertools.utilities.data_classes.sqs_event import SQSRecord
5958
>>>
@@ -119,7 +118,7 @@ def batch_processor(
119118
processor: BatchProcessor
120119
Batch Processor to handle partial failure cases
121120
122-
Examples
121+
Example
123122
--------
124123
**Processes Lambda's event with a BatchProcessor**
125124
@@ -180,7 +179,7 @@ def process_partial_response(
180179
result: PartialItemFailureResponse
181180
Lambda Partial Batch Response
182181
183-
Examples
182+
Example
184183
--------
185184
**Processes Lambda's SQS event**
186185
@@ -244,7 +243,7 @@ def async_process_partial_response(
244243
result: PartialItemFailureResponse
245244
Lambda Partial Batch Response
246245
247-
Examples
246+
Example
248247
--------
249248
**Processes Lambda's SQS event**
250249

‎aws_lambda_powertools/utilities/batch/sqs_fifo_partial_processor.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class SqsFifoPartialProcessor(BatchProcessor):
2121
Stops processing records when the first record fails. The remaining records are reported as failed items.
2222
2323
Example
24-
_______
24+
-------
2525
2626
## Process batch triggered by a FIFO SQS
2727

‎aws_lambda_powertools/utilities/data_masking/provider/kms/aws_encryption_sdk.py

+14-14
Original file line numberDiff line numberDiff line change
@@ -142,17 +142,17 @@ def encrypt(self, data: Any, provider_options: dict | None = None, **encryption_
142142
143143
Parameters
144144
-------
145-
data : Any
146-
The data to be encrypted.
147-
provider_options : dict
148-
Additional options for the aws_encryption_sdk.EncryptionSDKClient
149-
**encryption_context : str
150-
Additional keyword arguments collected into a dictionary.
145+
data: Any
146+
The data to be encrypted.
147+
provider_options: dict
148+
Additional options for the aws_encryption_sdk.EncryptionSDKClient
149+
**encryption_context: str
150+
Additional keyword arguments collected into a dictionary.
151151
152152
Returns
153153
-------
154-
ciphertext : str
155-
The encrypted data, as a base64-encoded string.
154+
ciphertext: str
155+
The encrypted data, as a base64-encoded string.
156156
"""
157157
provider_options = provider_options or {}
158158
self._validate_encryption_context(encryption_context)
@@ -179,15 +179,15 @@ def decrypt(self, data: str, provider_options: dict | None = None, **encryption_
179179
180180
Parameters
181181
-------
182-
data : str
183-
The encrypted data, as a base64-encoded string
184-
provider_options
185-
Additional options for the aws_encryption_sdk.EncryptionSDKClient
182+
data: str
183+
The encrypted data, as a base64-encoded string
184+
provider_options
185+
Additional options for the aws_encryption_sdk.EncryptionSDKClient
186186
187187
Returns
188188
-------
189-
ciphertext : bytes
190-
The decrypted data in bytes
189+
ciphertext: bytes
190+
The decrypted data in bytes
191191
"""
192192
provider_options = provider_options or {}
193193
self._validate_encryption_context(encryption_context)

‎aws_lambda_powertools/utilities/parser/__init__.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
"""Advanced event_parser utility
2-
"""
1+
"""Advanced event_parser utility"""
32

43
from pydantic import BaseModel, Field, ValidationError, field_validator, model_validator
54

‎docs/api_doc/batch/base.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!-- markdownlint-disable MD043 MD041 -->
2+
::: aws_lambda_powertools.utilities.batch.base

‎docs/api_doc/batch/decorators.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!-- markdownlint-disable MD043 MD041 -->
2+
::: aws_lambda_powertools.utilities.batch.decorators
3+
::: aws_lambda_powertools.utilities.batch.sqs_fifo_partial_processor

‎docs/api_doc/batch/exceptions.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!-- markdownlint-disable MD043 MD041 -->
2+
::: aws_lambda_powertools.utilities.batch.exceptions

‎mkdocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ nav:
6363
# - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
6464
# - Customer to advocate: contributing/tracks/customer_advocate.md
6565
- API Documentation:
66+
- Batch Processing:
67+
- Base: api_doc/batch/base.md
68+
- Decorators: api_doc/batch/decorators.md
69+
- Exceptions: api_doc/batch/exceptions.md
6670
- Event Source Data Classes: api_doc/data_classes.md
6771
- Data Masking:
6872
- Base: api_doc/data_masking/base.md

0 commit comments

Comments
 (0)