Merge pull request #115 from gridsmartercities/fix_pyflakes_issue

Disabled pyflakes warning for 'ApiGatewayManagementApi', and added mi…

Author: jamsidedown

aws_lambda_decorators/decorators.py

@@ -338,6 +338,26 @@ def update_header(headers, header_name, value, value_type):
 
 
 def push_ws_errors(websocket_endpoint_url: str):
+    """
+    Handles and pushes any unsuccessful responses as errors to the calling client via websockets
+
+    Usage:
+        @push_ws_errors('https://api_id.execute_id.region.amazonaws.com/Prod')
+        @handle_all_exceptions()
+        def handler(event, context):
+            return {
+                'statusCode': 400,
+                'body': {
+                    'message': 'Bad request'
+                }
+            }
+
+    Args:
+        websocket_endpoint_url (str): The api gateway connection URL
+
+    Returns:
+        the original response from the lambda handler
+    """
     def decorator(func):
         def wrapper(*args, **kwargs):
             connection_id = find_websocket_connection_id(args)
@@ -365,6 +385,23 @@ def wrapper(*args, **kwargs):
 
 
 def push_ws_response(websocket_endpoint_url: str):
+    """
+    Handles and pushes all responses to the calling client via websockets
+
+    Usage:
+        @push_ws_response('https://api_id.execute_id.region.amazonaws.com/Prod')
+        def handler(event, context):
+            return {
+                'statusCode': 200,
+                'body': 'Hello, world!'
+            }
+
+    Args:
+        websocket_endpoint_url (str): The api gateway connection URL
+
+    Returns:
+        the original response from the lambda handler
+    """
     def decorator(func):
         def wrapper(*args, **kwargs):
             connection_id = find_websocket_connection_id(args)

aws_lambda_decorators/utils.py

@@ -136,7 +136,7 @@ def find_websocket_connection_id(args: list) -> str:
 
 
 @lru_cache()
-def get_websocket_endpoint(endpoint_url: str) -> "ApiGatewayManagementApi":  # I can't find this in botocore.client
+def get_websocket_endpoint(endpoint_url: str) -> "botocore.client.ApiGatewayManagementApi":  # noqa: pyflakes - F821
     """
     Gets an instance of ApiGatewayManagementApi for sending messages
     through websockets