Skip to content

Fix Artifact sharing not working for shared runs #800

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
merged 2 commits into from
Jun 9, 2025
Merged

Fix Artifact sharing not working for shared runs #800

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd3e584
🐛 Fix single file download
kzscisoft May 20, 2025
3cfb43f
🥅 Added better exception handling for unrecognised artifact
kzscisoft May 20, 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
47 changes: 27 additions & 20 deletions simvue/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
from .models import FOLDER_REGEX, NAME_REGEX
from .config.user import SimvueConfiguration
from .api.request import get_json_from_response
from .api.objects import Run, Folder, Tag, Artifact, Alert
from .api.objects import Run, Folder, Tag, Artifact, Alert, FileArtifact, ObjectArtifact


CONCURRENT_DOWNLOADS = 10
Expand All @@ -42,8 +42,10 @@


def _download_artifact_to_file(
artifact: Artifact, output_dir: pathlib.Path | None
artifact: FileArtifact | ObjectArtifact, output_dir: pathlib.Path | None
) -> None:
if not artifact.name:
raise RuntimeError(f"Expected artifact '{artifact.id}' to have a name")
_output_file = (output_dir or pathlib.Path.cwd()).joinpath(artifact.name)
# If this is a hierarchical structure being downloaded, need to create directories
_output_file.parent.mkdir(parents=True, exist_ok=True)
Expand Down Expand Up @@ -475,13 +477,14 @@ def list_artifacts(
) # type: ignore

def _retrieve_artifacts_from_server(
self, run_id: str, name: str, count: int | None = None
) -> typing.Generator[tuple[str, Artifact], None, None]:
return Artifact.get(
runs=json.dumps([run_id]),
filters=json.dumps([f"name == {name}"]),
count=count,
) # type: ignore
self, run_id: str, name: str
) -> FileArtifact | ObjectArtifact | None:
return Artifact.from_name(
run_id=run_id,
name=name,
server_url=self._user_config.server.url,
server_token=self._user_config.server.token,
)

@prettify_pydantic
@pydantic.validate_call
Expand Down Expand Up @@ -529,12 +532,14 @@ def get_artifact(
RuntimeError
if retrieval of artifact from the server failed
"""
_artifact = Artifact.from_name(
run_id=run_id,
name=name,
server_url=self._user_config.server.url,
server_token=self._user_config.server.token,
)
_artifact = self._retrieve_artifacts_from_server(run_id, name)

if not _artifact:
raise ObjectNotFoundError(
obj_type="artifact",
name=name,
extra=f"for run '{run_id}'",
)

_content = b"".join(_artifact.download_content())

Expand Down Expand Up @@ -574,12 +579,14 @@ def get_artifact_as_file(
if there was a failure during retrieval of information from the
server
"""
_artifacts = self._retrieve_artifacts_from_server(run_id, name, count=1)
_artifact = self._retrieve_artifacts_from_server(run_id, name)

try:
_id, _artifact = next(_artifacts)
except StopIteration as e:
raise ValueError(f"No artifact '{name}' found for run '{run_id}'") from e
if not _artifact:
raise ObjectNotFoundError(
obj_type="artifact",
name=name,
extra=f"for run '{run_id}'",
)

_download_artifact_to_file(_artifact, output_dir)

Expand Down
Loading