add type annotations

Signed-off-by: Tudor Plugaru <[email protected]>

Author: PlugaruT

src/cloudevents/core/formats/base.py

@@ -19,6 +19,12 @@
 
 
 class Format(Protocol):
-    def read(self, event_factory: Callable[[dict, Optional[Union[dict, str, bytes]]], BaseCloudEvent], data: Union[str, bytes]) -> BaseCloudEvent: ...
+    def read(
+        self,
+        event_factory: Callable[
+            [dict, Optional[Union[dict, str, bytes]]], BaseCloudEvent
+        ],
+        data: Union[str, bytes],
+    ) -> BaseCloudEvent: ...
 
     def write(self, event: BaseCloudEvent) -> bytes: ...

src/cloudevents/core/formats/json.py

@@ -48,16 +48,23 @@ class JSONFormat(Format):
         r"^(application|text)/([a-zA-Z0-9\-\.]+\+)?json(;.*)?$"
     )
 
-    def read(self, event_factory: Callable[[dict, Optional[Union[dict, str, bytes]]], BaseCloudEvent], data: Union[str, bytes]) -> BaseCloudEvent:
+    def read(
+        self,
+        event_factory: Callable[
+            [dict, Optional[Union[dict, str, bytes]]], BaseCloudEvent
+        ],
+        data: Union[str, bytes],
+    ) -> BaseCloudEvent:
         """
         Read a CloudEvent from a JSON formatted byte string.
 
         :param event_factory: A factory function to create CloudEvent instances.
         :param data: The JSON formatted byte array.
         :return: The CloudEvent instance.
         """
+        decoded_data: str
         if isinstance(data, bytes):
-            decoded_data: str = data.decode("utf-8")
+            decoded_data = data.decode("utf-8")
         else:
             decoded_data = data
 

tests/test_core/test_format/test_json.py

@@ -233,7 +233,9 @@ def test_write_cloud_event_with_extension_attributes() -> None:
 
 
 def test_read_cloud_event_with_extension_attributes() -> None:
-    data = '{"id": "123", "source": "source", "type": "type", "specversion": "1.0", "customext1": "value1", "customext2": 123}'.encode("utf-8")
+    data = '{"id": "123", "source": "source", "type": "type", "specversion": "1.0", "customext1": "value1", "customext2": 123}'.encode(
+        "utf-8"
+    )
     formatter = JSONFormat()
     result = formatter.read(CloudEvent, data)
 
@@ -247,7 +249,7 @@ def test_write_cloud_event_with_different_json_content_types() -> None:
         ("text/json", {"key": "value"}),
         ("application/json; charset=utf-8", {"key": "value"}),
     ]
-    
+
     for content_type, data in test_cases:
         attributes = {
             "id": "123",
@@ -259,12 +261,14 @@ def test_write_cloud_event_with_different_json_content_types() -> None:
         event = CloudEvent(attributes=attributes, data=data)
         formatter = JSONFormat()
         result = formatter.write(event)
-        
+
         assert b'"data": {"key": "value"}' in result
 
 
 def test_read_cloud_event_with_string_data() -> None:
-    data = '{"id": "123", "source": "source", "type": "type", "specversion": "1.0", "data": "plain string data"}'.encode("utf-8")
+    data = '{"id": "123", "source": "source", "type": "type", "specversion": "1.0", "data": "plain string data"}'.encode(
+        "utf-8"
+    )
     formatter = JSONFormat()
     result = formatter.read(CloudEvent, data)
 
@@ -296,14 +300,16 @@ def test_write_cloud_event_with_unicode_data() -> None:
     event = CloudEvent(attributes=attributes, data="Hello 世界 🌍")
     formatter = JSONFormat()
     result = formatter.write(event)
-    
+
     decoded = result.decode("utf-8")
     assert '"data": "Hello' in decoded
     assert "Hello" in decoded
 
 
 def test_read_cloud_event_with_unicode_data() -> None:
-    data = '{"id": "123", "source": "source", "type": "type", "specversion": "1.0", "data": "Hello 世界 🌍"}'.encode("utf-8")
+    data = '{"id": "123", "source": "source", "type": "type", "specversion": "1.0", "data": "Hello 世界 🌍"}'.encode(
+        "utf-8"
+    )
     formatter = JSONFormat()
     result = formatter.read(CloudEvent, data)