Skip to content

Preserve required argument order in errors #3645

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
tandede wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

Preserve required argument order in errors #3645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions src/openai/_utils/_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,8 +288,7 @@ def wrapper(*args: object, **kwargs: object) -> object:
else:
assert len(variants) > 0

# TODO: this error message is not deterministic
missing = list(set(variants[0]) - given_params)
missing = [param for param in variants[0] if param not in given_params]
if len(missing) > 1:
msg = f"Missing required arguments: {human_join([quote(arg) for arg in missing])}"
else:
Expand Down
7 changes: 4 additions & 3 deletions tests/test_required_args.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@ def foo(a: str = "", *, b: str = "", c: str = "") -> str | None:

assert foo(a="a", b="b", c="c") == "a b c"

error_message = r"Missing required arguments.*"

with pytest.raises(TypeError, match=error_message):
with pytest.raises(TypeError) as exc_info:
foo()
assert str(exc_info.value) == "Missing required arguments: 'a', 'b' or 'c'"

error_message = r"Missing required arguments.*"

with pytest.raises(TypeError, match=error_message):
foo(a="a")
Expand Down