Skip to content

Add response content to UnexpectedStatus exception #989

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

Merged
dbanty merged 3 commits into from
Mar 6, 2024
Merged

Add response content to UnexpectedStatus exception #989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08285ff
add response content to UnexpectedStatus exception
Mar 5, 2024
863739d
Fix type error, regen snapshots, document with changeset
dbanty Mar 6, 2024
55b28a8
Merge branch 'main' into unexpected_status_content
dbanty Mar 6, 2024
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
9 changes: 9 additions & 0 deletions .changeset/add_response_content_to_unexpectedstatus_exception.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
default: minor
---

# Add response content to `UnexpectedStatus` exception

The error message for `UnexpectedStatus` exceptions will now include the UTF-8 decoded (ignoring errors) body of the response.

PR #989 implements #840. Thanks @harabat!
4 changes: 3 additions & 1 deletion end_to_end_tests/golden-record/my_test_api_client/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ def __init__(self, status_code: int, content: bytes):
self.status_code = status_code
self.content = content

super().__init__(f"Unexpected status code: {status_code}")
super().__init__(
f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
)


__all__ = ["UnexpectedStatus"]
4 changes: 3 additions & 1 deletion end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ def __init__(self, status_code: int, content: bytes):
self.status_code = status_code
self.content = content

super().__init__(f"Unexpected status code: {status_code}")
super().__init__(
f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
)


__all__ = ["UnexpectedStatus"]
4 changes: 3 additions & 1 deletion integration-tests/integration_tests/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ def __init__(self, status_code: int, content: bytes):
self.status_code = status_code
self.content = content

super().__init__(f"Unexpected status code: {status_code}")
super().__init__(
f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
)


__all__ = ["UnexpectedStatus"]
4 changes: 3 additions & 1 deletion openapi_python_client/templates/errors.py.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ class UnexpectedStatus(Exception):
self.status_code = status_code
self.content = content

super().__init__(f"Unexpected status code: {status_code}")
super().__init__(
f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
)

__all__ = ["UnexpectedStatus"]