add type hints to '_semconv'

Author: herin049

instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py

@@ -129,18 +129,18 @@ def response_hook(span: Span, params: typing.Union[
     HTTP_DURATION_HISTOGRAM_BUCKETS_OLD,
     _client_duration_attrs_new,
     _client_duration_attrs_old,
-    _filter_semconv_duration_attrs,  # type: ignore[reportUnknownVariableType]
+    _filter_semconv_duration_attrs,
     _get_schema_url,
     _OpenTelemetrySemanticConventionStability,
     _OpenTelemetryStabilitySignalType,
     _report_new,
     _report_old,
-    _set_http_host_client,  # type: ignore[reportUnknownVariableType]
-    _set_http_method,  # type: ignore[reportUnknownVariableType]
-    _set_http_net_peer_name_client,  # type: ignore[reportUnknownVariableType]
-    _set_http_peer_port_client,  # type: ignore[reportUnknownVariableType]
-    _set_http_url,  # type: ignore[reportUnknownVariableType]
-    _set_status,  # type: ignore[reportUnknownVariableType]
+    _set_http_host_client,
+    _set_http_method,
+    _set_http_net_peer_name_client,
+    _set_http_peer_port_client,
+    _set_http_url,
+    _set_status,
     _StabilityMode,
 )
 from opentelemetry.instrumentation.aiohttp_client.package import _instruments

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_semconv.py

@@ -15,6 +15,7 @@
 import os
 import threading
 from enum import Enum
+from typing import Container, Mapping
 
 from opentelemetry.instrumentation.utils import http_status_to_status_code
 from opentelemetry.semconv._incubating.attributes.http_attributes import (
@@ -63,7 +64,9 @@
     USER_AGENT_ORIGINAL,
 )
 from opentelemetry.semconv.schemas import Schemas
+from opentelemetry.trace import Span
 from opentelemetry.trace.status import Status, StatusCode
+from opentelemetry.util.types import AttributeValue
 
 # Values defined in milliseconds
 HTTP_DURATION_HISTOGRAM_BUCKETS_OLD = (
@@ -259,11 +262,11 @@ def _get_opentelemetry_stability_opt_in_mode(
 
 
 def _filter_semconv_duration_attrs(
-    attrs,
-    old_attrs,
-    new_attrs,
-    sem_conv_opt_in_mode=_StabilityMode.DEFAULT,
-):
+    attrs: Mapping[str, AttributeValue],
+    old_attrs: Container[AttributeValue],
+    new_attrs: Container[AttributeValue],
+    sem_conv_opt_in_mode: _StabilityMode = _StabilityMode.DEFAULT,
+) -> dict[str, AttributeValue]:
     filtered_attrs = {}
     # duration is two different metrics depending on sem_conv_opt_in_mode, so no DUP attributes
     allowed_attributes = (
@@ -276,11 +279,11 @@ def _filter_semconv_duration_attrs(
 
 
 def _filter_semconv_active_request_count_attr(
-    attrs,
-    old_attrs,
-    new_attrs,
-    sem_conv_opt_in_mode=_StabilityMode.DEFAULT,
-):
+    attrs: Mapping[str, AttributeValue],
+    old_attrs: Container[AttributeValue],
+    new_attrs: Container[AttributeValue],
+    sem_conv_opt_in_mode: _StabilityMode = _StabilityMode.DEFAULT,
+) -> dict[str, AttributeValue]:
     filtered_attrs = {}
     if _report_old(sem_conv_opt_in_mode):
         for key, val in attrs.items():
@@ -293,20 +296,29 @@ def _filter_semconv_active_request_count_attr(
     return filtered_attrs
 
 
-def set_string_attribute(result, key, value):
+def set_string_attribute(
+    result: Mapping[str, AttributeValue], key: str, value: AttributeValue
+) -> None:
     if value:
         result[key] = value
 
 
-def set_int_attribute(result, key, value):
+def set_int_attribute(
+    result: dict[str, AttributeValue], key: str, value: AttributeValue
+) -> None:
     if value:
         try:
             result[key] = int(value)
         except ValueError:
             return
 
 
-def _set_http_method(result, original, normalized, sem_conv_opt_in_mode):
+def _set_http_method(
+    result: dict[str, AttributeValue],
+    original: str,
+    normalized: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     original = original.strip()
     normalized = normalized.strip()
     # See https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes
@@ -320,35 +332,55 @@ def _set_http_method(result, original, normalized, sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_REQUEST_METHOD, normalized)
 
 
-def _set_http_status_code(result, code, sem_conv_opt_in_mode):
+def _set_http_status_code(
+    result: dict[str, AttributeValue],
+    code: str | int,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_int_attribute(result, HTTP_STATUS_CODE, code)
     if _report_new(sem_conv_opt_in_mode):
         set_int_attribute(result, HTTP_RESPONSE_STATUS_CODE, code)
 
 
-def _set_http_url(result, url, sem_conv_opt_in_mode):
+def _set_http_url(
+    result: dict[str, AttributeValue],
+    url: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_URL, url)
     if _report_new(sem_conv_opt_in_mode):
         set_string_attribute(result, URL_FULL, url)
 
 
-def _set_http_scheme(result, scheme, sem_conv_opt_in_mode):
+def _set_http_scheme(
+    result: dict[str, AttributeValue],
+    scheme: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_SCHEME, scheme)
     if _report_new(sem_conv_opt_in_mode):
         set_string_attribute(result, URL_SCHEME, scheme)
 
 
-def _set_http_flavor_version(result, version, sem_conv_opt_in_mode):
+def _set_http_flavor_version(
+    result: dict[str, AttributeValue],
+    version: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_FLAVOR, version)
     if _report_new(sem_conv_opt_in_mode):
         set_string_attribute(result, NETWORK_PROTOCOL_VERSION, version)
 
 
-def _set_http_user_agent(result, user_agent, sem_conv_opt_in_mode):
+def _set_http_user_agent(
+    result: dict[str, AttributeValue],
+    user_agent: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_USER_AGENT, user_agent)
     if _report_new(sem_conv_opt_in_mode):
@@ -358,28 +390,44 @@ def _set_http_user_agent(result, user_agent, sem_conv_opt_in_mode):
 # Client
 
 
-def _set_http_host_client(result, host, sem_conv_opt_in_mode):
+def _set_http_host_client(
+    result: dict[str, AttributeValue],
+    host: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_HOST, host)
     if _report_new(sem_conv_opt_in_mode):
         set_string_attribute(result, SERVER_ADDRESS, host)
 
 
-def _set_http_net_peer_name_client(result, peer_name, sem_conv_opt_in_mode):
+def _set_http_net_peer_name_client(
+    result: dict[str, AttributeValue],
+    peer_name: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, NET_PEER_NAME, peer_name)
     if _report_new(sem_conv_opt_in_mode):
         set_string_attribute(result, SERVER_ADDRESS, peer_name)
 
 
-def _set_http_peer_port_client(result, port, sem_conv_opt_in_mode):
+def _set_http_peer_port_client(
+    result: dict[str, AttributeValue],
+    port: str | int,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_int_attribute(result, NET_PEER_PORT, port)
     if _report_new(sem_conv_opt_in_mode):
         set_int_attribute(result, SERVER_PORT, port)
 
 
-def _set_http_network_protocol_version(result, version, sem_conv_opt_in_mode):
+def _set_http_network_protocol_version(
+    result: dict[str, AttributeValue],
+    version: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_FLAVOR, version)
     if _report_new(sem_conv_opt_in_mode):
@@ -389,21 +437,35 @@ def _set_http_network_protocol_version(result, version, sem_conv_opt_in_mode):
 # Server
 
 
-def _set_http_net_host(result, host, sem_conv_opt_in_mode):
+def _set_http_net_host(
+    result: dict[str, AttributeValue],
+    host: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, NET_HOST_NAME, host)
     if _report_new(sem_conv_opt_in_mode):
         set_string_attribute(result, SERVER_ADDRESS, host)
 
 
-def _set_http_net_host_port(result, port, sem_conv_opt_in_mode):
+def _set_http_net_host_port(
+    result: dict[str, AttributeValue],
+    port: str | int,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_int_attribute(result, NET_HOST_PORT, port)
     if _report_new(sem_conv_opt_in_mode):
         set_int_attribute(result, SERVER_PORT, port)
 
 
-def _set_http_target(result, target, path, query, sem_conv_opt_in_mode):
+def _set_http_target(
+    result: dict[str, AttributeValue],
+    target: str,
+    path: str | None,
+    query: str | None,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_TARGET, target)
     if _report_new(sem_conv_opt_in_mode):
@@ -413,7 +475,11 @@ def _set_http_target(result, target, path, query, sem_conv_opt_in_mode):
             set_string_attribute(result, URL_QUERY, query)
 
 
-def _set_http_host_server(result, host, sem_conv_opt_in_mode):
+def _set_http_host_server(
+    result: dict[str, AttributeValue],
+    host: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, HTTP_HOST, host)
     if _report_new(sem_conv_opt_in_mode):
@@ -426,7 +492,11 @@ def _set_http_host_server(result, host, sem_conv_opt_in_mode):
 # net.sock.peer.addr -> client.socket.address for server spans (TODO) AND client.address if missing
 # https://github.com/open-telemetry/semantic-conventions/blob/v1.21.0/CHANGELOG.md#v1210-2023-07-13
 # https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/http-migration.md#common-attributes-across-http-client-and-server-spans
-def _set_http_peer_ip_server(result, ip, sem_conv_opt_in_mode):
+def _set_http_peer_ip_server(
+    result: dict[str, AttributeValue],
+    ip: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, NET_PEER_IP, ip)
     if _report_new(sem_conv_opt_in_mode):
@@ -435,28 +505,36 @@ def _set_http_peer_ip_server(result, ip, sem_conv_opt_in_mode):
             set_string_attribute(result, CLIENT_ADDRESS, ip)
 
 
-def _set_http_peer_port_server(result, port, sem_conv_opt_in_mode):
+def _set_http_peer_port_server(
+    result: dict[str, AttributeValue],
+    port: str | int,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_int_attribute(result, NET_PEER_PORT, port)
     if _report_new(sem_conv_opt_in_mode):
         set_int_attribute(result, CLIENT_PORT, port)
 
 
-def _set_http_net_peer_name_server(result, name, sem_conv_opt_in_mode):
+def _set_http_net_peer_name_server(
+    result: dict[str, AttributeValue],
+    name: str,
+    sem_conv_opt_in_mode: _StabilityMode,
+) -> None:
     if _report_old(sem_conv_opt_in_mode):
         set_string_attribute(result, NET_PEER_NAME, name)
     if _report_new(sem_conv_opt_in_mode):
         set_string_attribute(result, CLIENT_ADDRESS, name)
 
 
 def _set_status(
-    span,
-    metrics_attributes: dict,
+    span: Span,
+    metrics_attributes: dict[str, AttributeValue],
     status_code: int,
     status_code_str: str,
     server_span: bool = True,
     sem_conv_opt_in_mode: _StabilityMode = _StabilityMode.DEFAULT,
-):
+) -> None:
     if status_code < 0:
         if _report_new(sem_conv_opt_in_mode):
             metrics_attributes[ERROR_TYPE] = status_code_str