openai / openai/openai-python

Add ``__reduce__`` method to Exception types

Open
#2,629 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
31.6k
Forks
5.7k
Avg merge
1d 6h
Merged PRs (30d)
96

Description

Confirm this is a feature request for the Python library and not the underlying OpenAI API.
  • This is a feature request for the Python library
Describe the feature or improvement you're requesting

When trying to use the openai-python library in an environment that requires pickling, like Ray, OpenAI exceptions cause failures like:

7m    "traceback: Traceback (most recent call last):",
    "  File \"/opt/conda/lib/python3.10/site-packages/ray/exceptions.py\", line 51, in from_ray_exception",
    "    return pickle.loads(ray_exception.serialized_exception)",
    "  File \"/opt/conda/lib/python3.10/site-packages/openai/_exceptions.py\", line 101, in __init__",
    "    super().__init__(message=\"Request timed out.\", request=request)",
    "TypeError: super(type, obj): obj must be an instance or subtype of type",
    "",
    "The above exception was the direct cause of the following exception:",
    "",
    "Traceback (most recent call last):",
    "  File \"/opt/conda/lib/python3.10/site-packages/ray/_private/serialization.py\", line 460, in deserialize_objects",
    "    obj = self._deserialize_object(data, metadata, object_ref)",
    "  File \"/opt/conda/lib/python3.10/site-packages/ray/_private/serialization.py\", line 342, in _deserialize_object",
    "    return RayError.from_bytes(obj)",
    "  File \"/opt/conda/lib/python3.10/site-packages/ray/exceptions.py\", line 45, in from_bytes",
    "    return RayError.from_ray_exception(ray_exception)",
    "  File \"/opt/conda/lib/python3.10/site-packages/ray/exceptions.py\", line 54, in from_ray_exception",
    "    raise RuntimeError(msg) from e",
    "RuntimeError: Failed to unpickle serialized exception",

This is because there is no __reduce__ method defined on the openai exceptions.

See Ray documentation on serialization here: https://docs.ray.io/en/latest/ray-core/objects/serialization.html#customized-serialization, im sure this would affect other runtime environments too

Can a __reduce__ method be added to exceptions so runtimes, like Ray, do not fail when there is an OpenAI exception?

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with openai/_exceptions.py, especially the exception constructor shown at line 101, and inspect how the exception types are defined. Add coverage for pickling and unpickling the affected exceptions, then verify that reconstructed exceptions no longer fail in serialization environments such as Ray.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.