Skip to content

Commit 37dfc71

Browse files
committed
docs: Data Classes str()
Update Data Classes documentation to mention Data Classes can be inspected with str(), and include example.
1 parent 70108e3 commit 37dfc71

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/utilities/data_classes.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Event Source Data Classes utility provides classes self-describing Lambda event
1212
* Type hinting and code completion for common event types
1313
* Helper functions for decoding/deserializing nested fields
1414
* Docstrings for fields contained in event schemas
15+
* Implement str() to recursively inspect contents
1516

1617
**Background**
1718

@@ -52,6 +53,22 @@ Same example as above, but using the `event_source` decorator
5253
if 'helloworld' in event.path and event.http_method == 'GET':
5354
do_something_with(event.body, user)
5455
```
56+
57+
Log Data Event for Troubleshooting
58+
59+
=== "app.py"
60+
61+
```python hl_lines="4 8"
62+
from aws_lambda_powertools.utilities.data_classes import event_source, APIGatewayProxyEvent
63+
from aws_lambda_powertools.logging.logger import Logger
64+
65+
logger = Logger(service="hello_logs", level="DEBUG")
66+
67+
@event_source(data_class=APIGatewayProxyEvent)
68+
def lambda_handler(event: APIGatewayProxyEvent, context):
69+
logger.debug(event)
70+
```
71+
5572
**Autocomplete with self-documented properties and methods**
5673

5774
![Utilities Data Classes](../media/utilities_data_classes.png)

0 commit comments

Comments
 (0)