sync

Author: Lucas McDonald

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/encrypted/paginator.py

@@ -27,7 +27,7 @@
 
 
 class EncryptedPaginator(EncryptedBotoInterface):
-    """Wrapping class for the boto3 Paginator that decrypts returned items before returning them."""
+    """Wrapping class for boto3 Paginators that decrypts returned items before returning them."""
 
     def __init__(
         self,
@@ -84,7 +84,8 @@ def paginate(self, **kwargs) -> Generator[dict, None, None]:
 
         Returns:
             Generator[dict, None, None]: A generator yielding pages as dictionaries.
-            The items in the pages will be decrypted locally after being read from DynamoDB.
+            For "scan" or "query" operations, the items in the pages will be decrypted locally after being read from
+            DynamoDB.
 
         """
         if self._paginator._model.name == "Query":

DynamoDbEncryption/runtimes/python/test/unit/encrypted/test_paginator.py

@@ -24,6 +24,7 @@
 
 def test_GIVEN_paginator_not_query_nor_scan_WHEN_paginate_THEN_defers_to_underlying_paginator():
     # Given: A paginator that is not a Query or Scan paginator
+    # Mock an underlying paginator to spy on its call pattern
     underlying_paginator = MagicMock(__class__=Paginator)
     underlying_paginator._model.name = "NotQueryNorScan"
     non_query_scan_paginator = EncryptedPaginator(
@@ -38,12 +39,14 @@ def test_GIVEN_paginator_not_query_nor_scan_WHEN_paginate_THEN_defers_to_underly
 
 
 def test_GIVEN_kwargs_has_PaginationConfig_WHEN_paginate_THEN_PaginationConfig_is_added_back_to_request():
+    # Mock an underlying paginator to spy on its call pattern
     mock_underlying_paginator = MagicMock(__class__=Paginator)
     mock_underlying_paginator._model.name = "Query"
     paginator = EncryptedPaginator(
         paginator=mock_underlying_paginator,
         encryption_config=mock_tables_encryption_config,
     )
+    # Mock the input transform method to spy on its arguments
     mock_input_transform_method = MagicMock()
     mock_input_transform_method.return_value = QueryInputTransformOutput(transformed_input={"TableName": "test-table"})
     paginator._transformer.query_input_transform = mock_input_transform_method
@@ -73,6 +76,6 @@ def test_GIVEN_invalid_class_attribute_WHEN_getattr_THEN_raise_error():
 
     # Then: AttributeError is raised
     with pytest.raises(AttributeError):
-        # Given: Invalid class attribute: not_a_valid_attribute_on_EncryptedClient_nor_boto3_client
+        # Given: Invalid class attribute: not_a_valid_attribute_on_EncryptedPaginator_nor_boto3_paginator
         # When: getattr is called
         encrypted_paginator.not_a_valid_attribute_on_EncryptedPaginator_nor_boto3_paginator()

Examples/runtimes/python/DynamoDBEncryption/src/encrypted_paginator/encrypted_paginator_example.py

@@ -152,7 +152,7 @@ def encrypted_paginator_example(
         for item in page["Items"]:
             items.append(item)
 
-    # 9. Assert the items are as expected.
+    # 9. Assert the items are returned as expected.
     assert len(items) == 1
     assert items[0]["attribute1"]["S"] == "encrypt and sign me!"
     assert items[0]["attribute2"]["S"] == "sign me!"

Examples/runtimes/python/DynamoDBEncryption/test/encrypted_paginator/test_encrypted_paginator_example.py

@@ -9,7 +9,7 @@
 
 
 def test_encrypted_paginator_example():
-    """Test function for encrypt and decrypt using the EncryptedClient example."""
+    """Test function for encrypt and decrypt using the EncryptedPaginator example."""
     test_kms_key_id = "arn:aws:kms:us-west-2:658956600833:key/b3537ef1-d8dc-4780-9f5a-55776cbb2f7f"
     test_dynamodb_table_name = "DynamoDbEncryptionInterceptorTestTable"
     encrypted_paginator_example(test_kms_key_id, test_dynamodb_table_name)