Skip to content

storage

Storage helpers for OQTOPUS presigned upload/download flows.

Classes:

  • OqtopusStorage –

    Helpers for downloading and uploading job payloads via presigned URLs.

  • OqtopusStorageError –

    Raised when presigned upload/download operations fail.

OqtopusStorage

Helpers for downloading and uploading job payloads via presigned URLs.

Methods:

  • download –

    Download one zipped JSON object from a presigned URL.

  • download_archive –

    Download one ZIP archive from a presigned URL without extracting it.

  • upload –

    Upload one zipped JSON object using a presigned form POST.

download async classmethod 

download(
    presigned_url: str,
    *,
    timeout_s: int = DEFAULT_TIMEOUT_S,
    allow_non_dict: bool = False,
    proxy: str | None = None,
) -> dict[str, object] | str

Download one zipped JSON object from a presigned URL.

Returns:

  • dict[str, object] | str –

    The extracted JSON payload as a dict or string.

download_archive async classmethod 

download_archive(
    presigned_url: str,
    *,
    timeout_s: int = DEFAULT_TIMEOUT_S,
    proxy: str | None = None,
) -> bytes

Download one ZIP archive from a presigned URL without extracting it.

Returns:

  • bytes –

    Raw ZIP archive bytes.

Raises:

upload async classmethod 

upload(
    presigned_url: JobsJobInfoUploadPresignedURL,
    data: dict[str, object],
    *,
    timeout_s: int = DEFAULT_TIMEOUT_S,
    proxy: str | None = None,
) -> None

Upload one zipped JSON object using a presigned form POST.

Raises:

OqtopusStorageError 


              flowchart TD
              oqtopus_client.services.storage.OqtopusStorageError[OqtopusStorageError]

              

              click oqtopus_client.services.storage.OqtopusStorageError href "" "oqtopus_client.services.storage.OqtopusStorageError"

Raised when presigned upload/download operations fail.