m

Author: Lucas McDonald

.github/workflows/ci_test_vector_python.yml

@@ -99,5 +99,5 @@ jobs:
       - name: Test Python TestVectors with ${{matrix.interface}} interface
         working-directory: ${{matrix.library}}
         run: |
-          cp ../java/*.json runtimes/python/
+          cp runtimes/java/*.json runtimes/python
           make test_python_${{matrix.interface}}_interface

DynamoDbEncryption/runtimes/python/pyproject.toml

@@ -82,7 +82,7 @@ select = [
     # Ignore all "public"-related linting errors for internal modules
     "D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107",
     # Ignore opinionated docstring linting errors for internal modules
-    "D205", "D400", "D401", "D403"
+    "D205", "D400", "D401", "D403", "D404", "D415",
 ]
 
 [tool.black]

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/__init__.py

@@ -5,11 +5,10 @@
 # (generated Dafny, then externs)
 # ruff: noqa: I
 # Initialize generated Dafny
-from .internaldafny.generated import module_
-
 # Initialize externs
 # noqa: F401, F403
 from .internaldafny import extern
+from .internaldafny.generated import module_
 
 """
 boto3 uses Python's decimal library to deserialize numbers retrieved by resources

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

@@ -169,7 +169,7 @@ def batch_get_item(self, **kwargs):
         )
 
     def batch_write_item(self, **kwargs):
-        """Puts or deletes multiple items in one or more tables.
+        """Put or delete multiple items in one or more tables.
         For put operations, encrypts items before writing.
 
         The parameters and return value match the boto3 DynamoDB batch_write_item API:

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

@@ -57,9 +57,11 @@ def __init__(
         table: ServiceResource,
         encryption_config: DynamoDbTablesEncryptionConfig,
     ):
-        """Parameters
-        table (ServiceResource): Initialized boto3 DynamoDB table
-        encryption_config (DynamoDbTablesEncryptionConfig): Initialized DynamoDbTablesEncryptionConfig
+        """Create an EncryptedTable object.
+
+        Args:
+            table (ServiceResource): Initialized boto3 DynamoDB table
+            encryption_config (DynamoDbTablesEncryptionConfig): Initialized DynamoDbTablesEncryptionConfig
 
         """
         self._table = table
@@ -71,20 +73,16 @@ def __init__(
         )
 
     def put_item(self, **kwargs) -> dict[str, Any]:
-        """Puts a single item in the table. Encrypts the item before writing to DynamoDB.
+        """Put a single item to the table. Encrypts the item before writing to DynamoDB.
 
         The parameters and return value match the boto3 DynamoDB table put_item API:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/put_item.html
 
         Args:
-            Item (dict): A map of attribute name/value pairs to write to the table
-
-        These are only a list of required args; see boto3 docs for complete request structure.
+            **kwargs: Keyword arguments to pass to the scan operation. These match the boto3 scan API parameters.
 
         Returns:
-            dict: The response from DynamoDB.
-
-        See boto3 docs for complete response structure.
+            dict: The response from DynamoDB containing the scanned items. This matches the boto3 scan API response.
 
         """
         return self._table_operation_logic(
@@ -101,20 +99,16 @@ def put_item(self, **kwargs) -> dict[str, Any]:
         )
 
     def get_item(self, **kwargs) -> dict[str, Any]:
-        """Gets a single item from the table. Decrypts the item after reading from DynamoDB.
+        """Get a single item from the table. Decrypts the item after reading from DynamoDB.
 
         The parameters and return value match the boto3 DynamoDB table get_item API:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/get_item.html
 
         Args:
-            Key (dict): The primary key of the item to retrieve
-
-        These are only a list of required args; see boto3 docs for complete request structure.
+            **kwargs: Keyword arguments to pass to the scan operation. These match the boto3 scan API parameters.
 
         Returns:
-            dict: The response from DynamoDB containing the requested item.
-
-        See boto3 docs for complete response structure.
+            dict: The response from DynamoDB containing the scanned items. This matches the boto3 scan API response.
 
         """
         return self._table_operation_logic(
@@ -131,20 +125,16 @@ def get_item(self, **kwargs) -> dict[str, Any]:
         )
 
     def query(self, **kwargs) -> dict[str, Any]:
-        """Queries items from the table or index. Decrypts any returned items.
+        """Query items from the table or index. Decrypts any returned items.
 
         The parameters and return value match the boto3 DynamoDB table query API:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/query.html
 
         Args:
-            KeyConditionExpression (str): The condition that specifies the key value(s) for items to be retrieved
-
-        These are only a list of required args; see boto3 docs for complete request structure.
+            **kwargs: Keyword arguments to pass to the scan operation. These match the boto3 scan API parameters.
 
         Returns:
-            dict: The response from DynamoDB containing the matching items.
-
-        See boto3 docs for complete response structure.
+            dict: The response from DynamoDB containing the scanned items. This matches the boto3 scan API response.
 
         """
         return self._table_operation_logic(
@@ -161,20 +151,16 @@ def query(self, **kwargs) -> dict[str, Any]:
         )
 
     def scan(self, **kwargs) -> dict[str, Any]:
-        """Scans the entire table or index. Decrypts any returned items.
+        """Scan the entire table or index. Decrypts any returned items.
 
         The parameters and return value match the boto3 DynamoDB table scan API:
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/scan.html
 
         Args:
-            FilterExpression (str, optional): A string that contains conditions that DynamoDB applies after the scan operation
-
-        These are only a list of required args; see boto3 docs for complete request structure.
+            **kwargs: Keyword arguments to pass to the scan operation. These match the boto3 scan API parameters.
 
         Returns:
-            dict: The response from DynamoDB containing the scanned items.
-
-        See boto3 docs for complete response structure.
+            dict: The response from DynamoDB containing the scanned items. This matches the boto3 scan API response.
 
         """
         return self._table_operation_logic(
@@ -207,13 +193,11 @@ def batch_writer(self, overwrite_by_pkeys: list[str] | None = None) -> BatchWrit
 
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/batch_writer.html
 
-        Parameters
-        ----------
+        Args:
             overwrite_by_pkeys: De-duplicate request items in buffer if match new request
                 item on specified primary keys. i.e ``["partition_key1", "sort_key2", "sort_key3"]``
 
-        Returns
-        -------
+        Returns:
             BatchWriter: A batch writer that will transparently encrypt requests
 
         """
@@ -240,8 +224,7 @@ def _table_operation_logic(
         output_client_to_resource_shape_transform_method: Any,
         table_method: Callable,
     ) -> dict[str, Any]:
-        """Shared logic to interface between user-supplied input, encryption/decryption transformers,
-        and boto3 Tables.
+        """Interface between user-supplied input, encryption/decryption transformers, and boto3 Tables.
 
         Args:
             operation_input: User-supplied input to the operation

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/internal/client_to_resource.py

@@ -18,9 +18,12 @@ def condition_handler(self, expression_key, request):
         # Resources accept either strings or Attrs.
         condition = request[expression_key]
 
-        # This conversion in client_to_resource does not update ExpressionAttributeNames nor ExpressionAttributeValues.
-        # However, resource_to_client condition_handler may add new ExpressionAttributeNames and ExpressionAttributeValues.
-        # Smithy-generated code expects condition_handlers to return ExpressionAttributeNames and ExpressionAttributeValues.
+        # This conversion in client_to_resource does not update neither
+        # ExpressionAttributeNames nor ExpressionAttributeValues.
+        # However, resource_to_client condition_handler may add new
+        # ExpressionAttributeNames and ExpressionAttributeValues.
+        # Smithy-generated code expects condition_handlers to return
+        # ExpressionAttributeNames and ExpressionAttributeValues.
         try:
             names = request["ExpressionAttributeNames"]
         except KeyError:

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/internal/condition_expression_builder.py

@@ -186,139 +186,3 @@ def _build_value_placeholder(self, value, attribute_value_placeholders, has_grou
                 self._value_count += 1
                 attribute_value_placeholders[value_placeholder] = value
                 return value_placeholder
-
-
-# class InternalDBESDKDynamoDBConditionExpressionBuilder:
-#     """
-#     This internal class is used to transform boto3 DyamoDB conditions from
-#         Python classes to DynamoDB ConditionExpressions
-#         for use by internal DBESDK DyanmoDB operation transformers.
-
-#     This class is a modified version of boto3's ConditionExpressionBuilder:
-#     https://github.com/boto/boto3/blob/c5c634b53be589d6e913e6dca51ad8d6480f58c7/boto3/dynamodb/conditions.py#L304
-#     The original class is intended to interface from boto3 Table resources to boto3 clients.
-#     The class defined here is intended to interface from boto3 Table resources
-#         to internal DBESDK DynamoDB operation transformers.
-#     The placeholder insertion logic has been removed from this class, along with supporting logic,
-#         but this class maintains boto3's recursive ConditionExpression traversal logic.
-#     """
-
-#     def __init__(self):
-#         self._name_count = 0
-#         self._value_count = 0
-#         self._name_placeholder = 'n'
-#         self._value_placeholder = 'v'
-
-#     def _get_name_placeholder(self):
-#         return '#' + self._name_placeholder + str(self._name_count)
-
-#     def _get_value_placeholder(self):
-#         return ':' + self._value_placeholder + str(self._value_count)
-
-#     def reset(self):
-#         """Resets the placeholder name and values"""
-#         self._name_count = 0
-#         self._value_count = 0
-
-#     def build_expression(
-#         self,
-#         condition,
-#         expression_attribute_names,
-#         expression_attribute_values,
-#     ):
-#         """Builds the condition expression.
-
-#         :type condition: ConditionBase
-#         :param condition: A condition to be built into a condition expression string.
-
-#         :rtype: (string, dict, dict)
-#         :returns: Will return a string representing the condition expression,
-#             the original dictionary of attribute names,
-#             and the original dictionary of attribute values.
-#         """
-#         if not isinstance(condition, ConditionBase):
-#             raise DynamoDBNeedsConditionError(condition)
-#         condition_expression = self._build_expression(condition, expression_attribute_names, expression_attribute_values)
-#         return BuiltConditionExpression(
-#             condition_expression=condition_expression,
-#             # BuiltConditionExpression uses "placeholders" nomenclature;
-#             # this is an artifact of the original boto3 ConditionExpressionBuilder.
-#             # This class neither creates placeholders, nor even uses the provided name/values dicts.
-#             # They are only here as required arguments for the BuiltConditionExpression class.
-#             attribute_name_placeholders=expression_attribute_names,
-#             attribute_value_placeholders=expression_attribute_values,
-#         )
-
-#     def _build_expression(
-#         self,
-#         condition,
-#         expression_attribute_names,
-#         expression_attribute_values,
-#     ):
-#         expression_dict = condition.get_expression()
-#         replaced_values = []
-#         for value in expression_dict['values']:
-#             # Recurse for each value in the expression.
-#             replaced_value = self._build_expression_component(
-#                 condition,
-#                 value,
-#                 expression_attribute_names,
-#                 expression_attribute_values,
-#             )
-#             replaced_values.append(replaced_value)
-#         # Fill out the expression using the operator and its recursive expressions.
-#         return expression_dict['format'].format(
-#             *replaced_values, operator=expression_dict['operator']
-#         )
-
-#     def _build_expression_component(
-#         self,
-#         condition,
-#         value,
-#         expression_attribute_names,
-#         expression_attribute_values,
-#     ):
-#         # Continue to recurse if the value is a ConditionBase in order
-#         # to extract out all parts of the expression.
-#         if isinstance(value, ConditionBase):
-#             return self._build_expression(
-#                 value,
-#             )
-#         # If it is not a ConditionBase, we can recurse no further.
-#         # If it's an attribute, insert its name.
-#         elif isinstance(value, AttributeBase):
-#             return self._build_name_placeholder(
-#                 value, attribute_name_placeholders
-#             )
-#         # If it is anything else, we treat it as a value.
-#         else:
-#             if condition.has_grouped_values:
-#                 # Assuming the values are grouped by parenthesis.
-#                 # IN is the currently the only one that uses this so it maybe
-#                 # needed to be changed in future.
-#                 return '(' + ', '.join(value) + ')'
-#             return value
-
-#     def _build_value_placeholder(
-#         self, value, attribute_value_placeholders, has_grouped_values=False
-#     ):
-#         # If the values are grouped, we need to add a placeholder for
-#         # each element inside of the actual value.
-#         if has_grouped_values:
-#             placeholder_list = []
-#             for v in value:
-#                 value_placeholder = self._get_value_placeholder()
-#                 self._value_count += 1
-#                 placeholder_list.append(value_placeholder)
-#                 attribute_value_placeholders[value_placeholder] = v
-#             # Assuming the values are grouped by parenthesis.
-#             # IN is the currently the only one that uses this so it maybe
-#             # needed to be changed in future.
-#             return '(' + ', '.join(placeholder_list) + ')'
-#         # Otherwise, treat the value as a single value that needs only
-#         # one placeholder.
-#         else:
-#             value_placeholder = self._get_value_placeholder()
-#             self._value_count += 1
-#             attribute_value_placeholders[value_placeholder] = value
-#             return value_placeholder

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/transform.py

@@ -13,7 +13,7 @@
 
 
 def dict_to_ddb(item: dict[str, Any]) -> dict[str, Any]:
-    """Converts a native Python dictionary to a DynamoDB-JSON item.
+    """Convert a native Python dictionary to a DynamoDB-JSON item.
 
     Args:
         item (Dict[str, Any]): Native Python dictionary.
@@ -27,7 +27,7 @@ def dict_to_ddb(item: dict[str, Any]) -> dict[str, Any]:
 
 
 def list_of_dict_to_list_of_ddb(items: list[dict[str, Any]]) -> list[dict[str, Any]]:
-    """Converts a list of Python dictionaries into a list of DynamoDB-JSON formatted items.
+    """Convert a list of Python dictionaries into a list of DynamoDB-JSON formatted items.
 
     Args:
         items (List[Dict[str, Any]]): List of native Python dictionaries.
@@ -40,7 +40,7 @@ def list_of_dict_to_list_of_ddb(items: list[dict[str, Any]]) -> list[dict[str, A
 
 
 def ddb_to_dict(item: dict[str, Any]) -> dict[str, Any]:
-    """Converts a DynamoDB-JSON item to a native Python dictionary.
+    """Convert a DynamoDB-JSON item to a native Python dictionary.
 
     Args:
         item (Dict[str, Any]): DynamoDB-formatted item.
@@ -54,7 +54,7 @@ def ddb_to_dict(item: dict[str, Any]) -> dict[str, Any]:
 
 
 def list_of_ddb_to_list_of_dict(items: list[dict[str, Any]]) -> list[dict[str, Any]]:
-    """Converts a list of DynamoDB-JSON formatted items to a list of Python dictionaries.
+    """Convert a list of DynamoDB-JSON formatted items to a list of Python dictionaries.
 
     Args:
         items (List[Dict[str, Any]]): List of DynamoDB-formatted items.