wip lints

Author: Lucas McDonald

Diff for: DynamoDbEncryption/runtimes/python/pyproject.toml

@@ -45,6 +45,33 @@ myst-parser = "^4"
 sphinx = "^7"
 sphinx_rtd_theme = "^2"
 
+# Package linting
+
+[tool.poetry.group.linting]
+optional = true
+
+[tool.poetry.group.linting.dependencies]
+ruff = "^0.11.5"
+pydocstyle = "^6.3.0"
+black = "^25.1.0"
+
+[tool.ruff]
+exclude = [
+    # Don't lint Dafny-generated code
+    "internaldafny",
+    # Don't re-lint Smithy-generated code
+    "smithygenerated",
+]
+line-length=120
+indent-width=4
+target-version = "py311"
+
+[tool.pydocstyle]
+match-dir = "^(?!internal$|internaldafny$|smithygenerated$).*"
+
+[tool.black]
+exclude = "/(internal|internaldafny|smithygenerated)(/|$)"
+
 [build-system]
 requires = ["poetry-core<2.0.0"]
 build-backend = "poetry.core.masonry.api"

Diff for: DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/__init__.py

@@ -1,11 +1,13 @@
 # Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+"""AWS Database Encryption SDK for DynamoDB."""
+
 # Initialize generated Dafny
-from .internaldafny.generated import module_
+from .internaldafny.generated import module_  # noqa: F401
 
 # Initialize externs
-from .internaldafny import extern
+from .internaldafny import extern  # noqa: F401
 
 """
 boto3 uses Python's decimal library to deserialize numbers retrieved by resources
@@ -25,10 +27,10 @@
 Other DBESDK DynamoDB runtimes treat "Rounded" as acceptable, but "Inexact" as unacceptable.
 By default, boto3 will treat both "Rounded" and "Inexact" as unacceptable.
 
-For DBESDK DynamoDB, change the DynamoDB context to treat "Rounded" as acceptable.
+When using DBESDK DynamoDB, change the DynamoDB context to treat "Rounded" as acceptable.
 """
-import boto3.dynamodb.types
-from decimal import Rounded
+import boto3.dynamodb.types  # noqa: E402
+from decimal import Rounded  # noqa: E402
 
 old_context = boto3.dynamodb.types.DYNAMODB_CONTEXT
 old_traps = old_context.__getattribute__("traps")

Diff for: DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/encrypted/boto3_interface.py

@@ -1,21 +1,25 @@
 # Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
+"""Interface for interacting with DynamoDB using boto3."""
 import abc
 from typing import Any, Dict
 from abc import abstractmethod
 
+
 class EncryptedBotoInterface(abc.ABC):
     """Interface for encrypted boto3 interfaces."""
 
-    def _copy_sdk_response_to_dbesdk_response(self, sdk_response: Dict[str, Any], dbesdk_response: Dict[str, Any]) -> Dict[str, Any]:
+    def _copy_sdk_response_to_dbesdk_response(
+        self, sdk_response: Dict[str, Any], dbesdk_response: Dict[str, Any]
+    ) -> Dict[str, Any]:
         """Copy any missing fields from the SDK response to the DBESDK response.
 
         Args:
-            sdk_response: The raw SDK response
-            dbesdk_response: The current DBESDK response
+            sdk_response: The raw SDK response.
+            dbesdk_response: The current DBESDK response.
 
         Returns:
-            dict: The DBESDK response with any missing fields copied from SDK response
+            dict: The DBESDK response with any missing fields copied from SDK response.
         """
         for sdk_response_key, sdk_response_value in sdk_response.items():
             if sdk_response_key not in dbesdk_response:
@@ -42,4 +46,6 @@ def __getattr__(self, name: str) -> Any:
         client_attr = getattr(self, self._boto_client_attr_name)
         if hasattr(client_attr, name):
             return getattr(client_attr, name)
-        raise AttributeError(f"'{self.__class__.__name__}' object has no attribute '{name}'")
+        raise AttributeError(
+            f"'{self.__class__.__name__}' object has no attribute '{name}'"
+        )