m

Author: Lucas McDonald

.github/workflows/ci_test_python.yml

@@ -27,18 +27,17 @@ jobs:
         library: [DynamoDbEncryption]
         python-version: ["3.11"]
         os: [
-          # macos-13,
-          ubuntu-22.04,
-          # Dafny-transpiled Python tests use a PYTHONPATH hack that doesn't work on Windows.
-          # Windows is tested with non-Dafny-transpiled Python tests.
-          # windows-latest
-        ]
+            # macos-13,
+            ubuntu-22.04,
+            # Dafny-transpiled Python tests use a PYTHONPATH hack that doesn't work on Windows.
+            # Windows is tested with non-Dafny-transpiled Python tests.
+            # windows-latest
+          ]
     runs-on: ${{ matrix.os }}
     permissions:
       id-token: write
       contents: read
     steps:
-
       - name: Support longpaths on Git checkout
         run: |
           git config --global core.longpaths true
@@ -127,4 +126,3 @@ jobs:
           tox -e encrypted-interface-coverage
           tox -e client-to-resource-conversions-coverage
           tox -e resource-to-client-conversions-coverage
-

DynamoDbEncryption/runtimes/python/README.md

@@ -21,8 +21,8 @@ Please **do not** create a public GitHub issue.
 
 ### Required Prerequisites
 
-* Python 3.11+
-* aws-cryptographic-material-providers 1.10.0+
+- Python 3.11+
+- aws-cryptographic-material-providers 1.10.0+
 
 ### Installation
 

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

@@ -101,16 +101,16 @@ def put_item(self, **kwargs) -> dict[str, Any]:
         """
         Put a single item to a table. Encrypts the item before writing to DynamoDB.
 
-        The parameters and return value match the boto3 DynamoDB put_item API:
+        The input and output dicts' keys match the input and output dicts' keys for the boto3 DynamoDB `put_item` API:
 
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/put_item.html
 
         Args:
-            **kwargs: Keyword arguments to pass to the operation. These match the boto3 put_item API parameters.
+            **kwargs: Keyword arguments to pass to the operation. These match the boto3 `put_item` API parameters' argument names.
             The "Item" argument will be encrypted locally before being written to DynamoDB.
 
         Returns:
-            dict: The response from DynamoDB. This matches the boto3 put_item API response.
+            dict: The response from DynamoDB. This matches the boto3 `put_item` API response shape.
 
         """
         return self._client_operation_logic(
@@ -131,6 +131,7 @@ def get_item(self, **kwargs) -> dict[str, Any]:
         Get a single item from a table. Decrypts the item after reading from DynamoDB.
 
         The parameters and return value match the boto3 DynamoDB get_item API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/get_item.html
 
         Args:
@@ -159,6 +160,7 @@ def query(self, **kwargs) -> dict[str, Any]:
         Query items from a table or index. Decrypts any returned items.
 
         The parameters and return value match the boto3 DynamoDB query API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/query.html
 
         Args:
@@ -187,6 +189,7 @@ def scan(self, **kwargs) -> dict[str, Any]:
         Scan an entire table or index. Decrypts any returned items.
 
         The parameters and return value match the boto3 DynamoDB scan API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/scan.html
 
         Args:
@@ -217,6 +220,7 @@ def batch_write_item(self, **kwargs) -> dict[str, Any]:
         For put operations, encrypts items before writing.
 
         The parameters and return value match the boto3 DynamoDB batch_write_item API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/batch_write_item.html
 
         Args:
@@ -246,6 +250,7 @@ def batch_get_item(self, **kwargs) -> dict[str, Any]:
         Get multiple items from one or more tables. Decrypts any returned items.
 
         The parameters and return value match the boto3 DynamoDB batch_get_item API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/batch_get_item.html
 
         Args:
@@ -274,6 +279,7 @@ def transact_get_items(self, **kwargs) -> dict[str, Any]:
         Get multiple items in a single transaction. Decrypts any returned items.
 
         The parameters and return value match the boto3 DynamoDB transact_get_items API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/transact_get_items.html
 
         Args:
@@ -304,6 +310,7 @@ def transact_write_items(self, **kwargs) -> dict[str, Any]:
         For put operations, encrypts items before writing.
 
         The parameters and return value match the boto3 DynamoDB transact_write_items API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/transact_write_items.html
 
         Args:

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

@@ -31,7 +31,7 @@ def __init__(
         item_encryptor_config: DynamoDbItemEncryptorConfig,
     ):
         """
-        Create an ItemEncryptor.
+        Create an `ItemEncryptor`.
 
         Args:
             item_encryptor_config (DynamoDbItemEncryptorConfig): Encryption configuration object.
@@ -58,8 +58,8 @@ def encrypt_python_item(
         boto3 DynamoDB Tables and Resources expect items formatted as native Python dictionaries.
         Use this method to encrypt an item if you intend to pass the encrypted item
         to a boto3 DynamoDB Table or Resource interface to store it.
-        (Alternatively, you can use this library's EncryptedTable or EncryptedResource interfaces
-        to transparently encrypt items without an intermediary ItemEncryptor.)
+        (Alternatively, you can use this library's `EncryptedTable` or `EncryptedResource` interfaces
+        to transparently encrypt items without an intermediary `ItemEncryptor`.)
 
         Args:
             plaintext_dict_item (dict[str, Any]): A standard Python dictionary.
@@ -100,8 +100,8 @@ def encrypt_dynamodb_item(
 
         Use this method to encrypt an item if you intend to pass the encrypted item
         to a boto3 DynamoDB client to store it.
-        (Alternatively, you can use this library's EncryptedClient interface
-        to transparently encrypt items without an intermediary ItemEncryptor.)
+        (Alternatively, you can use this library's `EncryptedClient` interface
+        to transparently encrypt items without an intermediary `ItemEncryptor`.)
 
         Args:
             plaintext_dynamodb_item (dict[str, dict[str, Any]]): The item to encrypt formatted as DynamoDB JSON.
@@ -184,8 +184,8 @@ def decrypt_python_item(
         boto3 DynamoDB Tables and Resources return items formatted as native Python dictionaries.
         Use this method to decrypt an item if you retrieve the encrypted item
         from a boto3 DynamoDB Table or Resource interface.
-        (Alternatively, you can use this library's EncryptedTable or EncryptedResource interfaces
-        to transparently decrypt items without an intermediary ItemEncryptor.)
+        (Alternatively, you can use this library's `EncryptedTable` or `EncryptedResource` interfaces
+        to transparently decrypt items without an intermediary `ItemEncryptor`.)
 
         Args:
             encrypted_dict_item (dict[str, Any]): A standard Python dictionary with encrypted values.
@@ -226,8 +226,8 @@ def decrypt_dynamodb_item(
 
         Use this method to decrypt an item if you retrieved the encrypted item
         from a boto3 DynamoDB client.
-        (Alternatively, you can use this library's EncryptedClient interface
-        to transparently decrypt items without an intermediary ItemEncryptor.)
+        (Alternatively, you can use this library's `EncryptedClient` interface
+        to transparently decrypt items without an intermediary `ItemEncryptor`.)
 
         Args:
             encrypted_dynamodb_item (dict[str, dict[str, Any]]): The item to decrypt formatted as DynamoDB JSON.