Merge pull request #52 from DataDog/darcy.rayner/add-black-support

Autoformat files with black

Author: DarcyRaynerDD

.circleci/config.yml

@@ -32,6 +32,11 @@ jobs:
           command: |
             source venv/bin/activate
             flake8 datadog_lambda/
+      - run:
+          name: Check Formatting
+          command: |
+            source venv/bin/activate
+            ./scripts/check_format.sh
 
       - save_cache:
           paths:

datadog_lambda/constants.py

@@ -14,13 +14,13 @@ class SamplingPriority(object):
 
 # Datadog trace headers
 class TraceHeader(object):
-    TRACE_ID = 'x-datadog-trace-id'
-    PARENT_ID = 'x-datadog-parent-id'
-    SAMPLING_PRIORITY = 'x-datadog-sampling-priority'
+    TRACE_ID = "x-datadog-trace-id"
+    PARENT_ID = "x-datadog-parent-id"
+    SAMPLING_PRIORITY = "x-datadog-sampling-priority"
 
 
 # X-Ray subsegment to save Datadog trace metadata
 class XraySubsegment(object):
-    NAME = 'datadog-metadata'
-    KEY = 'trace'
-    NAMESPACE = 'datadog'
+    NAME = "datadog-metadata"
+    KEY = "trace"
+    NAMESPACE = "datadog"

datadog_lambda/tracing.py

@@ -9,11 +9,7 @@
 from aws_xray_sdk.core.lambda_launcher import LambdaContext
 
 from ddtrace import patch, tracer
-from datadog_lambda.constants import (
-    SamplingPriority,
-    TraceHeader,
-    XraySubsegment,
-)
+from datadog_lambda.constants import SamplingPriority, TraceHeader, XraySubsegment
 
 logger = logging.getLogger(__name__)
 
@@ -38,8 +34,11 @@ def _convert_xray_sampling(xray_sampled):
     """
     Convert X-Ray sampled (True/False) to its Datadog counterpart.
     """
-    return str(SamplingPriority.USER_KEEP) if xray_sampled \
+    return (
+        str(SamplingPriority.USER_KEEP)
+        if xray_sampled
         else str(SamplingPriority.USER_REJECT)
+    )
 
 
 def extract_dd_trace_context(event):
@@ -54,33 +53,31 @@ def extract_dd_trace_context(event):
     the correct context.
     """
     global dd_trace_context
-    headers = event.get('headers', {})
+    headers = event.get("headers", {})
     lowercase_headers = {k.lower(): v for k, v in headers.items()}
 
     trace_id = lowercase_headers.get(TraceHeader.TRACE_ID)
     parent_id = lowercase_headers.get(TraceHeader.PARENT_ID)
     sampling_priority = lowercase_headers.get(TraceHeader.SAMPLING_PRIORITY)
     if trace_id and parent_id and sampling_priority:
-        logger.debug('Extracted Datadog trace context from headers')
+        logger.debug("Extracted Datadog trace context from headers")
         dd_trace_context = {
-            'trace-id': trace_id,
-            'parent-id': parent_id,
-            'sampling-priority': sampling_priority,
+            "trace-id": trace_id,
+            "parent-id": parent_id,
+            "sampling-priority": sampling_priority,
         }
         xray_recorder.begin_subsegment(XraySubsegment.NAME)
         subsegment = xray_recorder.current_subsegment()
         subsegment.put_metadata(
-            XraySubsegment.KEY,
-            dd_trace_context,
-            XraySubsegment.NAMESPACE
+            XraySubsegment.KEY, dd_trace_context, XraySubsegment.NAMESPACE
         )
         xray_recorder.end_subsegment()
     else:
         # AWS Lambda runtime caches global variables between invocations,
         # reset to avoid using the context from the last invocation.
         dd_trace_context = {}
 
-    logger.debug('extracted dd trace context %s', dd_trace_context)
+    logger.debug("extracted dd trace context %s", dd_trace_context)
 
 
 def get_dd_trace_context():
@@ -96,28 +93,24 @@ def get_dd_trace_context():
     context to an outgoing request.
     """
     if not is_lambda_context():
-        logger.debug('get_dd_trace_context is only supported in LambdaContext')
+        logger.debug("get_dd_trace_context is only supported in LambdaContext")
         return {}
 
     global dd_trace_context
     xray_trace_entity = xray_recorder.get_trace_entity()  # xray (sub)segment
     if dd_trace_context:
         return {
-            TraceHeader.TRACE_ID:
-                dd_trace_context['trace-id'],
-            TraceHeader.PARENT_ID: _convert_xray_entity_id(
-                xray_trace_entity.id),
-            TraceHeader.SAMPLING_PRIORITY:
-                dd_trace_context['sampling-priority'],
+            TraceHeader.TRACE_ID: dd_trace_context["trace-id"],
+            TraceHeader.PARENT_ID: _convert_xray_entity_id(xray_trace_entity.id),
+            TraceHeader.SAMPLING_PRIORITY: dd_trace_context["sampling-priority"],
         }
     else:
         return {
-            TraceHeader.TRACE_ID: _convert_xray_trace_id(
-                xray_trace_entity.trace_id),
-            TraceHeader.PARENT_ID: _convert_xray_entity_id(
-                xray_trace_entity.id),
+            TraceHeader.TRACE_ID: _convert_xray_trace_id(xray_trace_entity.trace_id),
+            TraceHeader.PARENT_ID: _convert_xray_entity_id(xray_trace_entity.id),
             TraceHeader.SAMPLING_PRIORITY: _convert_xray_sampling(
-                xray_trace_entity.sampled),
+                xray_trace_entity.sampled
+            ),
         }
 
 
@@ -130,16 +123,16 @@ def set_correlation_ids():
     TODO: Remove me when Datadog tracer is natively supported in Lambda.
     """
     if not is_lambda_context():
-        logger.debug('set_correlation_ids is only supported in LambdaContext')
+        logger.debug("set_correlation_ids is only supported in LambdaContext")
         return
 
     context = get_dd_trace_context()
 
-    span = tracer.trace('dummy.span')
+    span = tracer.trace("dummy.span")
     span.trace_id = context[TraceHeader.TRACE_ID]
     span.span_id = context[TraceHeader.PARENT_ID]
 
-    logger.debug('correlation ids set')
+    logger.debug("correlation ids set")
 
 
 def inject_correlation_ids():
@@ -153,17 +146,19 @@ def inject_correlation_ids():
     # Override the log format of the AWS provided LambdaLoggerHandler
     root_logger = logging.getLogger()
     for handler in root_logger.handlers:
-        if handler.__class__.__name__ == 'LambdaLoggerHandler':
-            handler.setFormatter(logging.Formatter(
-                '[%(levelname)s]\t%(asctime)s.%(msecs)dZ\t%(aws_request_id)s\t'
-                '[dd.trace_id=%(dd.trace_id)s dd.span_id=%(dd.span_id)s]\t%(message)s\n',
-                '%Y-%m-%dT%H:%M:%S'
-            ))
+        if handler.__class__.__name__ == "LambdaLoggerHandler":
+            handler.setFormatter(
+                logging.Formatter(
+                    "[%(levelname)s]\t%(asctime)s.%(msecs)dZ\t%(aws_request_id)s\t"
+                    "[dd.trace_id=%(dd.trace_id)s dd.span_id=%(dd.span_id)s]\t%(message)s\n",
+                    "%Y-%m-%dT%H:%M:%S",
+                )
+            )
 
     # Patch `logging.Logger.makeRecord` to actually inject correlation ids
     patch(logging=True)
 
-    logger.debug('logs injection configured')
+    logger.debug("logs injection configured")
 
 
 def is_lambda_context():

datadog_lambda/wrapper.py

@@ -39,7 +39,6 @@ def my_lambda_handle(event, context):
 
 
 class _NoopDecorator(object):
-
     def __init__(self, func):
         self.func = func
 

scripts/check_format.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+set -e
+
+PYTHON_VERSION=$(python -c 'import sys; print(sys.version_info.major)')
+if [ "$PYTHON_VERSION" = "2" ]; then
+    echo "Skipping formatting, black not compatible with python 2"
+    exit 0
+fi
+pip install -Iv black==19.10b0
+
+python -m black --check datadog_lambda/
+python -m black --check tests
+
+
+

setup.py

@@ -6,40 +6,35 @@
 
 here = path.abspath(path.dirname(__file__))
 
-with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+with open(path.join(here, "README.md"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(
-    name='datadog_lambda',
+    name="datadog_lambda",
     version=__version__,
-    description='The Datadog AWS Lambda Layer',
+    description="The Datadog AWS Lambda Layer",
     long_description=long_description,
-    long_description_content_type='text/markdown',
-    url='https://github.com/DataDog/datadog-lambda-layer-python',
-    author='Datadog, Inc.',
-    author_email='dev@datadoghq.com',
+    long_description_content_type="text/markdown",
+    url="https://github.com/DataDog/datadog-lambda-layer-python",
+    author="Datadog, Inc.",
+    author_email="dev@datadoghq.com",
     classifiers=[
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
     ],
-    keywords='datadog aws lambda layer',
-    packages=['datadog_lambda'],
-    python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4',
+    keywords="datadog aws lambda layer",
+    packages=["datadog_lambda"],
+    python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4",
     install_requires=[
-        'aws-xray-sdk==2.4.3',
-        'datadog==0.32.0',
-        'ddtrace==0.31.0',
-        'wrapt==1.11.2',
-        'setuptools==42.0.2',
+        "aws-xray-sdk==2.4.3",
+        "datadog==0.32.0",
+        "ddtrace==0.31.0",
+        "wrapt==1.11.2",
+        "setuptools==42.0.2",
     ],
     extras_require={
-        'dev': [
-            'nose2==0.9.1',
-            'flake8==3.7.9',
-            'requests==2.22.0',
-            'boto3==1.10.33',
-        ]
-    }
+        "dev": ["nose2==0.9.1", "flake8==3.7.9", "requests==2.22.0", "boto3==1.10.33"]
+    },
 )

tests/test_patch.py

@@ -1,19 +1,16 @@
 import sys
 import unittest
+
 try:
     from unittest.mock import patch
 except ImportError:
     from mock import patch
 
-from datadog_lambda.patch import (
-    _patch_httplib,
-    _ensure_patch_requests,
-)
+from datadog_lambda.patch import _patch_httplib, _ensure_patch_requests
 from datadog_lambda.constants import TraceHeader
 
 
 class TestPatchHTTPClients(unittest.TestCase):
-
     def setUp(self):
         patcher = patch("datadog_lambda.patch.get_dd_trace_context")
         self.mock_get_dd_trace_context = patcher.start()
@@ -36,6 +33,7 @@ def test_patch_httplib(self):
     def test_patch_requests(self):
         _ensure_patch_requests()
         import requests
+
         r = requests.get("https://www.datadoghq.com/")
         self.mock_get_dd_trace_context.assert_called()
         self.assertEqual(r.request.headers[TraceHeader.TRACE_ID], "123")
@@ -45,6 +43,7 @@ def test_patch_requests(self):
     def test_patch_requests_with_headers(self):
         _ensure_patch_requests()
         import requests
+
         r = requests.get("https://www.datadoghq.com/", headers={"key": "value"})
         self.mock_get_dd_trace_context.assert_called()
         self.assertEqual(r.request.headers["key"], "value")
@@ -55,6 +54,7 @@ def test_patch_requests_with_headers(self):
     def test_patch_requests_with_headers_none(self):
         _ensure_patch_requests()
         import requests
+
         r = requests.get("https://www.datadoghq.com/", headers=None)
         self.mock_get_dd_trace_context.assert_called()
         self.assertEqual(r.request.headers[TraceHeader.TRACE_ID], "123")