[SYNPY-1577] Submission View

[BryanFauble]

Problem:

• The Synapse Python Client lacked the ability to programmatically work with Submission Views using an object-orientated approach

Solution:

• Added a new SubmissionView model class that represents Synapse Submission Views.
• Added both synchronous and asynchronous implementations to maintain consistency with the rest of the client.
• Key features implemented include:
  • Creating new submission views
  • Adding/removing evaluation queues from the view scope
  • Querying submissions across multiple evaluation queues
  • Creating snapshots to capture submission states at a point in time
  • Reordering columns for better data presentation
• Added comprehensive documentation including:
  • New API reference documentation for both sync and async implementations
  • A detailed tutorial with step-by-step examples
  • Example code demonstrating complete workflows

Testing:

• Created a tutorial script that serves as both documentation and a functional test of the implementation.
• The tutorial demonstrates the full workflow including:
  • Creating evaluation queues
  • Submitting files to the queues
  • Creating a submission view based on these queues
  • Querying the submission view
  • Modifying the view scope
  • Creating a snapshot of the view
• Added automated tests in both synchronous and asynchronous testing suites:
  • tests/integration/test_submissionview.py
  • tests/integration/async/test_submissionview_async.py
• Documentation was tested through ReadTheDocs build to ensure proper rendering and inclusion in the navigation structure.
• Manual testing was performed to verify functionality matches the Synapse web interface capabilities.

[Copilot]

Pull Request Overview

This PR adds comprehensive support for a new SubmissionView model to the Synapse Python Client. Key changes include:

• Introducing the SubmissionView model and integrating it in model imports, constants, and factory mappings.
• Updating the client submission logic to support both dataclass and dictionary representations.
• Adding a complete tutorial script and updated documentation for both synchronous and asynchronous interfaces.

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
synapseclient/models/services/storable_entity_components.py	Added SubmissionView to type unions and updated activity change logic.
synapseclient/models/mixins/table_components.py	Included SubmissionView in the list of classes that contain row etags.
synapseclient/models/init.py	Exported SubmissionView accordingly.
synapseclient/core/constants/concrete_types.py	Added SUBMISSION_VIEW constant to the concrete types.
synapseclient/client.py	Updated submit handling for dataclass-based entities with SubmissionView.
synapseclient/api/entity_factory.py	Mapped the concrete type SUBMISSION_VIEW to the SubmissionView model.
mkdocs.yml	Updated navigation to include SubmissionView documentation.
docs/tutorials/python/tutorial_scripts/submissionview.py	Added a comprehensive tutorial script for SubmissionView usage.
docs/tutorials/python/submissionview.md	Created tutorial documentation for SubmissionView.
docs/reference/experimental/sync/submissionview.md	Added new API reference documentation for SubmissionView (sync).
docs/reference/experimental/async/submissionview.md	Added new API reference documentation for SubmissionView (async).
.readthedocs.yaml	Modified reference ranking settings for improved documentation ordering.

[Copilot]

The use of both 'delete' and 'delete_on_close' parameters in NamedTemporaryFile is non-standard and may lead to unexpected behavior; consider using only one appropriate parameter based on your intended file deletion behavior.

Suggested change

	mode="w", suffix=".txt", delete=True, delete_on_close=False
	mode="w", suffix=".txt", delete=True

[BryanFauble]

Bad suggestion. Using both means the file is deleted when leaving the content managed "with" statement, but not deleted the moment we stop writing to the file through I/O

[thomasyu888]

🔥 LGTM! Took a peak at the tests and also tutorial. Thanks for that! Will defer to the team for the final review. It does seem like tests are taking awhile to run now due to all these calls. 😅

I think we could have others do the conversion of the challenge services into OOP when we get there.

[BWMac]

🔥