Skip to content

Commit bf6a892

Browse files
dmgavdmgav
committed
ENH: rename 'config_create' to 'config_add'
1 parent 4eb067a commit bf6a892

File tree

9 files changed

+38
-38
lines changed

9 files changed

+38
-38
lines changed

‎src/save_and_restore_api/_api_async.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,9 @@ async def config_get(self, uniqueNodeId):
131131
method, url = self._prepare_config_get(uniqueNodeId=uniqueNodeId)
132132
return await self.send_request(method, url)
133133

134-
async def config_create(self, parentNodeId, *, configurationNode, configurationData, auth=None):
134+
async def config_add(self, parentNodeId, *, configurationNode, configurationData, auth=None):
135135
# Reusing docstrings from the threaded version
136-
method, url, params = self._prepare_config_create(
136+
method, url, params = self._prepare_config_add(
137137
parentNodeId=parentNodeId, configurationNode=configurationNode, configurationData=configurationData
138138
)
139139
return await self.send_request(method, url, params=params, auth=auth)
@@ -334,7 +334,7 @@ async def structure_path_nodes(self, path):
334334
SaveRestoreAPI.node_get_children.__doc__ = _SaveRestoreAPI_Threads.node_get_children.__doc__
335335
SaveRestoreAPI.node_get_parent.__doc__ = _SaveRestoreAPI_Threads.node_get_parent.__doc__
336336
SaveRestoreAPI.config_get.__doc__ = _SaveRestoreAPI_Threads.config_get.__doc__
337-
SaveRestoreAPI.config_create.__doc__ = _SaveRestoreAPI_Threads.config_create.__doc__
337+
SaveRestoreAPI.config_add.__doc__ = _SaveRestoreAPI_Threads.config_add.__doc__
338338
SaveRestoreAPI.config_update.__doc__ = _SaveRestoreAPI_Threads.config_update.__doc__
339339
SaveRestoreAPI.tags_get.__doc__ = _SaveRestoreAPI_Threads.tags_get.__doc__
340340
SaveRestoreAPI.tags_add.__doc__ = _SaveRestoreAPI_Threads.tags_add.__doc__

‎src/save_and_restore_api/_api_base.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ def _prepare_config_get(self, *, uniqueNodeId):
251251
method, url = "GET", f"/config/{uniqueNodeId}"
252252
return method, url
253253

254-
def _prepare_config_create(self, *, parentNodeId, configurationNode, configurationData):
254+
def _prepare_config_add(self, *, parentNodeId, configurationNode, configurationData):
255255
method, url = "PUT", f"/config?parentNodeId={parentNodeId}"
256256
configurationData = configurationData or {}
257257
params = {"configurationNode": configurationNode, "configurationData": configurationData}

‎src/save_and_restore_api/_api_threads.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ def config_get(self, uniqueNodeId):
191191
method, url = self._prepare_config_get(uniqueNodeId=uniqueNodeId)
192192
return self.send_request(method, url)
193193

194-
def config_create(self, parentNodeId, *, configurationNode, configurationData, auth=None):
194+
def config_add(self, parentNodeId, *, configurationNode, configurationData, auth=None):
195195
"""
196196
Creates a new configuration node under the specified parent node. Parameters:
197197
``configurationNode`` - the node metadata, ``configurationData`` - the configuration data.
@@ -209,7 +209,7 @@ def config_create(self, parentNodeId, *, configurationNode, configurationData, a
209209
210210
API: PUT /config?parentNodeId={parentNodeId}
211211
"""
212-
method, url, params = self._prepare_config_create(
212+
method, url, params = self._prepare_config_add(
213213
parentNodeId=parentNodeId, configurationNode=configurationNode, configurationData=configurationData
214214
)
215215
return self.send_request(method, url, params=params, auth=auth)

‎tests/test_compare_control.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def test_compare_01(clear_sar, ioc, library, usesetauth): # noqa: F811
4040
configurationNode = {"name": "Test Config"}
4141
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
4242

43-
response = SR.config_create(
43+
response = SR.config_add(
4444
root_folder_uid,
4545
configurationNode=configurationNode,
4646
configurationData=configurationData,
@@ -77,7 +77,7 @@ async def testing():
7777
configurationNode = {"name": "Test Config"}
7878
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
7979

80-
response = await SR.config_create(
80+
response = await SR.config_add(
8181
root_folder_uid,
8282
configurationNode=configurationNode,
8383
configurationData=configurationData,

‎tests/test_config_control.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
@pytest.mark.parametrize("usesetauth", [True, False])
2727
@pytest.mark.parametrize("library", ["THREADS", "ASYNC"])
2828
# fmt: on
29-
def test_config_create_01(clear_sar, library, usesetauth): # noqa: F811
29+
def test_config_add_01(clear_sar, library, usesetauth): # noqa: F811
3030
"""
31-
Tests for the 'config_create' and 'config_get' API.
31+
Tests for the 'config_add' and 'config_get' API.
3232
"""
3333

3434
root_folder_uid = create_root_folder()
@@ -71,7 +71,7 @@ def test_config_create_01(clear_sar, library, usesetauth): # noqa: F811
7171
folder_uid = response["uniqueId"]
7272

7373

74-
response = SR.config_create(
74+
response = SR.config_add(
7575
folder_uid, configurationNode=configurationNode, configurationData=configurationData, **auth
7676
)
7777
assert response["configurationNode"]["name"] == "Config"
@@ -99,7 +99,7 @@ async def testing():
9999
response = await SR.node_add(root_folder_uid, name="Child Folder", nodeType="FOLDER", **auth)
100100
folder_uid = response["uniqueId"]
101101

102-
response = await SR.config_create(
102+
response = await SR.config_add(
103103
folder_uid, configurationNode=configurationNode, configurationData=configurationData, **auth
104104
)
105105
assert response["configurationNode"]["name"] == "Config"
@@ -143,7 +143,7 @@ def test_config_update_01(clear_sar, library, usesetauth): # noqa: F811
143143
response = SR.node_add(root_folder_uid, name="Child Folder", nodeType="FOLDER", **auth)
144144
folder_uid = response["uniqueId"]
145145

146-
response = SR.config_create(
146+
response = SR.config_add(
147147
folder_uid, configurationNode={"name": "Config"}, configurationData={"pvList": pv_list1}, **auth
148148
)
149149
configurationNode = response["configurationNode"]
@@ -189,7 +189,7 @@ async def testing():
189189
response = await SR.node_add(root_folder_uid, name="Child Folder", nodeType="FOLDER", **auth)
190190
folder_uid = response["uniqueId"]
191191

192-
response = await SR.config_create(
192+
response = await SR.config_add(
193193
folder_uid,
194194
configurationNode={"name": "Config"},
195195
configurationData={"pvList": pv_list1},

‎tests/test_misc.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ def test_search_01(clear_sar, library): # noqa: F811
141141
configurationNode = {"name": "Test Config", "description": "Created for testing"}
142142
configurationData = {"pvList": []}
143143

144-
response = SR.config_create(
144+
response = SR.config_add(
145145
root_folder_uid,
146146
configurationNode=configurationNode,
147147
configurationData=configurationData,
@@ -169,7 +169,7 @@ async def testing():
169169
configurationNode = {"name": "Test Config", "description": "Created for testing"}
170170
configurationData = {"pvList": []}
171171

172-
response = await SR.config_create(
172+
response = await SR.config_add(
173173
root_folder_uid,
174174
configurationNode=configurationNode,
175175
configurationData=configurationData,

‎tests/test_snapshot_control.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def test_take_snapshot_get_01(clear_sar, library, usesetauth): # noqa: F811
4545
configurationNode = {"name": "Test Config"}
4646
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
4747

48-
response = SR.config_create(
48+
response = SR.config_add(
4949
root_folder_uid,
5050
configurationNode=configurationNode,
5151
configurationData=configurationData,
@@ -72,7 +72,7 @@ async def testing():
7272
configurationNode = {"name": "Test Config"}
7373
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
7474

75-
response = await SR.config_create(
75+
response = await SR.config_add(
7676
root_folder_uid,
7777
configurationNode=configurationNode,
7878
configurationData=configurationData,
@@ -112,7 +112,7 @@ def test_take_snapshot_save_01(clear_sar, library, usesetauth): # noqa: F811
112112
configurationNode = {"name": "Test Config"}
113113
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
114114

115-
response = SR.config_create(
115+
response = SR.config_add(
116116
root_folder_uid,
117117
configurationNode=configurationNode,
118118
configurationData=configurationData,
@@ -155,7 +155,7 @@ async def testing():
155155
configurationNode = {"name": "Test Config"}
156156
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
157157

158-
response = await SR.config_create(
158+
response = await SR.config_add(
159159
root_folder_uid,
160160
configurationNode=configurationNode,
161161
configurationData=configurationData,
@@ -212,7 +212,7 @@ def test_snapshot_add_01(clear_sar, library, usesetauth): # noqa: F811
212212
configurationNode = {"name": "Test Config"}
213213
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
214214

215-
response = SR.config_create(
215+
response = SR.config_add(
216216
root_folder_uid,
217217
configurationNode=configurationNode,
218218
configurationData=configurationData,
@@ -273,7 +273,7 @@ async def testing():
273273
configurationNode = {"name": "Test Config"}
274274
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
275275

276-
response = await SR.config_create(
276+
response = await SR.config_add(
277277
root_folder_uid,
278278
configurationNode=configurationNode,
279279
configurationData=configurationData,
@@ -352,7 +352,7 @@ def test_restore_node_01(clear_sar, library, usesetauth, restorenode): # noqa:
352352
configurationNode = {"name": "Test Config"}
353353
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
354354

355-
response = SR.config_create(
355+
response = SR.config_add(
356356
root_folder_uid,
357357
configurationNode=configurationNode,
358358
configurationData=configurationData,
@@ -389,7 +389,7 @@ async def testing():
389389
configurationNode = {"name": "Test Config"}
390390
configurationData = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()]}
391391

392-
response = await SR.config_create(
392+
response = await SR.config_add(
393393
root_folder_uid,
394394
configurationNode=configurationNode,
395395
configurationData=configurationData,
@@ -447,15 +447,15 @@ def test_composite_snapshot_add_01(clear_sar, ioc, library, usesetauth): # noqa
447447
configurationData2 = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()][5:]}
448448

449449
# Create two configurations
450-
response = SR.config_create(
450+
response = SR.config_add(
451451
root_folder_uid,
452452
configurationNode=configurationNode1,
453453
configurationData=configurationData1,
454454
**auth
455455
)
456456
config_uid1 = response["configurationNode"]["uniqueId"]
457457

458-
response = SR.config_create(
458+
response = SR.config_add(
459459
root_folder_uid,
460460
configurationNode=configurationNode2,
461461
configurationData=configurationData2,
@@ -524,15 +524,15 @@ async def testing():
524524
configurationData2 = {"pvList": [{"pvName": _} for _ in ioc_pvs.keys()][5:]}
525525

526526
# Create two configurations
527-
response = await SR.config_create(
527+
response = await SR.config_add(
528528
root_folder_uid,
529529
configurationNode=configurationNode1,
530530
configurationData=configurationData1,
531531
**auth
532532
)
533533
config_uid1 = response["configurationNode"]["uniqueId"]
534534

535-
response = await SR.config_create(
535+
response = await SR.config_add(
536536
root_folder_uid,
537537
configurationNode=configurationNode2,
538538
configurationData=configurationData2,

‎tests/test_structure_control.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ def test_structure_move_01(clear_sar, library, usesetauth, usemove): # noqa: F8
4444
folder2_uid = response["uniqueId"]
4545

4646
# Create two configurations in folder1
47-
response = SR.config_create(
47+
response = SR.config_add(
4848
folder1_uid,
4949
configurationNode={"name": "Config1"},
5050
configurationData={"pvList": []},
5151
**auth
5252
)
5353
config1_uid = response["configurationNode"]["uniqueId"]
54-
response = SR.config_create(
54+
response = SR.config_add(
5555
folder1_uid,
5656
configurationNode={"name": "Config2"},
5757
configurationData={"pvList": []},
@@ -91,14 +91,14 @@ async def testing():
9191
folder2_uid = response["uniqueId"]
9292

9393
# Create two configurations in folder1
94-
response = await SR.config_create(
94+
response = await SR.config_add(
9595
folder1_uid,
9696
configurationNode={"name": "Config1"},
9797
configurationData={"pvList": []},
9898
**auth
9999
)
100100
config1_uid = response["configurationNode"]["uniqueId"]
101-
response = await SR.config_create(
101+
response = await SR.config_add(
102102
folder1_uid,
103103
configurationNode={"name": "Config2"},
104104
configurationData={"pvList": []},
@@ -157,7 +157,7 @@ def test_structure_path_01(clear_sar, library, usesetauth): # noqa: F811
157157
folder2_uid = response["uniqueId"]
158158

159159
# Create two configurations in folder1
160-
response = SR.config_create(
160+
response = SR.config_add(
161161
folder1_uid,
162162
configurationNode={"name": node_name},
163163
configurationData={"pvList": []},
@@ -185,7 +185,7 @@ async def testing():
185185
folder2_uid = response["uniqueId"]
186186

187187
# Create two configurations in folder1
188-
response = await SR.config_create(
188+
response = await SR.config_add(
189189
folder1_uid,
190190
configurationNode={"name": node_name},
191191
configurationData={"pvList": []},

‎tests/test_tag_control.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ def test_tags_01(clear_sar, library, usesetauth): # noqa: F811
3838
response = SR.node_add(root_folder_uid, name="folder", nodeType="FOLDER", **auth)
3939
folder_uid = response["uniqueId"]
4040

41-
response = SR.config_create(
41+
response = SR.config_add(
4242
folder_uid, configurationNode={"name": "config_1"}, configurationData={"pvList": []}, **auth
4343
)
4444
config_1_uid = response["configurationNode"]["uniqueId"]
4545

46-
response = SR.config_create(
46+
response = SR.config_add(
4747
folder_uid, configurationNode={"name": "config_2"}, configurationData={"pvList": []}, **auth
4848
)
4949
config_2_uid = response["configurationNode"]["uniqueId"]
@@ -90,12 +90,12 @@ async def testing():
9090
response = await SR.node_add(root_folder_uid, name="folder", nodeType="FOLDER", **auth)
9191
folder_uid = response["uniqueId"]
9292

93-
response = await SR.config_create(
93+
response = await SR.config_add(
9494
folder_uid, configurationNode={"name": "config_1"}, configurationData={"pvList": []}, **auth
9595
)
9696
config_1_uid = response["configurationNode"]["uniqueId"]
9797

98-
response = await SR.config_create(
98+
response = await SR.config_add(
9999
folder_uid, configurationNode={"name": "config_2"}, configurationData={"pvList": []}, **auth
100100
)
101101
config_2_uid = response["configurationNode"]["uniqueId"]

0 commit comments

Comments
 (0)