feat: Add logid support to CozeEventError exception (#50)

- Enhanced CozeEventError to include logid for better traceability

Author: chyroc

cozepy/chat/__init__.py

@@ -379,11 +379,8 @@ def _create(
         if not stream:
             return self._requester.request("post", url, Chat, body=body, stream=stream)
 
-        return Stream(
-            self._requester.request("post", url, Chat, body=body, stream=stream),
-            fields=["event", "data"],
-            handler=_chat_stream_handler,
-        )
+        steam_iters, logid = self._requester.request("post", url, Chat, body=body, stream=stream)
+        return Stream(steam_iters, fields=["event", "data"], handler=_chat_stream_handler, logid=logid)
 
     def retrieve(
         self,
@@ -440,11 +437,8 @@ def submit_tool_outputs(
         if not stream:
             return self._requester.request("post", url, Chat, params=params, body=body, stream=stream)
 
-        return Stream(
-            self._requester.request("post", url, Chat, params=params, body=body, stream=stream),
-            fields=["event", "data"],
-            handler=_chat_stream_handler,
-        )
+        steam_iters, logid = self._requester.request("post", url, Chat, params=params, body=body, stream=stream)
+        return Stream(steam_iters, fields=["event", "data"], handler=_chat_stream_handler, logid=logid)
 
     def cancel(
         self,

cozepy/exception.py

@@ -42,10 +42,11 @@ class CozeEventError(CozeError):
     base class for all event errors
     """
 
-    def __init__(self, field: str = "", data: str = ""):
+    def __init__(self, field: str = "", data: str = "", logid: str = ""):
         self.field = field
         self.data = data
+        self.logid = logid
         if field:
-            super().__init__(f"invalid event, field: {field}, data: {data}")
+            super().__init__(f"invalid event, field: {field}, data: {data}, logid: {logid}")
         else:
-            super().__init__(f"invalid event, data: {data}")
+            super().__init__(f"invalid event, data: {data}, logid: {logid}")

cozepy/model.py

@@ -69,10 +69,11 @@ def __repr__(self):
 
 
 class Stream(Generic[T]):
-    def __init__(self, iters: Iterator[str], fields: List[str], handler: Callable[[Dict[str, str]], T]):
+    def __init__(self, iters: Iterator[str], fields: List[str], handler: Callable[[Dict[str, str]], T], logid: str):
         self._iters = iters
         self._fields = fields
         self._handler = handler
+        self._logid = logid
 
     def __iter__(self):
         return self
@@ -100,5 +101,5 @@ def _extra_field_data(self, line: str, data: Dict[str, str]) -> Tuple[str, str]:
                 if data[field] == "":
                     return field, line[len(field) + 1 :].strip()
                 else:
-                    raise CozeEventError(field, line)
-        raise CozeEventError("", line)
+                    raise CozeEventError(field, line, self._logid)
+        raise CozeEventError("", line, self._logid)

cozepy/request.py

@@ -57,7 +57,7 @@ def request(
         files: dict = None,
         stream: bool = False,
         data_field: str = "data",
-    ) -> Union[T, List[T], Iterator[str], None]:
+    ) -> Union[T, List[T], Tuple[Iterator[str], str], None]:
         """
         Send a request to the server.
         """
@@ -72,10 +72,10 @@ def request(
         )
         log_debug("request %s#%s sending, params=%s, json=%s, stream=%s", method, url, params, body, stream)
         response = self._client.send(request, stream=stream)
+        logid = response.headers.get("x-tt-logid")
         if stream:
-            return response.iter_lines()
+            return response.iter_lines(), logid
 
-        logid = response.headers.get("x-tt-logid")
         code, msg, data = self._parse_requests_code_msg(method, url, response, data_field)
 
         if code is not None and code > 0:

cozepy/workflows/runs/__init__.py

@@ -191,11 +191,8 @@ def stream(
             "bot_id": bot_id,
             "ext": ext,
         }
-        return Stream(
-            self._requester.request("post", url, None, body=body, stream=True),
-            fields=["id", "event", "data"],
-            handler=_workflow_stream_handler,
-        )
+        steam_iters, logid = self._requester.request("post", url, None, body=body, stream=True)
+        return Stream(steam_iters, fields=["id", "event", "data"], handler=_workflow_stream_handler, logid=logid)
 
     def resume(
         self,
@@ -221,8 +218,5 @@ def resume(
             "resume_data": resume_data,
             "interrupt_type": interrupt_type,
         }
-        return Stream(
-            self._requester.request("post", url, None, body=body, stream=True),
-            fields=["id", "event", "data"],
-            handler=_workflow_stream_handler,
-        )
+        steam_iters, logid = self._requester.request("post", url, None, body=body, stream=True)
+        return Stream(steam_iters, fields=["id", "event", "data"], handler=_workflow_stream_handler, logid=logid)

tests/test_exception.py

@@ -17,8 +17,8 @@ def test_coze_error():
     err = CozePKCEAuthError("authorization_pending")
     assert err.error == "authorization_pending"
 
-    err = CozeEventError("event", "xxx")
-    assert str(err) == "invalid event, field: event, data: xxx"
+    err = CozeEventError("event", "xxx", "logid")
+    assert str(err) == "invalid event, field: event, data: xxx, logid: logid"
 
-    err = CozeEventError("", "xxx")
-    assert str(err) == "invalid event, data: xxx"
+    err = CozeEventError("", "xxx", "logid")
+    assert str(err) == "invalid event, data: xxx, logid: logid"

tests/test_model.py

@@ -22,15 +22,15 @@ def mock_handler(d: Dict[str, str]):
 
 def test_stream_invalid_event():
     items = ["event:x"]
-    s = Stream(iter(items), ["field"], mock_handler)
+    s = Stream(iter(items), ["field"], mock_handler, "mocked-logid")
 
-    with pytest.raises(CozeEventError, match="invalid event, data: event:x"):
+    with pytest.raises(CozeEventError, match="invalid event, data: event:x, logid: mocked-logid"):
         next(s)
 
 
 def test_stream_invalid_field():
     items = ["event:x1", "event:x2"]
-    s = Stream(iter(items), ["event", "second"], mock_handler)
+    s = Stream(iter(items), ["event", "second"], mock_handler, "mocked-logid")
 
-    with pytest.raises(CozeEventError, match="invalid event, field: event, data: event:x2"):
+    with pytest.raises(CozeEventError, match="invalid event, field: event, data: event:x2, logid: mocked-logid"):
         next(s)