Skip to content

Put

object_store_rs.put 

put(
    store: ObjectStore,
    path: str,
    file: IO[bytes] | Path | bytes,
    *,
    use_multipart: bool | None = None,
    chunk_size: int = 5 * 1024 * 1024,
    max_concurrency: int = 12
) -> PutResult

Save the provided bytes to the specified location

The operation is guaranteed to be atomic, it will either successfully write the entirety of file to location, or fail. No clients should be able to observe a partially written object.

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • path (str) –

    The path within ObjectStore for where to save the file.

  • file (IO[bytes] | Path | bytes) –

    The object to upload. Can either be file-like, a Path to a local file, or a bytes object.

Other Parameters:

  • use_multipart (bool | None) –

    Whether to use a multipart upload under the hood. Defaults using a multipart upload if the length of the file is greater than chunk_size.

  • chunk_size (int) –

    The size of chunks to use within each part of the multipart upload. Defaults to 5 MB.

  • max_concurrency (int) –

    The maximum number of chunks to upload concurrently. Defaults to 12.

object_store_rs.put_async async 

put_async(
    store: ObjectStore,
    path: str,
    file: IO[bytes] | Path | bytes,
    *,
    use_multipart: bool | None = None,
    chunk_size: int = 5 * 1024 * 1024,
    max_concurrency: int = 12
) -> PutResult

Call put asynchronously.

Refer to the documentation for put.

object_store_rs.PutResult

Bases: TypedDict

Result for a put request.

e_tag instance-attribute 

e_tag: str | None

The unique identifier for the newly created object

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

version instance-attribute 

version: str | None

A version indicator for the newly created object.