[SYNPY-1590] Implement core functionality of Submission(+Status, +Bundle) OOP model #1251

jaymedina · 2025-09-30T15:34:17Z

All tests passing:

(synapseclient) bash-3.2$ pytest tests/integration/synapseclient/models/synchronous/*submission*.py 
======================================================================= test session starts ========================================================================
platform darwin -- Python 3.9.18, pytest-8.3.3, pluggy-1.5.0
rootdir: /Users/jmedina/Documents/forks/synapsePythonClient
configfile: pytest.ini
plugins: asyncio-0.24.0, socket-0.7.0, anyio-4.6.0, mock-3.14.0
asyncio: mode=auto, default_loop_scope=session
collected 67 items                                                                                                                                                 

tests/integration/synapseclient/models/synchronous/test_submission.py .....................                                                                  [ 31%]
tests/integration/synapseclient/models/synchronous/test_submission_bundle.py ...............                                                                 [ 53%]
tests/integration/synapseclient/models/synchronous/test_submission_status.py .......................                                                         [ 88%]
tests/integration/synapseclient/models/synchronous/test_submissionview.py ........                                                                           [100%]

======================================================================= test session starts ========================================================================
platform darwin -- Python 3.9.18, pytest-8.3.3, pluggy-1.5.0
rootdir: /Users/jmedina/Documents/forks/synapsePythonClient
configfile: pytest.ini
plugins: asyncio-0.24.0, socket-0.7.0, anyio-4.6.0, mock-3.14.0
asyncio: mode=auto, default_loop_scope=session
collected 68 items                                                                                                                                                 

tests/integration/synapseclient/models/async/test_submission_async.py ......................                                                                 [ 32%]
tests/integration/synapseclient/models/async/test_submission_bundle_async.py ...............                                                                 [ 54%]
tests/integration/synapseclient/models/async/test_submission_status_async.py .......................                                                         [ 88%]

======================================================================= test session starts ========================================================================
platform darwin -- Python 3.9.18, pytest-8.3.3, pluggy-1.5.0
rootdir: /Users/jmedina/Documents/forks/synapsePythonClient
configfile: pytest.ini
plugins: asyncio-0.24.0, socket-0.7.0, anyio-4.6.0, mock-3.14.0
asyncio: mode=auto, default_loop_scope=session
collected 53 items                                                                                                                                                 

tests/unit/synapseclient/models/async/unit_test_submission_async.py ................                                                                         [ 30%]
tests/unit/synapseclient/models/async/unit_test_submission_bundle_async.py ..............                                                                    [ 56%]
tests/unit/synapseclient/models/async/unit_test_submission_status_async.py .......................                                                           [100%]

======================================================================== 53 passed in 1.61s ========================================================================

======================================================================= test session starts ========================================================================
platform darwin -- Python 3.9.18, pytest-8.3.3, pluggy-1.5.0
rootdir: /Users/jmedina/Documents/forks/synapsePythonClient
configfile: pytest.ini
plugins: asyncio-0.24.0, socket-0.7.0, anyio-4.6.0, mock-3.14.0
asyncio: mode=auto, default_loop_scope=session
collected 67 items                                                                                                                                                 

tests/unit/synapseclient/models/synchronous/unit_test_submission.py .............................                                                            [ 43%]
tests/unit/synapseclient/models/synchronous/unit_test_submission_bundle.py ...............                                                                   [ 65%]
tests/unit/synapseclient/models/synchronous/unit_test_submission_status.py .......................                                                           [100%]

synapseclient/models/submission_status.py

synapseclient/models/submission.py

…issionstatus file

…rn as evaluations design

…OR submission annotations

jaymedina · 2025-12-04T19:51:15Z

Looking good so far! I didn't see any deprecations, will you be doing that as part of this PR?

@andrewelamb that's been done in PR #1252 which I'll address after addressing all the threads here.

…ation

jaymedina · 2025-12-22T18:28:12Z

All tests are passing, so I will merge this into the *main feature branch to collapse the commits:

===================================================================================== test session starts =====================================================================================
platform darwin -- Python 3.9.18, pytest-8.3.3, pluggy-1.5.0
rootdir: /Users/jmedina/Documents/forks/synapsePythonClient
configfile: pytest.ini
plugins: asyncio-0.24.0, socket-0.7.0, anyio-4.6.0, mock-3.14.0
asyncio: mode=auto, default_loop_scope=session
collected 233 items                                                                                                                                                                           

tests/integration/synapseclient/models/synchronous/test_submission_bundle.py ..............                                                                                             [  6%]
tests/integration/synapseclient/models/synchronous/test_submission.py .....................                                                                                             [ 15%]
tests/integration/synapseclient/models/synchronous/test_submission_status.py ......................                                                                                     [ 24%]
tests/integration/synapseclient/models/async/test_submission_bundle_async.py ...............                                                                                            [ 30%]
tests/integration/synapseclient/models/async/test_submission_async.py ......................                                                                                            [ 40%]
tests/integration/synapseclient/models/async/test_submission_status_async.py ......................                                                                                     [ 49%]
tests/unit/synapseclient/models/synchronous/unit_test_submission_bundle.py ..............                                                                                               [ 55%]
tests/unit/synapseclient/models/synchronous/unit_test_submission.py .............................                                                                                       [ 68%]
tests/unit/synapseclient/models/synchronous/unit_test_submission_status.py ......................                                                                                       [ 77%]
tests/unit/synapseclient/models/async/unit_test_submission_bundle_async.py ..............                                                                                               [ 83%]
tests/unit/synapseclient/models/async/unit_test_submission_async.py ................                                                                                                    [ 90%]
tests/unit/synapseclient/models/async/unit_test_submission_status_async.py ......................                                                                                       [100%]

=============================================================================== 233 passed in 120.44s (0:02:00) ===============================================================================

jaymedina mentioned this pull request Oct 9, 2025

[SYNPY-1590] Implement Submission(+Status, +Bundle) OOP model #1250

Open

15 tasks

jaymedina force-pushed the synpy-1590-submission-model-main branch from 8b50d06 to a061fb4 Compare November 5, 2025 14:46

jaymedina force-pushed the synpy-1590-submission-model-functionality branch from 62ce5fb to f0d7ecc Compare November 5, 2025 15:04

jaymedina commented Nov 12, 2025

View reviewed changes

synapseclient/models/submission_status.py Show resolved Hide resolved

jaymedina commented Nov 21, 2025

View reviewed changes

synapseclient/models/submission.py Outdated Show resolved Hide resolved

jaymedina marked this pull request as ready for review November 21, 2025 19:29

jaymedina requested a review from a team as a code owner November 21, 2025 19:29

tdd initial tests

c748132

jaymedina force-pushed the synpy-1590-submission-model-main branch from a061fb4 to c748132 Compare December 1, 2025 16:33

jaymedina added 21 commits December 1, 2025 11:35

initial intro of dataclasses

33643ae

expose api services for submission object

8a074e6

style and update docstring

c97b891

add submission and submissionstatus models

f79f683

add submission status retrieval and update methods; remove empty subm…

99ebaa1

…issionstatus file

pipe query params directly into restAPI httpx requests

33c651f

new dataclass object submission_bundle

ae05b91

move submission services functions to evaluation_services.py

f51188d

renaming imports, to_synapse_request, request body refactor

33f7a6a

patching up store method signature

4a91a2e

update docs

65eac22

new suite of tests

a5ec33a

submissionstatus rework as a mutable object

a160585

bug fix for Statuses: updated to_synapse_request to follow same patte…

660259e

…rn as evaluations design

replace != with is not for full object comparison (not just keys)

55a229c

expose the is_private arg for to_submission_status_annotations ONLY F…

3479046

…OR submission annotations

fixed submission status/submission annotations

896a3c1

add support for legacy annotations

26a02f1

remove debug prints

271181a

get_all_submission_statuses now returns a list of substat objects

c8c1041

docstring updates

0436931

jaymedina added 3 commits December 4, 2025 14:12

remove Dict, List imports

48468c6

fix broken tests due to removed evaluation_id attr

23a2779

style

72a4dd0

jaymedina added 23 commits December 4, 2025 15:43

import classes directly from typing. remove Dict and List.

8dd2db4

style

b75c566

add API reference links to _fetch_latest_entity

be4278a

type hint should be logging.Logger instance (generic or Synapse client)

5a70bd1

explicit import to follow the other imports

a54ade1

import order

890005e

minimize indenting by using if not:

0b0fa0c

raise ValueError(no etag for entity) sooner

96f2dd7

remove docker submission async integration test

acedf26

link Jira ticket to TODO item

75bad96

remove old cancel submission test

ea52424

remove old cancel submission test (async)

f08a6ad

assert the SubmissionStatus object has not changed

e5189d6

valueError(msg) from e

42d0c54

ValueError -> LookupError

8ef400a

add evaluation_round_id and explicit optional_fields dict for organiz…

05e5218

…ation

loop over optionalfields for SubmissionStatus

7c7d474

new global var: POSSIBLE_STATUSES

40e95cd

same for sync

64395dd

remove validation using response

0765d1c

style

6a8432b

correctly pass synapse_client instance

d5bff02

use prior synapse_client instance. LookupError message

ad5f833

jaymedina merged commit 433ec88 into synpy-1590-submission-model-main Dec 22, 2025
10 of 19 checks passed

jaymedina deleted the synpy-1590-submission-model-functionality branch December 22, 2025 18:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[SYNPY-1590] Implement core functionality of Submission(+Status, +Bundle) OOP model #1251

[SYNPY-1590] Implement core functionality of Submission(+Status, +Bundle) OOP model #1251

Uh oh!

jaymedina commented Sep 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

jaymedina commented Dec 4, 2025

Uh oh!

jaymedina commented Dec 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

[SYNPY-1590] Implement core functionality of Submission(+Status, +Bundle) OOP model #1251

[SYNPY-1590] Implement core functionality of Submission(+Status, +Bundle) OOP model #1251

Uh oh!

Conversation

jaymedina commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jaymedina commented Dec 4, 2025

Uh oh!

jaymedina commented Dec 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jaymedina commented Sep 30, 2025 •

edited

Loading