Skip to content

Commit 5d21697

Browse files
BryanFaubleBryanFauble
authored
[SYNPY-1653] Create RecordSet, Grid, and CurationTask classes (#1246)
* Create RecordSet, Grid, and CurationTask classes
1 parent c437ddf commit 5d21697

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+6260
-226
lines changed

‎.github/workflows/build.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ jobs:
8484
path: |
8585
${{ steps.get-dependencies.outputs.site_packages_loc }}
8686
${{ steps.get-dependencies.outputs.site_bin_dir }}
87-
key: ${{ runner.os }}-${{ matrix.python }}-build-${{ env.cache-name }}-${{ hashFiles('setup.py') }}-v24
87+
key: ${{ runner.os }}-${{ matrix.python }}-build-${{ env.cache-name }}-${{ hashFiles('setup.py') }}-v27
8888

8989
- name: Install py-dependencies
9090
if: steps.cache-dependencies.outputs.cache-hit != 'true'

‎docs/reference/experimental/async/curator.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Curator
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API reference
8+
9+
[](){ #curation-task-reference-async }
10+
::: synapseclient.models.CurationTask
11+
options:
12+
inherited_members: true
13+
members:
14+
- get_async
15+
- delete_async
16+
- store_async
17+
- list_async
18+
---
19+
20+
[](){ #RecordSet-reference-async }
21+
::: synapseclient.models.RecordSet
22+
options:
23+
inherited_members: true
24+
members:
25+
- get_async
26+
- store_async
27+
- delete_async
28+
- get_acl_async
29+
- get_permissions_async
30+
- set_permissions_async
31+
- delete_permissions_async
32+
- list_acl_async
33+
- bind_schema_async
34+
- get_schema_async
35+
- unbind_schema_async
36+
- validate_schema_async
37+
- get_schema_derived_keys_async
38+
---
39+
[](){ #RecordBasedMetadataTaskProperties-reference-async }
40+
::: synapseclient.models.RecordBasedMetadataTaskProperties
41+
options:
42+
inherited_members: true
43+
members:
44+
---
45+
[](){ #FileBasedMetadataTaskProperties-reference-async }
46+
::: synapseclient.models.FileBasedMetadataTaskProperties
47+
options:
48+
inherited_members: true
49+
members:
50+
---
51+
[](){ #grid-reference-async }
52+
::: synapseclient.models.Grid
53+
options:
54+
inherited_members: true
55+
members:
56+
- create_async
57+
- export_to_record_set_async
58+
---
59+
[](){ #query-reference-async }
60+
::: synapseclient.models.Query
61+
options:
62+
inherited_members: true
63+
members:
64+
---

‎docs/reference/experimental/sync/curator.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Curator
2+
3+
Contained within this file are experimental interfaces for working with the Synapse Python
4+
Client. Unless otherwise noted these interfaces are subject to change at any time. Use
5+
at your own risk.
6+
7+
## API reference
8+
9+
[](){ #curation-task-reference }
10+
::: synapseclient.models.CurationTask
11+
options:
12+
inherited_members: true
13+
members:
14+
- get
15+
- delete
16+
- store
17+
- list
18+
---
19+
20+
[](){ #RecordSet-reference }
21+
::: synapseclient.models.RecordSet
22+
options:
23+
inherited_members: true
24+
members:
25+
- get
26+
- store
27+
- delete
28+
- get_acl
29+
- get_permissions
30+
- set_permissions
31+
- delete_permissions
32+
- list_acl
33+
- bind_schema
34+
- get_schema
35+
- unbind_schema
36+
- validate_schema
37+
- get_schema_derived_keys
38+
---
39+
[](){ #RecordBasedMetadataTaskProperties-reference }
40+
::: synapseclient.models.RecordBasedMetadataTaskProperties
41+
options:
42+
inherited_members: true
43+
members:
44+
---
45+
[](){ #FileBasedMetadataTaskProperties-reference }
46+
::: synapseclient.models.FileBasedMetadataTaskProperties
47+
options:
48+
inherited_members: true
49+
members:
50+
---
51+
[](){ #grid-reference }
52+
::: synapseclient.models.Grid
53+
options:
54+
inherited_members: true
55+
members:
56+
- create
57+
- export_to_record_set
58+
---
59+
[](){ #query-reference }
60+
::: synapseclient.models.Query
61+
options:
62+
inherited_members: true
63+
members:
64+
---

‎mkdocs.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ nav:
9595
- Activity: reference/experimental/sync/activity.md
9696
- Team: reference/experimental/sync/team.md
9797
- UserProfile: reference/experimental/sync/user_profile.md
98+
- Curator: reference/experimental/sync/curator.md
9899
- Link: reference/experimental/sync/link_entity.md
99100
- Functional Interfaces: reference/experimental/functional_interfaces.md
100101
- Asynchronous:
@@ -113,6 +114,7 @@ nav:
113114
- Activity: reference/experimental/async/activity.md
114115
- Team: reference/experimental/async/team.md
115116
- UserProfile: reference/experimental/async/user_profile.md
117+
- Curator: reference/experimental/async/curator.md
116118
- Link: reference/experimental/async/link_entity.md
117119
- Mixins:
118120
- AccessControllable: reference/experimental/mixins/access_controllable.md
@@ -192,6 +194,8 @@ plugins:
192194
docstring_section_style: spacy
193195
filters:
194196
- "!^_"
197+
- "!to_synapse_request"
198+
- "!fill_from_dict"
195199
separate_signature: True
196200
show_signature_annotations: True
197201
signature_crossrefs: True

‎setup.cfg‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ tests_require =
6868
pytest~=8.2.0
6969
pytest-mock>=3.0,<4.0
7070
pytest-socket~=0.6.0
71-
pytest-asyncio>=0.25.0,<1.0
71+
pytest-asyncio>=1.2.0,<2.0
7272
flake8>=3.7.0,<4.0
7373
pytest-xdist[psutil]>=2.2,<3.0.0
7474
pytest-rerunfailures~=12.0
@@ -81,7 +81,7 @@ dev =
8181
pytest~=8.2.0
8282
pytest-mock>=3.0,<4.0
8383
pytest-socket~=0.6.0
84-
pytest-asyncio>=0.25.0,<1.0
84+
pytest-asyncio>=1.2.0,<2.0
8585
flake8>=3.7.0,<4.0
8686
pytest-xdist[psutil]>=2.2,<3.0.0
8787
pytest-rerunfailures~=12.0
@@ -95,7 +95,7 @@ tests =
9595
pytest~=8.2.0
9696
pytest-mock>=3.0,<4.0
9797
pytest-socket~=0.6.0
98-
pytest-asyncio>=0.25.0,<1.0
98+
pytest-asyncio>=1.2.0,<2.0
9999
flake8>=3.7.0,<4.0
100100
pytest-xdist[psutil]>=2.2,<3.0.0
101101
pytest-rerunfailures~=12.0

‎synapseclient/api/__init__.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@
1616
get_config_section_dict,
1717
get_transfer_config,
1818
)
19+
from .curation_services import (
20+
create_curation_task,
21+
delete_curation_task,
22+
delete_grid_session,
23+
get_curation_task,
24+
list_curation_tasks,
25+
list_grid_sessions,
26+
update_curation_task,
27+
)
1928
from .entity_bundle_services_v2 import (
2029
get_entity_id_bundle2,
2130
get_entity_id_version_bundle2,
@@ -235,6 +244,14 @@
235244
"get_membership_status",
236245
"delete_membership_invitation",
237246
"invite_to_team",
247+
# curation_services
248+
"create_curation_task",
249+
"delete_curation_task",
250+
"delete_grid_session",
251+
"get_curation_task",
252+
"list_curation_tasks",
253+
"list_grid_sessions",
254+
"update_curation_task",
238255
# user_services
239256
"get_user_bundle",
240257
"get_user_by_principal_id_or_name",

0 commit comments

Comments
 (0)