Skip to content

docs: update body_snapshot docstring for clarity #73

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
Benflow3 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update body_snapshot docstring for clarity #73

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bd5529
Update body_snapshot docstring for clarity
Benflow3 Jun 17, 2026
2c6d0e9
docs: fix formatting in body_snapshot docstring
Benflow3 Jun 17, 2026
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
6 changes: 3 additions & 3 deletions packages/dexpace-sdk-core/src/dexpace/sdk/core/errors/http.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ def _status_is_retryable(self) -> bool:
def body_snapshot(self, max_bytes: int | None = None) -> bytes:
"""Preview the error response body without consuming it.

Safe to call from logging and post-mortem paths: it never drains a
single-use stream. Bytes are only returned when the body has already
been captured for repeatable reads (a ``LoggableResponseBody``); for
For a LoggableResponseBody, the snapshot drains and caches the inner

@OmarAlJarrah OmarAlJarrah Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified this against the code and it's accurate — it does drain and cache the inner body on the first read. Only nit: wrap LoggableResponseBody in double backticks to match the rest of the docstring, then it's good to merge.

@Benflow3 Benflow3 Jun 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting has been fixed
Close #41

body on the first access (this initial read is synchronous and
may incur I/O, but subsequent reads are repeatable and fast); for
any other body — or when no response/body is present — an empty
``bytes`` is returned rather than destroying the payload.

Expand Down