update to use inheritence for common JSON serialization/deserialization methods

Author: herin049

codegen/opentelemetry-codegen-json/src/opentelemetry/codegen/json/generator.py

@@ -454,10 +454,8 @@ def _generate_message_class(
         codec = self._get_codec_module_path()
         with writer.dataclass(
             msg_desc.name,
-            decorators=(
-                "typing.final",
-                f"{codec}.json_serde",
-            ),
+            bases=(f"{codec}.JsonMessage",),
+            decorators=("typing.final",),
             decorator_name="_dataclass",
         ):
             if msg_desc.field or msg_desc.nested_type or msg_desc.enum_type:

codegen/opentelemetry-codegen-json/src/opentelemetry/codegen/json/runtime/json_codec.py

@@ -14,6 +14,7 @@
 
 from __future__ import annotations
 
+import abc
 import base64
 import json
 import math
@@ -22,29 +23,31 @@
 T = typing.TypeVar("T")
 
 
-def json_serde(cls: type[T]) -> type[T]:
+class JsonMessage(abc.ABC):
     """
-    A decorator that adds "to_json" and "from_json" methods to a class.
+    Abstract base class for protobuf messages with JSON serialization.
+
+    Subclasses must implement ``to_dict`` and ``from_dict``.
+    Provides ``to_json`` and ``from_json`` based on those methods.
     """
 
-    def to_json(self: typing.Any) -> str:
-        """
-        Serialize this message to a JSON string.
-        """
-        # pylint: disable-next=no-member
-        return json.dumps(self.to_dict())  # type: ignore
+    @abc.abstractmethod
+    def to_dict(self) -> dict[str, typing.Any]:
+        """Convert this message to a dictionary."""
+
+    @classmethod
+    @abc.abstractmethod
+    def from_dict(cls: type[T], data: dict[str, typing.Any]) -> T:
+        """Create an instance from a dictionary."""
+
+    def to_json(self) -> str:
+        """Serialize this message to a JSON string."""
+        return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls_inner: type[T], data: typing.Union[str, bytes]) -> T:
-        """
-        Deserialize from a JSON string or bytes.
-        """
-        # pylint: disable-next=no-member
-        return cls_inner.from_dict(json.loads(data))  # type: ignore
-
-    cls.to_json = to_json  # type: ignore[attr-defined]
-    cls.from_json = from_json  # type: ignore[attr-defined]
-    return cls
+    def from_json(cls: type[T], data: typing.Union[str, bytes]) -> T:
+        """Deserialize from a JSON string or bytes."""
+        return cls.from_dict(json.loads(data))  # type: ignore[return-value]
 
 
 def encode_hex(value: typing.Optional[bytes]) -> str:

opentelemetry-proto-json/src/opentelemetry/proto_json/_json_codec.py

@@ -14,6 +14,7 @@
 
 from __future__ import annotations
 
+import abc
 import base64
 import json
 import math
@@ -22,30 +23,34 @@
 T = typing.TypeVar("T")
 
 
-def json_serde(cls: type[T]) -> type[T]:
+class JsonMessage(abc.ABC):
     """
-    A decorator that adds "to_json" and "from_json" methods to a class.
+    Abstract base class for protobuf messages with JSON serialization.
+
+    Subclasses must implement ``to_dict`` and ``from_dict``.
+    Provides ``to_json`` and ``from_json`` based on those methods.
     """
 
-    def to_json(self: T) -> str:
-        """
-        Serialize this message to a JSON string.
-        """
-        return json.dumps(self.to_dict())
+    @abc.abstractmethod
+    def to_dict(self) -> dict[str, typing.Any]:
+        """Convert this message to a dictionary."""
 
     @classmethod
-    def from_json(cls_inner: type[T], data: typing.Union[str, bytes]) -> T:
-        """
-        Deserialize from a JSON string or bytes.
-        """
-        return cls_inner.from_dict(json.loads(data))
+    @abc.abstractmethod
+    def from_dict(cls: type[T], data: dict[str, typing.Any]) -> T:
+        """Create an instance from a dictionary."""
 
-    cls.to_json = to_json  # type: ignore[attr-defined]
-    cls.from_json = from_json  # type: ignore[attr-defined]
-    return cls
+    def to_json(self) -> str:
+        """Serialize this message to a JSON string."""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls: type[T], data: typing.Union[str, bytes]) -> T:
+        """Deserialize from a JSON string or bytes."""
+        return cls.from_dict(json.loads(data))  # type: ignore[return-value]
 
 
-def encode_hex(value: bytes) -> str:
+def encode_hex(value: typing.Optional[bytes]) -> str:
     """
     Encode bytes as hex string.
 
@@ -57,7 +62,7 @@ def encode_hex(value: bytes) -> str:
     return value.hex() if value else ""
 
 
-def encode_base64(value: bytes) -> str:
+def encode_base64(value: typing.Optional[bytes]) -> str:
     """
     Encode bytes as base64 string.
     Standard Proto3 JSON mapping for bytes.
@@ -130,9 +135,9 @@ def decode_hex(value: typing.Optional[str], field_name: str) -> bytes:
     validate_type(value, str, field_name)
     try:
         return bytes.fromhex(value)
-    except ValueError as e:
+    except ValueError as error:
         raise ValueError(
-            f"Invalid hex string for field '{field_name}': {e}"
+            f"Invalid hex string for field '{field_name}': {error}"
         ) from None
 
 
@@ -151,9 +156,9 @@ def decode_base64(value: typing.Optional[str], field_name: str) -> bytes:
     validate_type(value, str, field_name)
     try:
         return base64.b64decode(value)
-    except Exception as e:
+    except Exception as error:
         raise ValueError(
-            f"Invalid base64 string for field '{field_name}': {e}"
+            f"Invalid base64 string for field '{field_name}': {error}"
         ) from None
 
 

opentelemetry-proto-json/src/opentelemetry/proto_json/collector/logs/v1/logs_service.py

@@ -33,9 +33,8 @@
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportLogsServiceRequest:
+class ExportLogsServiceRequest(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportLogsServiceRequest
     """
@@ -75,9 +74,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ExportLogs
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportLogsServiceResponse:
+class ExportLogsServiceResponse(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportLogsServiceResponse
     """
@@ -117,9 +115,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ExportLogs
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportLogsPartialSuccess:
+class ExportLogsPartialSuccess(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportLogsPartialSuccess
     """

opentelemetry-proto-json/src/opentelemetry/proto_json/collector/metrics/v1/metrics_service.py

@@ -33,9 +33,8 @@
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportMetricsServiceRequest:
+class ExportMetricsServiceRequest(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportMetricsServiceRequest
     """
@@ -75,9 +74,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ExportMetr
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportMetricsServiceResponse:
+class ExportMetricsServiceResponse(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportMetricsServiceResponse
     """
@@ -117,9 +115,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ExportMetr
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportMetricsPartialSuccess:
+class ExportMetricsPartialSuccess(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportMetricsPartialSuccess
     """

opentelemetry-proto-json/src/opentelemetry/proto_json/collector/profiles/v1development/profiles_service.py

@@ -33,9 +33,8 @@
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportProfilesServiceRequest:
+class ExportProfilesServiceRequest(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportProfilesServiceRequest
     """
@@ -80,9 +79,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ExportProf
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportProfilesServiceResponse:
+class ExportProfilesServiceResponse(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportProfilesServiceResponse
     """
@@ -122,9 +120,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ExportProf
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportProfilesPartialSuccess:
+class ExportProfilesPartialSuccess(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportProfilesPartialSuccess
     """

opentelemetry-proto-json/src/opentelemetry/proto_json/collector/trace/v1/trace_service.py

@@ -33,9 +33,8 @@
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportTraceServiceRequest:
+class ExportTraceServiceRequest(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportTraceServiceRequest
     """
@@ -75,9 +74,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ExportTrac
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportTraceServiceResponse:
+class ExportTraceServiceResponse(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportTraceServiceResponse
     """
@@ -117,9 +115,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ExportTrac
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ExportTracePartialSuccess:
+class ExportTracePartialSuccess(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ExportTracePartialSuccess
     """

opentelemetry-proto-json/src/opentelemetry/proto_json/common/v1/common.py

@@ -32,9 +32,8 @@
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class AnyValue:
+class AnyValue(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message AnyValue
     """
@@ -106,9 +105,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "AnyValue":
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class ArrayValue:
+class ArrayValue(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message ArrayValue
     """
@@ -148,9 +146,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "ArrayValue
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class KeyValueList:
+class KeyValueList(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message KeyValueList
     """
@@ -190,9 +187,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "KeyValueLi
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class KeyValue:
+class KeyValue(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message KeyValue
     """
@@ -238,9 +234,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "KeyValue":
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class InstrumentationScope:
+class InstrumentationScope(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message InstrumentationScope
     """
@@ -298,9 +293,8 @@ def from_dict(cls, data: builtins.dict[builtins.str, typing.Any]) -> "Instrument
 
 
 @typing.final
-@opentelemetry.proto_json._json_codec.json_serde
 @_dataclass
-class EntityRef:
+class EntityRef(opentelemetry.proto_json._json_codec.JsonMessage):
     """
     Generated from protobuf message EntityRef
     """