Preserve required argument order in errors - #3645
Open
tandede wants to merge 1 commit into
Open
Conversation
tandede
marked this pull request as ready for review
August 19, 2026 11:28
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
required_argsvariant's declaration order when listing missing argumentsWhy
The single-variant error path currently computes missing arguments with a set difference. Set iteration depends on Python's randomized hash seed, so an identical invalid SDK call can list parameters in a different order across processes. For example, the same declaration produced both
'model', 'messages' or 'stream'and'messages', 'stream' or 'model'under differentPYTHONHASHSEEDvalues.Filtering the declared variant in place makes the message deterministic and keeps it aligned with the method signature.
Validation
PYTHONHASHSEEDvaluespython -m pytest -q -n 0 tests/test_required_args.py tests/test_utils tests/test_models.py(197 passed)ruff check .ruff format --check .mypy src/openai/_utils/_utils.py