Pytest plugin for automatically mocking OpenAI requests. Powered by RESPX.
Note
This project is in maintenance mode unless I see an appetite for more community contributions. I built this because we at Definite needed a way to easily and quickly test the integration between openai-python and our codebase but we have moved on to other frameworks/SDKs. With that, my need and desire to work on this library has dropped significantly.
I will be encouraging community contributions to fill in the gap for some of the new features released since the last major update to this library such as evals, graders, containers, and all of the new administration endpoints.
Absent community contributions, if the work required just for maintenance mode becomes too much (>2 hours a month) then this project will be fully deprecated and archived.
- Chat
- Embeddings
- Files
- Models
- Moderations
- Assistants
- Threads
- Messages
- Runs
- Run Steps
- Vector Stores
- Vector Store Files
- Vector Store File Batches
View full support coverage here.
Tip
✨ Support for creating streaming responses added in v0.4
Just decorate any test function that makes a call to the OpenAI API (either using openai-python or with HTTPX).
import openai
import openai_responses
@openai_responses.mock()
def test_create_assistant():
client = openai.Client(api_key="sk-fake123")
assistant = client.beta.assistants.create(
instructions="You are a personal math tutor.",
name="Math Tutor",
tools=[{"type": "code_interpreter"}],
model="gpt-4-turbo",
)
assert assistant.name == "Math Tutor"See examples or docs for more.
Available on PyPI
pip install openai-responses
See the documentation site for more info.
See LICENSE for more info.
See CONTRIBUTING.md for info on PRs, issues, and feature requests.
See CHANGELOG.md for summarized notes on changes or view releases for more details information on changes.
