Skip to content

fix(storage): add query parameters option to download #1327

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
o-santi merged 3 commits into from
Dec 9, 2025
Merged

fix(storage): add query parameters option to download #1327

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c90ad3f
fix(storage): add query parameters option to download
o-santi Dec 9, 2025
02e930c
fix(storage): add default argument when query_parameters aren't passe…
o-santi Dec 9, 2025
f17d974
chore(storage): add tests ensuring that download calls with query par…
o-santi Dec 9, 2025
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
16 changes: 11 additions & 5 deletions src/storage/src/storage3/_async/file_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from dataclasses import dataclass, field
from io import BufferedReader, FileIO
from pathlib import Path
from typing import Any, List, Literal, Optional, Union, cast
from typing import Any, Dict, List, Literal, Optional, Union, cast

from httpx import AsyncClient, Headers, HTTPStatusError, Response
from yarl import URL
Expand Down Expand Up @@ -439,7 +439,10 @@ async def list(
return response.json()

async def download(
self, path: str, options: Optional[DownloadOptions] = None
self,
path: str,
options: Optional[DownloadOptions] = None,
query_params: Optional[Dict[str, str]] = None,
) -> bytes:
"""
Downloads a file.
Expand All @@ -449,20 +452,23 @@ async def download(
path
The file path to be downloaded, including the path and file name. For example `folder/image.png`.
"""
url_options = options or {}
url_options = options or DownloadOptions()
render_path = (
["render", "image", "authenticated"]
if url_options.get("transform")
else ["object"]
)

transform_options = url_options.get("transform") or {}
transform_options = url_options.get("transform") or TransformOptions()

path_parts = relative_path_to_parts(path)
response = await self._request(
"GET",
[*render_path, self.id, *path_parts],
query_params=transform_to_dict(transform_options),
query_params={
**transform_to_dict(transform_options),
**(query_params or {}),
},
)
return response.content

Expand Down