Skip to content

fix: Fix docstring of GetOptions.range #756

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
kylebarron merged 1 commit into from
Jul 22, 2026
Merged

fix: Fix docstring of GetOptions.range #756

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
2 changes: 2 additions & 0 deletions obstore/python/obstore/_get.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ class GetOptions(TypedDict, total=False):
Request transfer of only the specified range of bytes
otherwise returning [`NotModifiedError`][obstore.exceptions.NotModifiedError].
The semantics of this tuple are:

- `(int, int)`: Request a specific range of bytes `(start, end)`.
If the given range is zero-length or starts after the end of the object, an
error will be returned. Additionally, if the range ends after the end of the
Expand All @@ -117,6 +118,7 @@ class GetOptions(TypedDict, total=False):
- `{"suffix": int}`: Request the last `int` bytes. Note that here, `int` is _the
size of the request_, not the byte offset. This is equivalent to `bytes=-{int}`
as an HTTP header.

<https://datatracker.ietf.org/doc/html/rfc9110#name-range>
"""

Expand Down
Loading