Skip to content

Upload file: Fix custom file id and activity id #340

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
iLLiCiTiT merged 2 commits into from
Jun 22, 2026
+62 −54
Merged

Upload file: Fix custom file id and activity id #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5779a2
fix custom file id in upload functions
iLLiCiTiT Jun 22, 2026
f6d31de
add activity id back
iLLiCiTiT Jun 22, 2026
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
44 changes: 22 additions & 22 deletions ayon_api/_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1202,12 +1202,12 @@ def upload_project_file(
project_name: str,
filepath: str,
*,
content_type: Optional[str] = None,
filename: Optional[str] = None,
file_id: Optional[str] = None,
activity_id: Optional[str] = None,
chunk_size: Optional[int] = None,
progress: Optional[TransferProgress] = None,
content_type: str | None = None,
filename: str | None = None,
file_id: str | None = None,
activity_id: str | None = None,
chunk_size: int | None = None,
progress: TransferProgress | None = None,
) -> requests.Response:
"""Upload project file from a filepath.

Expand All @@ -1218,14 +1218,14 @@ def upload_project_file(
Args:
project_name (str): Project name.
filepath (str): Path where file will be downloaded.
content_type (Optional[str]): MIME type of file.
filename (Optional[str]): Server filename, filename from filepath
content_type (str | None): MIME type of file.
filename (str | None): Server filename, filename from filepath
is used if not passed.
file_id (Optional[str]): File id.
activity_id (Optional[str]): To which activity is file related.
chunk_size (Optional[int]): Size of chunks that are received
file_id (str | None): File id.
activity_id (str | None): To which activity is file related.
chunk_size (int | None): Size of chunks that are received
in single loop.
progress (Optional[TransferProgress]): Object that gives ability
progress (TransferProgress | None): Object that gives ability
to track download progress.

Returns:
Expand All @@ -1250,11 +1250,11 @@ def upload_project_file_from_stream(
stream: StreamType,
filename: str,
*,
content_type: Optional[str] = None,
file_id: Optional[str] = None,
activity_id: Optional[str] = None,
chunk_size: Optional[int] = None,
progress: Optional[TransferProgress] = None,
content_type: str | None = None,
file_id: str | None = None,
activity_id: str | None = None,
chunk_size: int | None = None,
progress: TransferProgress | None = None,
) -> requests.Response:
"""Upload project file from a filepath.

Expand All @@ -1266,12 +1266,12 @@ def upload_project_file_from_stream(
project_name (str): Project name.
stream (StreamType): Stream used as source for upload.
filename (str): Name of file on server.
content_type (Optional[str]): MIME type of file.
file_id (Optional[str]): File id.
activity_id (Optional[str]): To which activity is file related.
chunk_size (Optional[int]): Size of chunks that are received
content_type (str | None): MIME type of file.
file_id (str | None): File id.
activity_id (str | None): To which activity is file related.
chunk_size (int | None): Size of chunks that are received
in single loop.
progress (Optional[TransferProgress]): Object that gives ability
progress (TransferProgress | None): Object that gives ability
to track download progress.

Returns:
Expand Down
72 changes: 40 additions & 32 deletions ayon_api/server_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1806,12 +1806,12 @@ def upload_project_file(
project_name: str,
filepath: str,
*,
content_type: Optional[str] = None,
filename: Optional[str] = None,
file_id: Optional[str] = None,
activity_id: Optional[str] = None,
chunk_size: Optional[int] = None,
progress: Optional[TransferProgress] = None,
content_type: str | None = None,
filename: str | None = None,
file_id: str | None = None,
activity_id: str | None = None,
chunk_size: int | None = None,
progress: TransferProgress | None = None,
) -> requests.Response:
"""Upload project file from a filepath.

Expand All @@ -1822,14 +1822,14 @@ def upload_project_file(
Args:
project_name (str): Project name.
filepath (str): Path where file will be downloaded.
content_type (Optional[str]): MIME type of file.
filename (Optional[str]): Server filename, filename from filepath
content_type (str | None): MIME type of file.
filename (str | None): Server filename, filename from filepath
is used if not passed.
file_id (Optional[str]): File id.
activity_id (Optional[str]): To which activity is file related.
chunk_size (Optional[int]): Size of chunks that are received
file_id (str | None): File id.
activity_id (str | None): To which activity is file related.
chunk_size (int | None): Size of chunks that are received
in single loop.
progress (Optional[TransferProgress]): Object that gives ability
progress (TransferProgress | None): Object that gives ability
to track download progress.

Returns:
Expand All @@ -1844,17 +1844,21 @@ def upload_project_file(
if not content_type:
content_type = "application/octet-stream"

query = prepare_query_string({
"x_file_id": file_id,
"x_activity_id": activity_id,
})
headers = {}
if file_id:
headers["x-file-id"] = file_id

if activity_id:
headers["x-activity-id"] = activity_id

return self.upload_file(
f"api/projects/{project_name}/files{query}",
f"api/projects/{project_name}/files",
filepath,
content_type=content_type,
filename=filename,
chunk_size=chunk_size,
progress=progress,
headers=headers,
request_type=RequestTypes.post,
)

Expand All @@ -1864,11 +1868,11 @@ def upload_project_file_from_stream(
stream: StreamType,
filename: str,
*,
content_type: Optional[str] = None,
file_id: Optional[str] = None,
activity_id: Optional[str] = None,
chunk_size: Optional[int] = None,
progress: Optional[TransferProgress] = None,
content_type: str | None = None,
file_id: str | None = None,
activity_id: str | None = None,
chunk_size: int | None = None,
progress: TransferProgress | None = None,
) -> requests.Response:
"""Upload project file from a filepath.

Expand All @@ -1880,12 +1884,12 @@ def upload_project_file_from_stream(
project_name (str): Project name.
stream (StreamType): Stream used as source for upload.
filename (str): Name of file on server.
content_type (Optional[str]): MIME type of file.
file_id (Optional[str]): File id.
activity_id (Optional[str]): To which activity is file related.
chunk_size (Optional[int]): Size of chunks that are received
content_type (str | None): MIME type of file.
file_id (str | None): File id.
activity_id (str | None): To which activity is file related.
chunk_size (int | None): Size of chunks that are received
in single loop.
progress (Optional[TransferProgress]): Object that gives ability
progress (TransferProgress | None): Object that gives ability
to track download progress.

Returns:
Expand All @@ -1898,17 +1902,21 @@ def upload_project_file_from_stream(
if not content_type:
content_type = "application/octet-stream"

query = prepare_query_string({
"x_file_id": file_id,
"x_activity_id": activity_id,
})
headers = {}
if file_id:
headers["x-file-id"] = file_id

if activity_id:
headers["x-activity-id"] = activity_id

return self.upload_file_from_stream(
f"api/projects/{project_name}/files{query}",
f"api/projects/{project_name}/files",
stream,
content_type=content_type,
filename=filename,
chunk_size=chunk_size,
progress=progress,
headers=headers,
request_type=RequestTypes.post,
)

Expand Down
Loading