lint

Author: blairhyy-amazon

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/_aws_metric_attribute_generator.py

@@ -530,7 +530,7 @@ def _set_remote_type_and_identifier(span: ReadableSpan, attributes: BoundedAttri
 
 
 def _set_remote_account_id_and_region(span: ReadableSpan, attributes: BoundedAttributes) -> bool:
-    ARN_ATTRIBUTES = [
+    arn_attributes = [
         AWS_DYNAMODB_TABLE_ARN,
         AWS_KINESIS_STREAM_ARN,
         AWS_SNS_TOPIC_ARN,
@@ -548,7 +548,7 @@ def _set_remote_account_id_and_region(span: ReadableSpan, attributes: BoundedAtt
         remote_account_id = SqsUrlParser.get_account_id(queue_url)
         remote_region = SqsUrlParser.get_region(queue_url)
     else:
-        for arn_attribute in ARN_ATTRIBUTES:
+        for arn_attribute in arn_attributes:
             if is_key_present(span, arn_attribute):
                 arn = span.attributes.get(arn_attribute)
                 remote_account_id = RegionalResourceArnParser.get_account_id(arn)

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/patches/_botocore_patches.py

@@ -44,10 +44,7 @@
     _BotoResultT,
 )
 from opentelemetry.instrumentation.botocore.utils import get_server_attributes
-from opentelemetry.instrumentation.utils import (
-    is_instrumentation_enabled,
-    suppress_http_instrumentation,
-)
+from opentelemetry.instrumentation.utils import is_instrumentation_enabled, suppress_http_instrumentation
 from opentelemetry.semconv.trace import SpanAttributes
 from opentelemetry.trace.span import Span
 
@@ -250,6 +247,7 @@ def patch_on_success(self, span: Span, result: _BotoResultT, instrumentor_contex
 
 
 def _apply_botocore_api_call_patch() -> None:
+    # pylint: disable=too-many-locals
     def patched_api_call(self, original_func, instance, args, kwargs):
         """Botocore instrumentation patch to capture AWS authentication details
 
@@ -262,7 +260,9 @@ def patched_api_call(self, original_func, instance, args, kwargs):
         1. Propose refactoring upstream _patched_api_call into smaller components
         2. Apply targeted patches to these components to reduce code duplication
 
-        Reference: https://github.com/open-telemetry/opentelemetry-python-contrib/blob/release/v1.33.x-0.54bx/instrumentation/opentelemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/__init__.py#L263
+        Reference: https://github.com/open-telemetry/opentelemetry-python-contrib/blob/
+        release/v1.33.x-0.54bx/instrumentation/opentelemetry-instrumentation-botocore/src/
+        opentelemetry/instrumentation/botocore/__init__.py#L263
         """
         if not is_instrumentation_enabled():
             return original_func(*args, **kwargs)
@@ -284,8 +284,8 @@ def patched_api_call(self, original_func, instance, args, kwargs):
             **get_server_attributes(call_context.endpoint_url),
             AWS_AUTH_REGION: call_context.region,
         }
-        credentials = instance._get_credentials()
 
+        credentials = instance._get_credentials()
         if credentials is not None:
             access_key = credentials.access_key
             if access_key is not None:

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/sqs_url_parser.py

@@ -19,8 +19,8 @@ def get_queue_name(url: str) -> Optional[str]:
         """
         if url is None:
             return None
-        urlWithoutProtocol = url.replace(_HTTP_SCHEMA, "").replace(_HTTPS_SCHEMA, "")
-        split_url: List[Optional[str]] = urlWithoutProtocol.split("/")
+        url_without_protocol = url.replace(_HTTP_SCHEMA, "").replace(_HTTPS_SCHEMA, "")
+        split_url: List[Optional[str]] = url_without_protocol.split("/")
         if len(split_url) == 3 and is_account_id(split_url[1]) and _is_valid_queue_name(split_url[2]):
             return split_url[2]
         return None
@@ -48,8 +48,8 @@ def parse_url(url: str) -> Tuple[Optional[str], Optional[str], Optional[str]]:
         if url is None:
             return None, None, None
 
-        urlWithoutProtocol = url.replace(_HTTP_SCHEMA, "").replace(_HTTPS_SCHEMA, "")
-        split_url: List[Optional[str]] = urlWithoutProtocol.split("/")
+        url_without_protocol = url.replace(_HTTP_SCHEMA, "").replace(_HTTPS_SCHEMA, "")
+        split_url: List[Optional[str]] = url_without_protocol.split("/")
         if (
             len(split_url) != 3
             or not is_account_id(split_url[1])

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_instrumentation_patch.py

@@ -275,8 +275,8 @@ def _test_patched_api_call_with_credentials(self):
         args = ("operation_name",)
         kwargs = {}
         initial_attributes = {}
-        mock_extension = self._get_mock_extension()
-        mock_call_context = self._get_mock_call_context()
+        mock_extension = _get_mock_extension()
+        mock_call_context = _get_mock_call_context()
 
         def mock_start_span(*args, **kwargs):
             attributes = kwargs.get("attributes", {})
@@ -326,8 +326,8 @@ def _test_patched_api_call_with_no_credentials(self):
         args = ("operation_name",)
         kwargs = {}
         initial_attributes = {}
-        mock_extension = self._get_mock_extension()
-        mock_call_context = self._get_mock_call_context()
+        mock_extension = _get_mock_extension()
+        mock_call_context = _get_mock_call_context()
 
         def mock_start_span(*args, **kwargs):
             attributes = kwargs.get("attributes", {})
@@ -372,8 +372,8 @@ def _test_patched_api_call_with_no_access_key(self):
         args = ("operation_name",)
         kwargs = {}
         initial_attributes = {}
-        mock_extension = self._get_mock_extension()
-        mock_call_context = self._get_mock_call_context()
+        mock_extension = _get_mock_extension()
+        mock_call_context = _get_mock_call_context()
 
         def mock_start_span(*args, **kwargs):
             attributes = kwargs.get("attributes", {})
@@ -411,34 +411,6 @@ def mock_start_span(*args, **kwargs):
             self.assertTrue("aws.region" in initial_attributes)
             instrumentor.uninstrument()
 
-    def _get_mock_extension(self):
-        # Mock extension
-        mock_extension = MagicMock()
-        mock_extension.should_trace_service_call.return_value = True
-        mock_extension.tracer_schema_version.return_value = "1.0.0"
-        mock_extension.event_logger_schema_version.return_value = "1.0.0"
-        mock_extension.meter_schema_version.return_value = "1.0.0"
-        mock_extension.should_end_span_on_exit.return_value = True
-        mock_extension.extract_attributes = lambda x: None
-        mock_extension.before_service_call = lambda *args, **kwargs: None
-        mock_extension.after_service_call = lambda *args, **kwargs: None
-        mock_extension.on_success = lambda *args, **kwargs: None
-        mock_extension.on_error = lambda *args, **kwargs: None
-        mock_extension.setup_metrics = lambda meter, metrics: None
-        return mock_extension
-
-    def _get_mock_call_context(self):
-        # Mock call context
-        mock_call_context = MagicMock()
-        mock_call_context.service = "test-service"
-        mock_call_context.service_id = "test-service"
-        mock_call_context.operation = "test-operation"
-        mock_call_context.region = "us-west-2"
-        mock_call_context.span_name = "test-span"
-        mock_call_context.span_kind = "CLIENT"
-        mock_call_context.endpoint_url = "https://www.awsmocktest.com"
-        return mock_call_context
-
     def _test_patched_gevent_os_ssl_instrumentation(self):
         # Only ssl and os module should have been patched since the environment variable was set to 'os, ssl'
         self.assertTrue(gevent.monkey.is_module_patched("ssl"), "gevent ssl module has not been patched")
@@ -711,3 +683,33 @@ def set_side_effect(set_key, set_value):
     extension.on_success(span_mock, result, mock_instrumentor_context)
 
     return span_attributes
+
+
+def _get_mock_extension():
+    # Mock extension
+    mock_extension = MagicMock()
+    mock_extension.should_trace_service_call.return_value = True
+    mock_extension.tracer_schema_version.return_value = "1.0.0"
+    mock_extension.event_logger_schema_version.return_value = "1.0.0"
+    mock_extension.meter_schema_version.return_value = "1.0.0"
+    mock_extension.should_end_span_on_exit.return_value = True
+    mock_extension.extract_attributes = lambda x: None
+    mock_extension.before_service_call = lambda *args, **kwargs: None
+    mock_extension.after_service_call = lambda *args, **kwargs: None
+    mock_extension.on_success = lambda *args, **kwargs: None
+    mock_extension.on_error = lambda *args, **kwargs: None
+    mock_extension.setup_metrics = lambda meter, metrics: None
+    return mock_extension
+
+
+def _get_mock_call_context():
+    # Mock call context
+    mock_call_context = MagicMock()
+    mock_call_context.service = "test-service"
+    mock_call_context.service_id = "test-service"
+    mock_call_context.operation = "test-operation"
+    mock_call_context.region = "us-west-2"
+    mock_call_context.span_name = "test-span"
+    mock_call_context.span_kind = "CLIENT"
+    mock_call_context.endpoint_url = "https://www.awsmocktest.com"
+    return mock_call_context

aws-opentelemetry-distro/tests/amazon/opentelemetry/distro/test_regional_resource_arn_parser.py

@@ -1,3 +1,6 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
 from unittest import TestCase
 
 from amazon.opentelemetry.distro.regional_resource_arn_parser import RegionalResourceArnParser
@@ -6,35 +9,35 @@
 class TestRegionalResourceArnParser(TestCase):
     def test_get_account_id(self):
         # Test invalid ARN formats
-        self.validateGetAccountId(None, None)
-        self.validateGetAccountId("", None)
-        self.validateGetAccountId(" ", None)
-        self.validateGetAccountId(":", None)
-        self.validateGetAccountId("::::::", None)
-        self.validateGetAccountId("not:an:arn:string", None)
-        self.validateGetAccountId("arn:aws:ec2:us-west-2:123456", None)
-        self.validateGetAccountId("arn:aws:ec2:us-west-2:1234567xxxxx", None)
-        self.validateGetAccountId("arn:aws:ec2:us-west-2:123456789012", None)
+        self.validate_get_account_id(None, None)
+        self.validate_get_account_id("", None)
+        self.validate_get_account_id(" ", None)
+        self.validate_get_account_id(":", None)
+        self.validate_get_account_id("::::::", None)
+        self.validate_get_account_id("not:an:arn:string", None)
+        self.validate_get_account_id("arn:aws:ec2:us-west-2:123456", None)
+        self.validate_get_account_id("arn:aws:ec2:us-west-2:1234567xxxxx", None)
+        self.validate_get_account_id("arn:aws:ec2:us-west-2:123456789012", None)
 
         # Test valid ARN formats
-        self.validateGetAccountId("arn:aws:dynamodb:us-west-2:123456789012:table/test_table", "123456789012")
-        self.validateGetAccountId("arn:aws:acm:us-east-1:123456789012:certificate:abc-123", "123456789012")
+        self.validate_get_account_id("arn:aws:dynamodb:us-west-2:123456789012:table/test_table", "123456789012")
+        self.validate_get_account_id("arn:aws:acm:us-east-1:123456789012:certificate:abc-123", "123456789012")
 
     def test_get_region(self):
         # Test invalid ARN formats
-        self.validateGetRegion(None, None)
-        self.validateGetRegion("", None)
-        self.validateGetRegion(" ", None)
-        self.validateGetRegion(":", None)
-        self.validateGetRegion("::::::", None)
-        self.validateGetRegion("not:an:arn:string", None)
-        self.validateGetRegion("arn:aws:ec2:us-west-2:123456", None)
-        self.validateGetRegion("arn:aws:ec2:us-west-2:1234567xxxxx", None)
-        self.validateGetRegion("arn:aws:ec2:us-west-2:123456789012", None)
+        self.validate_get_region(None, None)
+        self.validate_get_region("", None)
+        self.validate_get_region(" ", None)
+        self.validate_get_region(":", None)
+        self.validate_get_region("::::::", None)
+        self.validate_get_region("not:an:arn:string", None)
+        self.validate_get_region("arn:aws:ec2:us-west-2:123456", None)
+        self.validate_get_region("arn:aws:ec2:us-west-2:1234567xxxxx", None)
+        self.validate_get_region("arn:aws:ec2:us-west-2:123456789012", None)
 
         # Test valid ARN formats
-        self.validateGetRegion("arn:aws:dynamodb:us-west-2:123456789012:table/test_table", "us-west-2")
-        self.validateGetRegion("arn:aws:acm:us-east-1:123456789012:certificate:abc-123", "us-east-1")
+        self.validate_get_region("arn:aws:dynamodb:us-west-2:123456789012:table/test_table", "us-west-2")
+        self.validate_get_region("arn:aws:acm:us-east-1:123456789012:certificate:abc-123", "us-east-1")
 
     def test_extract_dynamodb_table_name_from_arn(self):
         # Test invalid ARN formats
@@ -89,8 +92,8 @@ def validate_kinesis_stream_name(self, arn, expected_name):
     def validate_resource_name(self, arn, expected_name):
         self.assertEqual(RegionalResourceArnParser.extract_resource_name_from_arn(arn), expected_name)
 
-    def validateGetRegion(self, arn, expected_region):
+    def validate_get_region(self, arn, expected_region):
         self.assertEqual(RegionalResourceArnParser.get_region(arn), expected_region)
 
-    def validateGetAccountId(self, arn, expected_account_id):
+    def validate_get_account_id(self, arn, expected_account_id):
         self.assertEqual(RegionalResourceArnParser.get_account_id(arn), expected_account_id)