Skip to content

Get

object_store_rs.get 

get(
    store: ObjectStore, path: str, *, options: GetOptions | None = None
) -> GetResult

Return the bytes that are stored at the specified location.

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • path (str) –

    The path within ObjectStore to retrieve.

  • options (GetOptions | None, default: None ) –

    options for accessing the file. Defaults to None.

Returns:

object_store_rs.get_async async 

get_async(
    store: ObjectStore, path: str, *, options: GetOptions | None = None
) -> GetResult

Call get asynchronously.

Refer to the documentation for get.

object_store_rs.get_range 

get_range(store: ObjectStore, path: str, offset: int, length: int) -> bytes

Return the bytes that are stored at the specified location in the given byte range.

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 object, the entire remainder of the object will be returned. Otherwise, the exact requested range will be returned.

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • path (str) –

    The path within ObjectStore to retrieve.

  • offset (int) –

    The start of the byte range.

  • length (int) –

    The number of bytes.

Returns:

object_store_rs.get_range_async async 

get_range_async(
    store: ObjectStore, path: str, offset: int, length: int
) -> bytes

Call get_range asynchronously.

Refer to the documentation for get_range.

object_store_rs.get_ranges 

get_ranges(
    store: ObjectStore,
    path: str,
    offsets: Sequence[int],
    lengths: Sequence[int],
) -> List[bytes]

Return the bytes that are stored at the specified locationin the given byte ranges

To improve performance this will:

  • Combine ranges less than 10MB apart into a single call to fetch
  • Make multiple fetch requests in parallel (up to maximum of 10)

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • path (str) –

    The path within ObjectStore to retrieve.

  • offsets (Sequence[int]) –

    A sequence of int where each offset starts.

  • lengths (Sequence[int]) –

    A sequence of int representing the number of bytes within each range.

Returns:

  • List[bytes] –

    A sequence of bytes, one for each range.

object_store_rs.get_ranges_async async 

get_ranges_async(
    store: ObjectStore,
    path: str,
    offsets: Sequence[int],
    lengths: Sequence[int],
) -> List[bytes]

Call get_ranges asynchronously.

Refer to the documentation for get_ranges.

object_store_rs.GetOptions

Bases: TypedDict

Options for a get request, such as range

head instance-attribute 

head: bool

Request transfer of no content

datatracker.ietf.org/doc/html/rfc9110#name-head

if_match instance-attribute 

if_match: str | None

Request will succeed if the ObjectMeta::e_tag matches otherwise returning [Error::Precondition]

See datatracker.ietf.org/doc/html/rfc9110#name-if-match

Examples:

If-Match: "xyzzy"
If-Match: "xyzzy", "r2d2xxxx", "c3piozzzz"
If-Match: *

if_modified_since instance-attribute 

if_modified_since: datetime | None

Request will succeed if the object has not been modified since otherwise returning [Error::Precondition]

Some stores, such as S3, will only return NotModified for exact timestamp matches, instead of for any timestamp greater than or equal.

datatracker.ietf.org/doc/html/rfc9110#section-13.1.4

if_none_match instance-attribute 

if_none_match: str | None

Request will succeed if the ObjectMeta::e_tag does not match otherwise returning [Error::NotModified]

See datatracker.ietf.org/doc/html/rfc9110#section-13.1.2

Examples:

If-None-Match: "xyzzy"
If-None-Match: "xyzzy", "r2d2xxxx", "c3piozzzz"
If-None-Match: *

if_unmodified_since instance-attribute 

if_unmodified_since: datetime | None

Request will succeed if the object has been modified since

datatracker.ietf.org/doc/html/rfc9110#section-13.1.3

version instance-attribute 

version: str | None

Request a particular object version

object_store_rs.GetResult

Result for a get request.

You can materialize the entire buffer by using either bytes or bytes_async, or you can stream the result using stream. __iter__ and __aiter__ are implemented as aliases to stream, so you can alternatively call iter() or aiter() on GetResult to start an iterator.

Using as an async iterator: 

resp = await obs.get_async(store, path)
# 5MB chunk size in stream
stream = resp.stream(min_chunk_size=5 * 1024 * 1024)
async for buf in stream:
    print(len(buf))

Using as a sync iterator: 

resp = obs.get(store, path)
# 20MB chunk size in stream
stream = resp.stream(min_chunk_size=20 * 1024 * 1024)
for buf in stream:
    print(len(buf))

Note that after calling bytes, bytes_async, or stream, you will no longer be able to call other methods on this object, such as the meta attribute.

meta property 

meta: ObjectMeta

The ObjectMeta for this object

__aiter__ 

__aiter__() -> BytesStream

Return a chunked stream over the result's bytes with the default (10MB) chunk size.

__iter__ 

__iter__() -> BytesStream

Return a chunked stream over the result's bytes with the default (10MB) chunk size.

bytes 

bytes() -> bytes

Collects the data into bytes

bytes_async async 

bytes_async() -> bytes

Collects the data into bytes

stream 

stream(min_chunk_size: int = 10 * 1024 * 1024) -> BytesStream

Return a chunked stream over the result's bytes.

Parameters:

  • min_chunk_size (int, default: 10 * 1024 * 1024 ) –

    The minimum size in bytes for each chunk in the returned BytesStream. All chunks except for the last chunk will be at least this size. Defaults to 1010241024 (10MB).

Returns:

  • BytesStream –

    A chunked stream