Skip to content

fix: pickle exceptions with custom __reduce__ #2747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+46 −2
Open

fix: pickle exceptions with custom __reduce__ #2747

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d355e9
Pickle exceptions with custom reduce
srilman Nov 12, 2025
45f04bd
Format and lint
srilman Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions src/openai/_exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

from __future__ import annotations

from typing import TYPE_CHECKING, Any, Optional, cast
from typing_extensions import Literal
from typing import TYPE_CHECKING, Any, Callable, Optional, cast
from typing_extensions import Self, Literal, override

import httpx

Expand Down Expand Up @@ -66,6 +66,14 @@ def __init__(self, message: str, request: httpx.Request, *, body: object | None)
self.param = None
self.type = None

@classmethod
def _reconstruct_base(cls, message: str, request: httpx.Request, body: object | None) -> Self:
return cls(message, request, body=body)

@override
def __reduce__(self) -> tuple[Callable[..., Self], tuple[Any, ...]]:
return (self.__class__._reconstruct_base, (self.message, self.request, self.body))


class APIResponseValidationError(APIError):
response: httpx.Response
Expand All @@ -76,6 +84,16 @@ def __init__(self, response: httpx.Response, body: object | None, *, message: st
self.response = response
self.status_code = response.status_code

@classmethod
def _reconstruct(cls, response: httpx.Response, body: object | None, message: str | None) -> Self:
return cls(response, body, message=message)

@override
def __reduce__(
self,
) -> tuple[Callable[..., Self], tuple[Any, ...]]:
return (self.__class__._reconstruct, (self.response, self.body, self.message))


class APIStatusError(APIError):
"""Raised when an API response has a status code of 4xx or 5xx."""
Expand All @@ -90,11 +108,29 @@ def __init__(self, message: str, *, response: httpx.Response, body: object | Non
self.status_code = response.status_code
self.request_id = response.headers.get("x-request-id")

@classmethod
def _reconstruct(cls, message: str, response: httpx.Response, body: object | None) -> Self:
return cls(message, response=response, body=body)

@override
def __reduce__(
self,
) -> tuple[Callable[..., Self], tuple[Any, ...]]:
return (self.__class__._reconstruct, (self.message, self.response, self.body))


class APIConnectionError(APIError):
def __init__(self, *, message: str = "Connection error.", request: httpx.Request) -> None:
super().__init__(message, request, body=None)

@classmethod
def _reconstruct(cls, message: str, request: httpx.Request) -> Self:
return cls(message=message, request=request)

@override
def __reduce__(self) -> tuple[Callable[..., Self], tuple[Any, ...]]:
return (self.__class__._reconstruct, (self.message, self.request))
Comment on lines +126 to +132
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Pickling APITimeoutError passes unsupported message arg

The new APIConnectionError.__reduce__ returns _reconstruct(self.message, self.request), which reconstructs the object via cls(message=message, request=request). APITimeoutError subclasses APIConnectionError but its __init__ takes only a request parameter and hard‑codes the message. Attempting to pickle an APITimeoutError will therefore raise TypeError: APITimeoutError.__init__() got an unexpected keyword argument 'message', defeating the goal of making these exceptions picklable. APITimeoutError needs its own __reduce__/reconstructor or _reconstruct must handle subclasses without a message parameter.

Useful? React with 👍 / 👎.



class APITimeoutError(APIConnectionError):
def __init__(self, request: httpx.Request) -> None:
Expand Down Expand Up @@ -149,6 +185,14 @@ def __init__(self, *, completion: ChatCompletion) -> None:
super().__init__(msg)
self.completion = completion

@classmethod
def _reconstruct(cls, completion: ChatCompletion) -> Self:
return cls(completion=completion)

@override
def __reduce__(self) -> tuple[Callable[..., Self], tuple[Any, ...]]:
return (self.__class__._reconstruct, (self.completion,))


class ContentFilterFinishReasonError(OpenAIError):
def __init__(self) -> None:
Expand Down