Skip to content

[SYNPY-1589] Implement core functionality of Evaluation OOP model #1245

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
Parent: [SYNPY-1589] Implement "Evaluation" OOP model
merged 42 commits into from
Oct 17, 2025
Merged

[SYNPY-1589] Implement core functionality of Evaluation OOP model #1245

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
ff145d7
Initialize protocol class + Evaluation dataclass
jaymedina Sep 11, 2025
d3f6aed
exposing Evaluation API services. dataclass updates. syntax updates.
jaymedina Sep 12, 2025
e6f6ac7
dataclass methods are added which wrap API service functions
jaymedina Sep 12, 2025
8d9d8b3
fixed missing imports and syntax failures
jaymedina Sep 12, 2025
3195cd5
Evaluations can be imported like from synapseclient.models import Eva…
jaymedina Sep 15, 2025
63ed998
correct ACL inputs and output types. first pass at fixing async integ…
jaymedina Sep 15, 2025
821fbd3
fix import issues
jaymedina Sep 15, 2025
cfa4436
fix type errors. api module and its functions can now be imported ind…
jaymedina Sep 15, 2025
6d14de3
add etag to prevent issues from OCC when updating an evaluation
jaymedina Sep 16, 2025
6e92d8e
some formatting
jaymedina Sep 16, 2025
c05c628
refactor: update and create will rely on the attributes changing in t…
jaymedina Sep 16, 2025
62fde96
remove principal_id param. cannot be used. adding examples to docstrings
jaymedina Sep 17, 2025
f743c68
patch all async tests
jaymedina Sep 17, 2025
b7bb1a6
style
jaymedina Sep 17, 2025
87b07bb
remove unnecessary imports
jaymedina Sep 18, 2025
ecfc2d2
complete refactor of store/update. store is now used for updating too
jaymedina Sep 19, 2025
fc6190f
add example to Evaluation dataclass
jaymedina Sep 22, 2025
4211317
new evaluation protocol class. moved out to protocols subfolder
jaymedina Sep 22, 2025
f6c23cb
add synchronous integration tests
jaymedina Sep 22, 2025
54032e9
new unit tests. updated integration tests. content_source is an immut…
jaymedina Sep 22, 2025
7cdf25e
show available access types
jaymedina Sep 23, 2025
94a3b80
remove todo
jaymedina Sep 24, 2025
e94f14f
get logger instance
jaymedina Sep 24, 2025
130b475
no need for request_type param in store_evaluation_async. removing CA…
jaymedina Sep 24, 2025
001423e
docstring example formatting
jaymedina Sep 24, 2025
1c0ff6a
update examples in docstrings
jaymedina Sep 24, 2025
4a33c9f
the logger called in merge_dataclass_entities is now retrieved from a…
jaymedina Sep 25, 2025
808c040
remove _async suffix from evaluation_services functions
jaymedina Sep 25, 2025
5e604ef
style
jaymedina Sep 25, 2025
af6d6bc
updated docstrings
jaymedina Sep 30, 2025
39995be
store -> create_or_update, updated tests
jaymedina Oct 1, 2025
e5ad067
style
jaymedina Oct 1, 2025
0e220de
refactor update_acl dataclass method for user qol
jaymedina Oct 1, 2025
17177f4
give users option to remove principals from ACL
jaymedina Oct 1, 2025
8fd7db2
convert sync test methods to async so it calls schedule_for_cleanup f…
jaymedina Oct 2, 2025
1d577a3
style
jaymedina Oct 2, 2025
b2ee087
if/elif -> if/else
jaymedina Oct 6, 2025
e42b27a
iteratively grab the attributes instead
jaymedina Oct 6, 2025
e442f61
request_type is now a CREATE/UPDATE enum
jaymedina Oct 6, 2025
4d84d05
feed query params directly into client httpx response call so it can …
jaymedina Oct 13, 2025
86688cd
style
jaymedina Oct 13, 2025
198c24c
grab the logger outside of the for-loop
jaymedina Oct 17, 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
23 changes: 23 additions & 0 deletions synapseclient/api/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,18 @@
update_activity,
update_entity_acl,
)
from .evaluation_services import (
create_evaluation_async,
delete_evaluation_async,
get_all_evaluations_async,
get_available_evaluations_async,
get_evaluation_acl_async,
get_evaluation_async,
get_evaluation_permissions_async,
get_evaluations_by_project_async,
update_evaluation_acl_async,
update_evaluation_async,
)
from .file_services import (
AddPartResponse,
get_file_handle,
Expand Down Expand Up @@ -242,4 +254,15 @@
"is_user_certified",
# table_services
"create_table_snapshot",
# evaluation_services
"create_evaluation_async",
"get_evaluation_async",
"get_evaluations_by_project_async",
"get_all_evaluations_async",
"get_available_evaluations_async",
"update_evaluation_async",
"delete_evaluation_async",
"get_evaluation_acl_async",
"update_evaluation_acl_async",
"get_evaluation_permissions_async",
]
Loading
Loading