pydantic v2: improving comments

leandrodamascena · Jul 10, 2023 · ef98e88 · ef98e88
1 parent bf6b31a
commit ef98e88
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 3 deletions.
diff --git a/aws_lambda_powertools/utilities/parser/models/apigw.py b/aws_lambda_powertools/utilities/parser/models/apigw.py
@@ -77,7 +77,9 @@ def check_message_id(cls, values):
             raise ValueError("messageId is available only when the `eventType` is `MESSAGE`")
         return values
 
-    # validator to normalize requestTimeEpoch
+    # Validator to normalize the requestTimeEpoch field
+    # Converts the provided timestamp value to a UTC datetime object
+    # See: https://github.com/pydantic/pydantic/issues/6518
     @validator("requestTimeEpoch", pre=True)
     def normalize_timestamp(cls, value):
         date_utc = datetime.fromtimestamp(int(value) / 1000, tz=timezone.utc)

diff --git a/aws_lambda_powertools/utilities/parser/models/apigwv2.py b/aws_lambda_powertools/utilities/parser/models/apigwv2.py
@@ -55,7 +55,9 @@ class RequestContextV2(BaseModel):
     timeEpoch: datetime
     http: RequestContextV2Http
 
-    # validator to normalize timestamp
+    # Validator to normalize the timeEpoch field
+    # Converts the provided timestamp value to a UTC datetime object
+    # See: https://github.com/pydantic/pydantic/issues/6518
     @validator("timeEpoch", pre=True)
     def normalize_timestamp(cls, value):
         date_utc = datetime.fromtimestamp(int(value) / 1000, tz=timezone.utc)

diff --git a/aws_lambda_powertools/utilities/parser/models/cloudwatch.py b/aws_lambda_powertools/utilities/parser/models/cloudwatch.py
@@ -15,6 +15,9 @@ class CloudWatchLogsLogEvent(BaseModel):
     timestamp: datetime
     message: Union[str, Type[BaseModel]]
 
+    # Validator to normalize the timestamp field
+    # Converts the provided timestamp value to a UTC datetime object
+    # See: https://github.com/pydantic/pydantic/issues/6518
     @validator("timestamp", pre=True)
     def coerc_timestamp(cls, value):
         date_utc = datetime.fromtimestamp(value / 1000, tz=timezone.utc)

diff --git a/aws_lambda_powertools/utilities/parser/models/kafka.py b/aws_lambda_powertools/utilities/parser/models/kafka.py
@@ -19,7 +19,7 @@ class KafkaRecordModel(BaseModel):
     value: Union[str, Type[BaseModel]]
     headers: List[Dict[str, bytes]]
 
-    # validators
+    # Added type ignore to keep compatibility between Pydantic v1 and v2
     _decode_key = validator("key", allow_reuse=True)(base64_decode)  # type: ignore[type-var, unused-ignore]
 
     @validator("value", pre=True, allow_reuse=True)
@@ -34,6 +34,9 @@ def decode_headers_list(cls, value):
                 header[key] = bytes(values)
         return value
 
+    # Validator to normalize the timestamp field
+    # Converts the provided timestamp value to a UTC datetime object
+    # See: https://github.com/pydantic/pydantic/issues/6518
     @validator("timestamp", pre=True)
     def normalize_timestamp(cls, value):
         date_utc = datetime.fromtimestamp(int(value) / 1000, tz=timezone.utc)

diff --git a/aws_lambda_powertools/utilities/parser/models/sqs.py b/aws_lambda_powertools/utilities/parser/models/sqs.py
@@ -16,6 +16,9 @@ class SqsAttributesModel(BaseModel):
     SequenceNumber: Optional[str] = None
     AWSTraceHeader: Optional[str] = None
 
+    # Validator to normalize the ApproximateFirstReceiveTimestamp and SentTimestamp fields
+    # Converts the provided timestamp value to a UTC datetime object
+    # See: https://github.com/pydantic/pydantic/issues/6518
     @validator("ApproximateFirstReceiveTimestamp", "SentTimestamp", pre=True)
     def normalize_timestamp(cls, value):
         date_utc = datetime.fromtimestamp(int(value) / 1000, tz=timezone.utc)