add type checking for opentelemetry-exporter-otlp-json-common

Author: herin049

exporter/opentelemetry-exporter-otlp-json-common/src/opentelemetry/exporter/otlp/json/common/_internal/__init__.py

@@ -12,16 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 from __future__ import annotations
 
 import logging
 from collections.abc import Collection, Mapping, Sequence
 from typing import (
     Any,
-    Callable,
-    Optional,
-    TypeVar,
+    cast,
 )
 
 from opentelemetry.proto_json.common.v1.common import AnyValue as JSONAnyValue
@@ -40,16 +37,13 @@
 )
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
-from opentelemetry.util.types import _ExtendedAttributes
+from opentelemetry.util.types import Attributes
 
 _logger = logging.getLogger(__name__)
 
-_TypingResourceT = TypeVar("_TypingResourceT")
-_ResourceDataT = TypeVar("_ResourceDataT")
-
 
 def _encode_instrumentation_scope(
-    instrumentation_scope: InstrumentationScope,
+    instrumentation_scope: InstrumentationScope | None,
 ) -> JSONInstrumentationScope:
     return (
         JSONInstrumentationScope(
@@ -67,9 +61,7 @@ def _encode_resource(resource: Resource) -> JSONResource:
 
 
 # pylint: disable-next=too-many-return-statements
-def _encode_value(
-    value: Any, allow_null: bool = False
-) -> Optional[JSONAnyValue]:
+def _encode_value(value: Any, allow_null: bool = False) -> JSONAnyValue | None:
     if allow_null is True and value is None:
         return None
     if isinstance(value, bool):
@@ -85,7 +77,10 @@ def _encode_value(
     if isinstance(value, Sequence):
         return JSONAnyValue(
             array_value=JSONArrayValue(
-                values=_encode_array(value, allow_null=allow_null)
+                values=cast(
+                    list[JSONAnyValue],
+                    _encode_array(value, allow_null=allow_null),
+                )
             )
         )
     if isinstance(value, Mapping):
@@ -134,11 +129,11 @@ def _encode_trace_id(trace_id: int) -> bytes:
 
 
 def _encode_attributes(
-    attributes: _ExtendedAttributes,
+    attributes: Attributes | None,
     allow_null: bool = False,
-) -> Optional[list[JSONKeyValue]]:
+) -> list[JSONKeyValue]:
     if not attributes:
-        return None
+        return []
     json_attributes = []
     for key, value in attributes.items():
         # pylint: disable=broad-exception-caught
@@ -149,28 +144,3 @@ def _encode_attributes(
         except Exception as error:
             _logger.exception("Failed to encode key %s: %s", key, error)
     return json_attributes
-
-
-def _get_resource_data(
-    sdk_resource_scope_data: dict[Resource, _ResourceDataT],
-    resource_class: Callable[..., _TypingResourceT],
-    name: str,
-) -> list[_TypingResourceT]:
-    resource_data = []
-
-    for (
-        sdk_resource,
-        scope_data,
-    ) in sdk_resource_scope_data.items():
-        json_resource = JSONResource(
-            attributes=_encode_attributes(sdk_resource.attributes)
-        )
-        resource_data.append(
-            resource_class(
-                **{
-                    "resource": json_resource,
-                    f"scope_{name}": scope_data.values(),
-                }
-            )
-        )
-    return resource_data

exporter/opentelemetry-exporter-otlp-json-common/src/opentelemetry/exporter/otlp/json/common/_internal/_log_encoder/__init__.py

@@ -12,8 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 from collections import defaultdict
 from collections.abc import Collection
+from typing import cast
 
 from opentelemetry.exporter.otlp.json.common._internal import (
     _encode_attributes,
@@ -34,6 +37,7 @@
     ScopeLogs as JSONScopeLogs,
 )
 from opentelemetry.sdk._logs import ReadableLogRecord
+from opentelemetry.util.types import Attributes
 
 
 def encode_logs(
@@ -45,27 +49,23 @@ def encode_logs(
 
 
 def _encode_log(readable_log_record: ReadableLogRecord) -> JSONLogRecord:
-    span_id = (
-        None
-        if readable_log_record.log_record.span_id == 0
-        else _encode_span_id(readable_log_record.log_record.span_id)
-    )
-    trace_id = (
-        None
-        if readable_log_record.log_record.trace_id == 0
-        else _encode_trace_id(readable_log_record.log_record.trace_id)
-    )
-    body = readable_log_record.log_record.body
     return JSONLogRecord(
         time_unix_nano=readable_log_record.log_record.timestamp,
         observed_time_unix_nano=readable_log_record.log_record.observed_timestamp,
-        span_id=span_id,
-        trace_id=trace_id,
+        span_id=_encode_span_id(readable_log_record.log_record.span_id)
+        if readable_log_record.log_record.span_id
+        else None,
+        trace_id=_encode_trace_id(readable_log_record.log_record.trace_id)
+        if readable_log_record.log_record.trace_id
+        else None,
         flags=int(readable_log_record.log_record.trace_flags),
-        body=_encode_value(body, allow_null=True),
+        body=_encode_value(
+            readable_log_record.log_record.body, allow_null=True
+        ),
         severity_text=readable_log_record.log_record.severity_text,
         attributes=_encode_attributes(
-            readable_log_record.log_record.attributes, allow_null=True
+            cast(Attributes, readable_log_record.log_record.attributes),
+            allow_null=True,
         ),
         dropped_attributes_count=readable_log_record.dropped_attributes,
         severity_number=getattr(

exporter/opentelemetry-exporter-otlp-json-common/src/opentelemetry/exporter/otlp/json/common/_internal/metrics_encoder/__init__.py

@@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
 from __future__ import annotations
 
 import logging
@@ -67,16 +68,12 @@
     ScopeMetrics,
 )
 from opentelemetry.sdk.metrics.export import (
-    ExponentialHistogram as ExponentialHistogramType,
-)
-from opentelemetry.sdk.metrics.export import (
+    ExponentialHistogram,
     Gauge,
+    Histogram,
     MetricsData,
     Sum,
 )
-from opentelemetry.sdk.metrics.export import (
-    Histogram as HistogramType,
-)
 
 _logger = logging.getLogger(__name__)
 
@@ -123,7 +120,7 @@ def _encode_metric(metric: Metric) -> JSONMetric:
                 _encode_gauge_data_point(pt) for pt in metric.data.data_points
             ]
         )
-    elif isinstance(metric.data, HistogramType):
+    elif isinstance(metric.data, Histogram):
         json_metric.histogram = JSONHistogram(
             data_points=[
                 _encode_histogram_data_point(pt)
@@ -139,7 +136,7 @@ def _encode_metric(metric: Metric) -> JSONMetric:
             aggregation_temporality=metric.data.aggregation_temporality,
             is_monotonic=metric.data.is_monotonic,
         )
-    elif isinstance(metric.data, ExponentialHistogramType):
+    elif isinstance(metric.data, ExponentialHistogram):
         json_metric.exponential_histogram = JSONExponentialHistogram(
             data_points=[
                 _encode_exponential_histogram_data_point(pt)
@@ -196,8 +193,8 @@ def _encode_histogram_data_point(
         exemplars=_encode_exemplars(data_point.exemplars),
         count=data_point.count,
         sum=data_point.sum,
-        bucket_counts=data_point.bucket_counts,
-        explicit_bounds=data_point.explicit_bounds,
+        bucket_counts=list(data_point.bucket_counts),
+        explicit_bounds=list(data_point.explicit_bounds),
         max=data_point.max,
         min=data_point.min,
     )
@@ -218,15 +215,15 @@ def _encode_exponential_histogram_data_point(
         positive=(
             JSONExponentialHistogramDataPoint.Buckets(
                 offset=data_point.positive.offset,
-                bucket_counts=data_point.positive.bucket_counts,
+                bucket_counts=list(data_point.positive.bucket_counts),
             )
             if data_point.positive.bucket_counts
             else None
         ),
         negative=(
             JSONExponentialHistogramDataPoint.Buckets(
                 offset=data_point.negative.offset,
-                bucket_counts=data_point.negative.bucket_counts,
+                bucket_counts=list(data_point.negative.bucket_counts),
             )
             if data_point.negative.bucket_counts
             else None

exporter/opentelemetry-exporter-otlp-json-common/src/opentelemetry/exporter/otlp/json/common/_internal/trace_encoder/__init__.py

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import logging
 from collections import defaultdict
 from collections.abc import Collection
-from typing import Optional
 
 from opentelemetry.exporter.otlp.json.common._internal import (
     _encode_attributes,
@@ -98,7 +99,7 @@ def _encode_resource_spans(
     return json_resource_spans
 
 
-def _span_flags(parent_span_context: Optional[SpanContext]) -> int:
+def _span_flags(parent_span_context: SpanContext | None) -> int:
     flags = JSONSpanFlags.SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK
     if parent_span_context and parent_span_context.is_remote:
         flags |= JSONSpanFlags.SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK
@@ -108,10 +109,14 @@ def _span_flags(parent_span_context: Optional[SpanContext]) -> int:
 def _encode_span(sdk_span: ReadableSpan) -> JSONSpan:
     span_context = sdk_span.get_span_context()
     return JSONSpan(
-        trace_id=_encode_trace_id(span_context.trace_id),
-        span_id=_encode_span_id(span_context.span_id),
-        trace_state=_encode_trace_state(span_context.trace_state),
-        parent_span_id=_encode_parent_id(sdk_span.parent),
+        trace_id=_encode_trace_id(
+            span_context.trace_id if span_context else 0
+        ),
+        span_id=_encode_span_id(span_context.span_id if span_context else 0),
+        trace_state=_encode_trace_state(
+            span_context.trace_state if span_context else None
+        ),
+        parent_span_id=_encode_context_span_id(sdk_span.parent),
         name=sdk_span.name,
         kind=_SPAN_KIND_MAP[sdk_span.kind],
         start_time_unix_nano=sdk_span.start_time,
@@ -129,40 +134,32 @@ def _encode_span(sdk_span: ReadableSpan) -> JSONSpan:
 
 def _encode_events(
     events: Collection[Event],
-) -> Optional[list[JSONSpan.Event]]:
-    return (
-        [
-            JSONSpan.Event(
-                name=event.name,
-                time_unix_nano=event.timestamp,
-                attributes=_encode_attributes(event.attributes),
-                dropped_attributes_count=event.dropped_attributes,
-            )
-            for event in events
-        ]
-        if events
-        else None
-    )
+) -> list[JSONSpan.Event]:
+    return [
+        JSONSpan.Event(
+            name=event.name,
+            time_unix_nano=event.timestamp,
+            attributes=_encode_attributes(event.attributes),
+            dropped_attributes_count=event.dropped_attributes,
+        )
+        for event in events
+    ]
 
 
 def _encode_links(links: Collection[Link]) -> list[JSONSpan.Link]:
-    return (
-        [
-            JSONSpan.Link(
-                trace_id=_encode_trace_id(link.context.trace_id),
-                span_id=_encode_span_id(link.context.span_id),
-                attributes=_encode_attributes(link.attributes),
-                dropped_attributes_count=link.dropped_attributes,
-                flags=_span_flags(link.context),
-            )
-            for link in links
-        ]
-        if links
-        else None
-    )
+    return [
+        JSONSpan.Link(
+            trace_id=_encode_trace_id(link.context.trace_id),
+            span_id=_encode_span_id(link.context.span_id),
+            attributes=_encode_attributes(link.attributes),
+            dropped_attributes_count=link.dropped_attributes,
+            flags=_span_flags(link.context),
+        )
+        for link in links
+    ]
 
 
-def _encode_status(status: Status) -> Optional[JSONStatus]:
+def _encode_status(status: Status | None) -> JSONStatus | None:
     return (
         JSONStatus(
             code=JSONStatus.StatusCode(status.status_code.value),
@@ -173,13 +170,13 @@ def _encode_status(status: Status) -> Optional[JSONStatus]:
     )
 
 
-def _encode_trace_state(trace_state: Optional[TraceState]) -> Optional[str]:
+def _encode_trace_state(trace_state: TraceState | None) -> str | None:
     return (
         ",".join([f"{key}={value}" for key, value in (trace_state.items())])
         if trace_state is not None
         else None
     )
 
 
-def _encode_parent_id(context: Optional[SpanContext]) -> Optional[bytes]:
+def _encode_context_span_id(context: SpanContext | None) -> bytes | None:
     return _encode_span_id(context.span_id) if context else None

exporter/opentelemetry-exporter-otlp-json-common/tests/test_common_encoder.py

@@ -238,8 +238,8 @@ def test_encode_attributes_all_types(self):
         )
 
     def test_encode_attributes_empty(self):
-        self.assertIsNone(_encode_attributes({}))
-        self.assertIsNone(_encode_attributes(None))
+        self.assertEqual(_encode_attributes({}), [])
+        self.assertEqual(_encode_attributes(None), [])
 
     def test_encode_attributes_error_skips_bad_key(self):
         with self.assertLogs(level=ERROR) as error:
@@ -310,7 +310,7 @@ def test_encode_resource(self):
     def test_encode_resource_empty(self):
         resource = Resource({})
         result = _encode_resource(resource)
-        self.assertEqual(result, JSONResource(attributes=None))
+        self.assertEqual(result, JSONResource())
         self.assertEqual(result.to_dict(), {})
 
     def test_encode_instrumentation_scope(self):

exporter/opentelemetry-exporter-otlp-json-common/tests/test_log_encoder.py

@@ -196,7 +196,7 @@ def test_encode_log_empty_record(self):
         self.assertIsNone(lr.severity_text)
         self.assertIsNone(lr.severity_number)
         self.assertIsNone(lr.body)
-        self.assertIsNone(lr.attributes)
+        self.assertEqual(lr.attributes, [])
 
     def test_encode_log_event_name(self):
         log = make_log(body="event happened", event_name="my.event")