address final todo: implement docker_tag, and note in docs that version_number can be ignored for docker submissions

Author: jaymedina

synapseclient/models/submission.py

@@ -5,7 +5,12 @@
 
 from synapseclient import Synapse
 from synapseclient.api import evaluation_services
-from synapseclient.core.async_utils import async_to_sync, skip_async_to_sync, otel_trace_method, wrap_async_generator_to_sync_generator
+from synapseclient.core.async_utils import (
+    async_to_sync,
+    otel_trace_method,
+    skip_async_to_sync,
+    wrap_async_generator_to_sync_generator,
+)
 from synapseclient.models.mixins.access_control import AccessControllable
 
 
@@ -340,7 +345,7 @@ class Submission(
 
     version_number: Optional[int] = field(default=None, compare=False)
     """
-    The version number of the entity at submission. If not provided, it will be automatically retrieved from the entity.
+    The version number of the entity at submission. If not provided, it will be automatically retrieved from the entity. If entity is a Docker repository, this attribute should be ignored in favor of `docker_digest` or `docker_tag`.
     """
 
     evaluation_id: Optional[str] = None
@@ -389,6 +394,11 @@ class Submission(
     For Docker repositories, the digest of the submitted Docker image.
     """
 
+    docker_tag: Optional[str] = None
+    """
+    For Docker repositories, the tag of the submitted Docker image.
+    """
+
     etag: Optional[str] = None
     """The current eTag of the Entity being submitted. If not provided, it will be automatically retrieved."""
 
@@ -580,11 +590,11 @@ async def create_submission_example():
                 entity_info.get("concreteType")
                 == "org.sagebionetworks.repo.model.docker.DockerRepository"
             ):
-                self.version_number = (
-                    1  # TODO: Docker repositories do not have version numbers
-                )
                 self.docker_repository_name = entity_info.get("repositoryName")
                 self.docker_digest = entity_info.get("digest")
+                self.docker_tag = entity_info.get("tag")
+                # All docker repositories are assigned version number 1, even if they have multiple tags
+                self.version_number = 1
         else:
             raise ValueError("entity_id is required to create a submission")
 

synapseclient/models/submission_bundle.py

@@ -1,9 +1,21 @@
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, AsyncGenerator, Dict, Generator, List, Optional, Protocol, Union
+from typing import (
+    TYPE_CHECKING,
+    AsyncGenerator,
+    Dict,
+    Generator,
+    Optional,
+    Protocol,
+    Union,
+)
 
 from synapseclient import Synapse
 from synapseclient.api import evaluation_services
-from synapseclient.core.async_utils import async_to_sync, skip_async_to_sync, wrap_async_generator_to_sync_generator
+from synapseclient.core.async_utils import (
+    async_to_sync,
+    skip_async_to_sync,
+    wrap_async_generator_to_sync_generator,
+)
 
 if TYPE_CHECKING:
     from synapseclient.models.submission import Submission

tests/integration/synapseclient/models/async/test_submission_async.py

@@ -290,7 +290,7 @@ async def test_get_evaluation_submissions_async_generator_behavior(
         async for submission in submissions_generator:
             assert isinstance(submission, Submission)
             submissions.append(submission)
-            
+
         # AND all submissions should be valid Submission objects
         assert all(isinstance(sub, Submission) for sub in submissions)
 
@@ -320,7 +320,7 @@ async def test_get_user_submissions_async_generator_behavior(
         async for submission in submissions_generator:
             assert isinstance(submission, Submission)
             submissions.append(submission)
-            
+
         # AND all submissions should be valid Submission objects
         assert all(isinstance(sub, Submission) for sub in submissions)
 

tests/integration/synapseclient/models/async/test_submission_bundle_async.py

@@ -148,7 +148,7 @@ async def test_get_evaluation_submission_bundles_async_generator_behavior(
         async for bundle in bundles_generator:
             assert isinstance(bundle, SubmissionBundle)
             bundles.append(bundle)
-            
+
         # AND all bundles should be valid SubmissionBundle objects
         assert all(isinstance(bundle, SubmissionBundle) for bundle in bundles)
 
@@ -209,7 +209,9 @@ async def test_get_evaluation_submission_bundles_with_automatic_pagination_async
 
         # THEN I should get all bundles for the evaluation
         assert all_bundles is not None
-        assert len(all_bundles) >= len(multiple_submissions)  # At least our test submissions
+        assert len(all_bundles) >= len(
+            multiple_submissions
+        )  # At least our test submissions
 
         # AND each bundle should be valid
         for bundle in all_bundles:
@@ -286,7 +288,9 @@ async def test_get_user_submission_bundles_with_automatic_pagination_async(
 
         # THEN I should get all bundles for the user in this evaluation
         assert all_bundles is not None
-        assert len(all_bundles) >= len(multiple_submissions)  # At least our test submissions
+        assert len(all_bundles) >= len(
+            multiple_submissions
+        )  # At least our test submissions
 
         # AND each bundle should be valid
         for bundle in all_bundles:
@@ -634,7 +638,7 @@ async def test_get_submission_bundles_with_default_parameters_async(
             synapse_client=self.syn,
         ):
             eval_bundles.append(bundle)
-        
+
         user_bundles = []
         async for bundle in SubmissionBundle.get_user_submission_bundles_async(
             evaluation_id=test_evaluation.id,

tests/integration/synapseclient/models/synchronous/test_submission.py

@@ -239,9 +239,11 @@ async def test_get_evaluation_submissions(
         self, test_evaluation: Evaluation, test_submission: Submission
     ):
         # WHEN I get all submissions for an evaluation
-        submissions = list(Submission.get_evaluation_submissions(
-            evaluation_id=test_evaluation.id, synapse_client=self.syn
-        ))
+        submissions = list(
+            Submission.get_evaluation_submissions(
+                evaluation_id=test_evaluation.id, synapse_client=self.syn
+            )
+        )
 
         # THEN I should get a list of submission objects
         assert len(submissions) > 0
@@ -255,11 +257,13 @@ async def test_get_evaluation_submissions_with_status_filter(
         self, test_evaluation: Evaluation, test_submission: Submission
     ):
         # WHEN I get submissions filtered by status
-        submissions = list(Submission.get_evaluation_submissions(
-            evaluation_id=test_evaluation.id,
-            status="RECEIVED",
-            synapse_client=self.syn,
-        ))
+        submissions = list(
+            Submission.get_evaluation_submissions(
+                evaluation_id=test_evaluation.id,
+                status="RECEIVED",
+                synapse_client=self.syn,
+            )
+        )
 
         # The test submission should be in the results (initially in RECEIVED status)
         submission_ids = [sub.id for sub in submissions]
@@ -279,7 +283,7 @@ async def test_get_evaluation_submissions_generator_behavior(
         for submission in submissions_generator:
             assert isinstance(submission, Submission)
             submissions.append(submission)
-            
+
         # AND all submissions should be valid Submission objects
         assert all(isinstance(sub, Submission) for sub in submissions)
 
@@ -308,7 +312,7 @@ async def test_get_user_submissions_generator_behavior(
         for submission in submissions_generator:
             assert isinstance(submission, Submission)
             submissions.append(submission)
-            
+
         # AND all submissions should be valid Submission objects
         assert all(isinstance(sub, Submission) for sub in submissions)