sapiopycommons 2025.7.8a581__py3-none-any.whl → 2025.7.9a582__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of sapiopycommons might be problematic. Click here for more details.
- sapiopycommons/ai/__init__.py +0 -0
- sapiopycommons/ai/api/fielddefinitions/proto/fields_pb2.py +43 -0
- sapiopycommons/ai/api/fielddefinitions/proto/fields_pb2.pyi +31 -0
- sapiopycommons/ai/api/fielddefinitions/proto/fields_pb2_grpc.py +24 -0
- sapiopycommons/ai/api/fielddefinitions/proto/velox_field_def_pb2.py +123 -0
- sapiopycommons/ai/api/fielddefinitions/proto/velox_field_def_pb2.pyi +598 -0
- sapiopycommons/ai/api/fielddefinitions/proto/velox_field_def_pb2_grpc.py +24 -0
- sapiopycommons/ai/api/plan/proto/step_output_pb2.py +45 -0
- sapiopycommons/ai/api/plan/proto/step_output_pb2.pyi +42 -0
- sapiopycommons/ai/api/plan/proto/step_output_pb2_grpc.py +24 -0
- sapiopycommons/ai/api/plan/proto/step_pb2.py +43 -0
- sapiopycommons/ai/api/plan/proto/step_pb2.pyi +43 -0
- sapiopycommons/ai/api/plan/proto/step_pb2_grpc.py +24 -0
- sapiopycommons/ai/api/plan/script/proto/script_pb2.py +55 -0
- sapiopycommons/ai/api/plan/script/proto/script_pb2.pyi +115 -0
- sapiopycommons/ai/api/plan/script/proto/script_pb2_grpc.py +153 -0
- sapiopycommons/ai/api/plan/tool/proto/entry_pb2.py +57 -0
- sapiopycommons/ai/api/plan/tool/proto/entry_pb2.pyi +96 -0
- sapiopycommons/ai/api/plan/tool/proto/entry_pb2_grpc.py +24 -0
- sapiopycommons/ai/api/plan/tool/proto/tool_pb2.py +67 -0
- sapiopycommons/ai/api/plan/tool/proto/tool_pb2.pyi +220 -0
- sapiopycommons/ai/api/plan/tool/proto/tool_pb2_grpc.py +154 -0
- sapiopycommons/ai/api/session/proto/sapio_conn_info_pb2.py +39 -0
- sapiopycommons/ai/api/session/proto/sapio_conn_info_pb2.pyi +32 -0
- sapiopycommons/ai/api/session/proto/sapio_conn_info_pb2_grpc.py +24 -0
- sapiopycommons/ai/protobuf_utils.py +508 -0
- sapiopycommons/ai/test_client.py +251 -0
- sapiopycommons/ai/tool_service_base.py +798 -0
- sapiopycommons/callbacks/callback_util.py +332 -665
- sapiopycommons/callbacks/field_builder.py +0 -2
- sapiopycommons/chem/IndigoMolecules.py +1 -31
- sapiopycommons/chem/Molecules.py +3 -3
- sapiopycommons/customreport/auto_pagers.py +1 -26
- sapiopycommons/customreport/term_builder.py +1 -1
- sapiopycommons/datatype/pseudo_data_types.py +326 -349
- sapiopycommons/eln/experiment_handler.py +767 -408
- sapiopycommons/eln/experiment_report_util.py +6 -11
- sapiopycommons/eln/plate_designer.py +2 -7
- sapiopycommons/files/file_util.py +5 -7
- sapiopycommons/general/accession_service.py +2 -2
- sapiopycommons/general/aliases.py +1 -3
- sapiopycommons/general/audit_log.py +0 -7
- sapiopycommons/general/custom_report_util.py +0 -12
- sapiopycommons/processtracking/custom_workflow_handler.py +1 -11
- sapiopycommons/processtracking/endpoints.py +0 -27
- sapiopycommons/recordmodel/record_handler.py +317 -657
- sapiopycommons/rules/eln_rule_handler.py +1 -8
- sapiopycommons/rules/on_save_rule_handler.py +1 -8
- sapiopycommons/webhook/webhook_handlers.py +0 -3
- sapiopycommons/webhook/webservice_handlers.py +2 -2
- {sapiopycommons-2025.7.8a581.dist-info → sapiopycommons-2025.7.9a582.dist-info}/METADATA +2 -2
- sapiopycommons-2025.7.9a582.dist-info/RECORD +92 -0
- sapiopycommons/chem/ps_commons.py +0 -455
- sapiopycommons/eln/experiment_cache.py +0 -188
- sapiopycommons/eln/experiment_step_factory.py +0 -476
- sapiopycommons/eln/step_creation.py +0 -236
- sapiopycommons/general/data_structure_util.py +0 -115
- sapiopycommons-2025.7.8a581.dist-info/RECORD +0 -69
- {sapiopycommons-2025.7.8a581.dist-info → sapiopycommons-2025.7.9a582.dist-info}/WHEEL +0 -0
- {sapiopycommons-2025.7.8a581.dist-info → sapiopycommons-2025.7.9a582.dist-info}/licenses/LICENSE +0 -0
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
from __future__ import annotations
|
|
2
2
|
|
|
3
|
-
import io
|
|
4
3
|
import warnings
|
|
5
4
|
from collections.abc import Iterable
|
|
6
|
-
from typing import Collection
|
|
7
5
|
from weakref import WeakValueDictionary
|
|
8
6
|
|
|
9
7
|
from sapiopylib.rest.DataRecordManagerService import DataRecordManager
|
|
@@ -15,31 +13,21 @@ from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
|
|
|
15
13
|
from sapiopylib.rest.pojo.eln.SapioELNEnums import ElnBaseDataType
|
|
16
14
|
from sapiopylib.rest.utils.autopaging import QueryDataRecordsAutoPager, QueryDataRecordByIdListAutoPager, \
|
|
17
15
|
QueryAllRecordsOfTypeAutoPager
|
|
18
|
-
from sapiopylib.rest.utils.recordmodel.PyRecordModel import PyRecordModel
|
|
19
|
-
RecordModelPropertyType, AbstractRecordModelPropertyAdder, AbstractRecordModelPropertySetter, \
|
|
20
|
-
AbstractRecordModelPropertyRemover
|
|
16
|
+
from sapiopylib.rest.utils.recordmodel.PyRecordModel import PyRecordModel
|
|
21
17
|
from sapiopylib.rest.utils.recordmodel.RecordModelManager import RecordModelManager, RecordModelInstanceManager, \
|
|
22
18
|
RecordModelRelationshipManager
|
|
23
19
|
from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType, WrappedRecordModel
|
|
24
20
|
from sapiopylib.rest.utils.recordmodel.RelationshipPath import RelationshipPath, RelationshipNode, \
|
|
25
21
|
RelationshipNodeType
|
|
26
22
|
from sapiopylib.rest.utils.recordmodel.ancestry import RecordModelAncestorManager
|
|
27
|
-
from sapiopylib.rest.utils.recordmodel.properties import Parents, Parent, Children, Child, ForwardSideLink
|
|
28
23
|
|
|
29
24
|
from sapiopycommons.general.aliases import RecordModel, SapioRecord, FieldMap, FieldIdentifier, AliasUtil, \
|
|
30
|
-
FieldIdentifierMap, FieldValue, UserIdentifier, FieldIdentifierKey
|
|
25
|
+
FieldIdentifierMap, FieldValue, UserIdentifier, FieldIdentifierKey
|
|
31
26
|
from sapiopycommons.general.custom_report_util import CustomReportUtil
|
|
32
27
|
from sapiopycommons.general.exceptions import SapioException
|
|
33
28
|
|
|
34
|
-
# Aliases for longer name.
|
|
35
|
-
_PropertyGetter = AbstractRecordModelPropertyGetter
|
|
36
|
-
_PropertyAdder = AbstractRecordModelPropertyAdder
|
|
37
|
-
_PropertyRemover = AbstractRecordModelPropertyRemover
|
|
38
|
-
_PropertySetter = AbstractRecordModelPropertySetter
|
|
39
|
-
_PropertyType = RecordModelPropertyType
|
|
40
29
|
|
|
41
30
|
# FR-46064 - Initial port of PyWebhookUtils to sapiopycommons.
|
|
42
|
-
# FR-47575 - Reordered functions so that the Java and Python versions are as close to each other as possible.
|
|
43
31
|
class RecordHandler:
|
|
44
32
|
"""
|
|
45
33
|
A collection of shorthand methods for dealing with the various record managers.
|
|
@@ -70,11 +58,12 @@ class RecordHandler:
|
|
|
70
58
|
"""
|
|
71
59
|
:param context: The current webhook context or a user object to send requests from.
|
|
72
60
|
"""
|
|
61
|
+
self.user = AliasUtil.to_sapio_user(context)
|
|
73
62
|
if self.__initialized:
|
|
74
63
|
return
|
|
75
64
|
self.__initialized = True
|
|
76
65
|
|
|
77
|
-
self.user =
|
|
66
|
+
self.user = context if isinstance(context, SapioUser) else context.user
|
|
78
67
|
self.dr_man = DataRecordManager(self.user)
|
|
79
68
|
self.rec_man = RecordModelManager(self.user)
|
|
80
69
|
self.inst_man = self.rec_man.instance_manager
|
|
@@ -114,172 +103,9 @@ class RecordHandler:
|
|
|
114
103
|
"""
|
|
115
104
|
return [self.wrap_model(x, wrapper_type) for x in records]
|
|
116
105
|
|
|
117
|
-
def add_model(self, wrapper_type: type[WrappedType] | str) -> WrappedType | PyRecordModel:
|
|
118
|
-
"""
|
|
119
|
-
Shorthand for using the instance manager to add a new record model of the given type.
|
|
120
|
-
|
|
121
|
-
:param wrapper_type: The record model wrapper to use, or the data type name of the record.
|
|
122
|
-
:return: The newly added record model. If a data type name was used instead of a model wrapper, then the
|
|
123
|
-
returned record will be a PyRecordModel instead of a WrappedRecordModel.
|
|
124
|
-
"""
|
|
125
|
-
return self.add_models(wrapper_type, 1)[0]
|
|
126
|
-
|
|
127
|
-
def add_models(self, wrapper_type: type[WrappedType] | str, num: int) -> list[WrappedType] | list[PyRecordModel]:
|
|
128
|
-
"""
|
|
129
|
-
Shorthand for using the instance manager to add new record models of the given type.
|
|
130
|
-
|
|
131
|
-
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
132
|
-
:param num: The number of models to create.
|
|
133
|
-
:return: The newly added record models. If a data type name was used instead of a model wrapper, then the
|
|
134
|
-
returned records will be PyRecordModels instead of WrappedRecordModels.
|
|
135
|
-
"""
|
|
136
|
-
if isinstance(wrapper_type, str):
|
|
137
|
-
return self.inst_man.add_new_records(wrapper_type, num)
|
|
138
|
-
return self.inst_man.add_new_records_of_type(num, wrapper_type)
|
|
139
|
-
|
|
140
|
-
def add_models_with_data(self, wrapper_type: type[WrappedType] | str, fields: list[FieldIdentifierMap]) \
|
|
141
|
-
-> list[WrappedType] | list[PyRecordModel]:
|
|
142
|
-
"""
|
|
143
|
-
Shorthand for using the instance manager to add new models of the given type, and then initializing all those
|
|
144
|
-
models with the given fields.
|
|
145
|
-
|
|
146
|
-
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
147
|
-
:param fields: A list of field maps to initialize the record models with.
|
|
148
|
-
:return: The newly added record models with the provided fields set. The records will be in the same order as
|
|
149
|
-
the fields in the fields list. If a data type name was used instead of a model wrapper, then the returned
|
|
150
|
-
records will be PyRecordModels instead of WrappedRecordModels.
|
|
151
|
-
"""
|
|
152
|
-
fields: list[FieldMap] = AliasUtil.to_data_field_names_list_dict(fields)
|
|
153
|
-
models: list[WrappedType] = self.add_models(wrapper_type, len(fields))
|
|
154
|
-
for model, field_list in zip(models, fields):
|
|
155
|
-
model.set_field_values(field_list)
|
|
156
|
-
return models
|
|
157
|
-
|
|
158
|
-
def find_or_add_model(self, wrapper_type: type[WrappedType] | str, primary_identifier: FieldIdentifier,
|
|
159
|
-
id_value: FieldValue, secondary_identifiers: FieldIdentifierMap | None = None) \
|
|
160
|
-
-> WrappedType | PyRecordModel:
|
|
161
|
-
"""
|
|
162
|
-
Find a unique record that matches the given field values. If no such records exist, add a record model to the
|
|
163
|
-
cache with the identifying fields set to the desired values. This record will be created in the system when
|
|
164
|
-
you store and commit changes. If more than one record with the identifying values exists, throws an exception.
|
|
165
|
-
|
|
166
|
-
The record is searched for using the primary identifier field name and value. If multiple records are returned
|
|
167
|
-
by the query on this primary identifier, then the secondary identifiers are used to filter the results.
|
|
168
|
-
|
|
169
|
-
Makes a webservice call to query for the existing record.
|
|
170
|
-
|
|
171
|
-
:param wrapper_type: The record model wrapper to use, or the data type name of the record.
|
|
172
|
-
:param primary_identifier: The data field name of the field to search on.
|
|
173
|
-
:param id_value: The value of the identifying field to search for.
|
|
174
|
-
:param secondary_identifiers: Optional fields used to filter the records that are returned after searching on
|
|
175
|
-
the primary identifier.
|
|
176
|
-
:return: The record model with the identifying field value, either pulled from the system or newly created.
|
|
177
|
-
If a data type name was used instead of a model wrapper, then the returned record will be a PyRecordModel
|
|
178
|
-
instead of a WrappedRecordModel.
|
|
179
|
-
"""
|
|
180
|
-
# PR-46335: Initialize the secondary identifiers parameter if None is provided to avoid an exception.
|
|
181
|
-
# If no secondary identifiers were provided, use an empty dictionary.
|
|
182
|
-
if secondary_identifiers is None:
|
|
183
|
-
secondary_identifiers = {}
|
|
184
|
-
|
|
185
|
-
primary_identifier: str = AliasUtil.to_data_field_name(primary_identifier)
|
|
186
|
-
secondary_identifiers: FieldMap = AliasUtil.to_data_field_names_dict(secondary_identifiers)
|
|
187
|
-
unique_record: WrappedType | None = self.__find_model(wrapper_type, primary_identifier, id_value,
|
|
188
|
-
secondary_identifiers)
|
|
189
|
-
# If a unique record matched the identifiers, return it.
|
|
190
|
-
if unique_record is not None:
|
|
191
|
-
return unique_record
|
|
192
|
-
|
|
193
|
-
# If none of the results matched the identifiers, create a new record with all identifiers set.
|
|
194
|
-
# Put the primary identifier and value into the secondary identifiers list and use that as the fields map
|
|
195
|
-
# for this new record.
|
|
196
|
-
secondary_identifiers.update({primary_identifier: id_value})
|
|
197
|
-
return self.add_models_with_data(wrapper_type, [secondary_identifiers])[0]
|
|
198
|
-
|
|
199
|
-
def create_models(self, wrapper_type: type[WrappedType] | str, num: int) -> list[WrappedType] | list[PyRecordModel]:
|
|
200
|
-
"""
|
|
201
|
-
Shorthand for creating new records via the data record manager and then returning them as wrapped
|
|
202
|
-
record models. Useful in cases where your record model needs to have a valid record ID.
|
|
203
|
-
|
|
204
|
-
Makes a webservice call to create the data records.
|
|
205
|
-
|
|
206
|
-
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
207
|
-
:param num: The number of new records to create.
|
|
208
|
-
:return: The newly created record models. If a data type name was used instead of a model wrapper, then the
|
|
209
|
-
returned records will be PyRecordModels instead of WrappedRecordModels.
|
|
210
|
-
"""
|
|
211
|
-
dt: str = AliasUtil.to_data_type_name(wrapper_type)
|
|
212
|
-
if isinstance(wrapper_type, str):
|
|
213
|
-
wrapper_type = None
|
|
214
|
-
return self.wrap_models(self.dr_man.add_data_records(dt, num), wrapper_type)
|
|
215
|
-
|
|
216
|
-
def create_models_with_data(self, wrapper_type: type[WrappedType] | str, fields: list[FieldIdentifierMap]) \
|
|
217
|
-
-> list[WrappedType] | list[PyRecordModel]:
|
|
218
|
-
"""
|
|
219
|
-
Shorthand for creating new records via the data record manager with field data to initialize the records with
|
|
220
|
-
and then returning them as wrapped record models. Useful in cases where your record model needs to have a valid
|
|
221
|
-
record ID.
|
|
222
|
-
|
|
223
|
-
Makes a webservice call to create the data records.
|
|
224
|
-
|
|
225
|
-
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
226
|
-
:param fields: The field map list to initialize the new data records with.
|
|
227
|
-
:return: The newly created record models. If a data type name was used instead of a model wrapper, then the
|
|
228
|
-
returned records will be PyRecordModels instead of WrappedRecordModels.
|
|
229
|
-
"""
|
|
230
|
-
dt: str = AliasUtil.to_data_type_name(wrapper_type)
|
|
231
|
-
if isinstance(wrapper_type, str):
|
|
232
|
-
wrapper_type = None
|
|
233
|
-
fields: list[FieldMap] = AliasUtil.to_data_field_names_list_dict(fields)
|
|
234
|
-
return self.wrap_models(self.dr_man.add_data_records_with_data(dt, fields), wrapper_type)
|
|
235
|
-
|
|
236
|
-
def find_or_create_model(self, wrapper_type: type[WrappedType] | str, primary_identifier: FieldIdentifier,
|
|
237
|
-
id_value: FieldValue, secondary_identifiers: FieldIdentifierMap | None = None) \
|
|
238
|
-
-> WrappedType | PyRecordModel:
|
|
239
|
-
"""
|
|
240
|
-
Find a unique record that matches the given field values. If no such records exist, create one with the
|
|
241
|
-
identifying fields set to the desired values. If more than one record with the identifying values exists,
|
|
242
|
-
throws an exception.
|
|
243
|
-
|
|
244
|
-
The record is searched for using the primary identifier field name and value. If multiple records are returned
|
|
245
|
-
by the query on this primary identifier, then the secondary identifiers are used to filter the results.
|
|
246
|
-
|
|
247
|
-
Makes a webservice call to query for the existing record. Makes an additional webservice call if the record
|
|
248
|
-
needs to be created.
|
|
249
|
-
|
|
250
|
-
:param wrapper_type: The record model wrapper to use, or the data type name of the record.
|
|
251
|
-
:param primary_identifier: The data field name of the field to search on.
|
|
252
|
-
:param id_value: The value of the identifying field to search for.
|
|
253
|
-
:param secondary_identifiers: Optional fields used to filter the records that are returned after searching on
|
|
254
|
-
the primary identifier.
|
|
255
|
-
:return: The record model with the identifying field value, either pulled from the system or newly created.
|
|
256
|
-
If a data type name was used instead of a model wrapper, then the returned record will be a PyRecordModel
|
|
257
|
-
instead of a WrappedRecordModel.
|
|
258
|
-
"""
|
|
259
|
-
# PR-46335: Initialize the secondary identifiers parameter if None is provided to avoid an exception.
|
|
260
|
-
# If no secondary identifiers were provided, use an empty dictionary.
|
|
261
|
-
if secondary_identifiers is None:
|
|
262
|
-
secondary_identifiers = {}
|
|
263
|
-
|
|
264
|
-
primary_identifier: str = AliasUtil.to_data_field_name(primary_identifier)
|
|
265
|
-
secondary_identifiers: FieldMap = AliasUtil.to_data_field_names_dict(secondary_identifiers)
|
|
266
|
-
unique_record: WrappedType | None = self.__find_model(wrapper_type, primary_identifier, id_value,
|
|
267
|
-
secondary_identifiers)
|
|
268
|
-
# If a unique record matched the identifiers, return it.
|
|
269
|
-
if unique_record is not None:
|
|
270
|
-
return unique_record
|
|
271
|
-
|
|
272
|
-
# If none of the results matched the identifiers, create a new record with all identifiers set.
|
|
273
|
-
# Put the primary identifier and value into the secondary identifiers list and use that as the fields map
|
|
274
|
-
# for this new record.
|
|
275
|
-
secondary_identifiers.update({primary_identifier: id_value})
|
|
276
|
-
return self.create_models_with_data(wrapper_type, [secondary_identifiers])[0]
|
|
277
|
-
|
|
278
106
|
# CR-47491: Support providing a data type name string to receive PyRecordModels instead of requiring a WrapperType.
|
|
279
|
-
# CR-47523: Support a singular field value being provided for the value_list parameter.
|
|
280
107
|
def query_models(self, wrapper_type: type[WrappedType] | str, field: FieldIdentifier,
|
|
281
|
-
value_list: Iterable[FieldValue] |
|
|
282
|
-
page_limit: int | None = None, page_size: int | None = None) \
|
|
108
|
+
value_list: Iterable[FieldValue], page_limit: int | None = None, page_size: int | None = None) \
|
|
283
109
|
-> list[WrappedType] | list[PyRecordModel]:
|
|
284
110
|
"""
|
|
285
111
|
Shorthand for using the data record manager to query for a list of data records by field value
|
|
@@ -287,9 +113,7 @@ class RecordHandler:
|
|
|
287
113
|
|
|
288
114
|
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
289
115
|
:param field: The field to query on.
|
|
290
|
-
:param value_list: The values of the field to query on
|
|
291
|
-
converted to a singleton list. Note that field values of None are not supported by this method and will be
|
|
292
|
-
ignored. If you need to query for records with a null field value, use a custom report.
|
|
116
|
+
:param value_list: The values of the field to query on.
|
|
293
117
|
:param page_limit: The maximum number of pages to query. If None, exhausts all possible pages. This parameter
|
|
294
118
|
only functions if you set a page size or the platform enforces a page size.
|
|
295
119
|
:param page_size: The size of the pages to query. If None, the page size may be limited by the platform.
|
|
@@ -302,10 +126,8 @@ class RecordHandler:
|
|
|
302
126
|
return self.query_models_with_criteria(wrapper_type, field, value_list, criteria, page_limit)[0]
|
|
303
127
|
|
|
304
128
|
def query_and_map_models(self, wrapper_type: type[WrappedType] | str, field: FieldIdentifier,
|
|
305
|
-
value_list: Iterable[FieldValue] |
|
|
306
|
-
|
|
307
|
-
*,
|
|
308
|
-
mapping_field: FieldIdentifier | None = None) \
|
|
129
|
+
value_list: Iterable[FieldValue], page_limit: int | None = None,
|
|
130
|
+
page_size: int | None = None, *, mapping_field: FieldIdentifier | None = None) \
|
|
309
131
|
-> dict[FieldValue, list[WrappedType] | list[PyRecordModel]]:
|
|
310
132
|
"""
|
|
311
133
|
Shorthand for using query_models to search for records given values on a specific field and then using
|
|
@@ -313,9 +135,7 @@ class RecordHandler:
|
|
|
313
135
|
|
|
314
136
|
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
315
137
|
:param field: The field to query and map on.
|
|
316
|
-
:param value_list: The values of the field to query on
|
|
317
|
-
converted to a singleton list. Note that field values of None are not supported by this method and will be
|
|
318
|
-
ignored. If you need to query for records with a null field value, use a custom report.
|
|
138
|
+
:param value_list: The values of the field to query on.
|
|
319
139
|
:param page_limit: The maximum number of pages to query. If None, exhausts all possible pages. This parameter
|
|
320
140
|
only functions if you set a page size or the platform enforces a page size.
|
|
321
141
|
:param page_size: The size of the pages to query. If None, the page size may be limited by the platform.
|
|
@@ -330,10 +150,8 @@ class RecordHandler:
|
|
|
330
150
|
mapping_field)
|
|
331
151
|
|
|
332
152
|
def query_and_unique_map_models(self, wrapper_type: type[WrappedType] | str, field: FieldIdentifier,
|
|
333
|
-
value_list: Iterable[FieldValue] |
|
|
334
|
-
|
|
335
|
-
*,
|
|
336
|
-
mapping_field: FieldIdentifier | None = None) \
|
|
153
|
+
value_list: Iterable[FieldValue], page_limit: int | None = None,
|
|
154
|
+
page_size: int | None = None, *, mapping_field: FieldIdentifier | None = None) \
|
|
337
155
|
-> dict[FieldValue, WrappedType | PyRecordModel]:
|
|
338
156
|
"""
|
|
339
157
|
Shorthand for using query_models to search for records given values on a specific field and then using
|
|
@@ -342,9 +160,7 @@ class RecordHandler:
|
|
|
342
160
|
|
|
343
161
|
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
344
162
|
:param field: The field to query and map on.
|
|
345
|
-
:param value_list: The values of the field to query on
|
|
346
|
-
converted to a singleton list. Note that field values of None are not supported by this method and will be
|
|
347
|
-
ignored. If you need to query for records with a null field value, use a custom report.
|
|
163
|
+
:param value_list: The values of the field to query on.
|
|
348
164
|
:param page_limit: The maximum number of pages to query. If None, exhausts all possible pages. This parameter
|
|
349
165
|
only functions if you set a page size or the platform enforces a page size.
|
|
350
166
|
:param page_size: The size of the pages to query. If None, the page size may be limited by the platform.
|
|
@@ -359,7 +175,7 @@ class RecordHandler:
|
|
|
359
175
|
mapping_field)
|
|
360
176
|
|
|
361
177
|
def query_models_with_criteria(self, wrapper_type: type[WrappedType] | str, field: FieldIdentifier,
|
|
362
|
-
value_list: Iterable[FieldValue]
|
|
178
|
+
value_list: Iterable[FieldValue],
|
|
363
179
|
paging_criteria: DataRecordPojoPageCriteria | None = None,
|
|
364
180
|
page_limit: int | None = None) \
|
|
365
181
|
-> tuple[list[WrappedType] | list[PyRecordModel], DataRecordPojoPageCriteria]:
|
|
@@ -369,9 +185,7 @@ class RecordHandler:
|
|
|
369
185
|
|
|
370
186
|
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
371
187
|
:param field: The field to query on.
|
|
372
|
-
:param value_list: The values of the field to query on
|
|
373
|
-
converted to a singleton list. Note that field values of None are not supported by this method and will be
|
|
374
|
-
ignored. If you need to query for records with a null field value, use a custom report.
|
|
188
|
+
:param value_list: The values of the field to query on.
|
|
375
189
|
:param paging_criteria: The paging criteria to start the query with.
|
|
376
190
|
:param page_limit: The maximum number of pages to query from the starting criteria. If None, exhausts all
|
|
377
191
|
possible pages. This parameter only functions if you set a page size in the paging criteria or the platform
|
|
@@ -383,8 +197,6 @@ class RecordHandler:
|
|
|
383
197
|
if isinstance(wrapper_type, str):
|
|
384
198
|
wrapper_type = None
|
|
385
199
|
field: str = AliasUtil.to_data_field_name(field)
|
|
386
|
-
if isinstance(value_list, FieldValue):
|
|
387
|
-
value_list: list[FieldValue] = [value_list]
|
|
388
200
|
pager = QueryDataRecordsAutoPager(dt, field, list(value_list), self.user, paging_criteria)
|
|
389
201
|
pager.max_page = page_limit
|
|
390
202
|
return self.wrap_models(pager.get_all_at_once(), wrapper_type), pager.next_page_criteria
|
|
@@ -545,415 +357,171 @@ class RecordHandler:
|
|
|
545
357
|
raise SapioException("Unrecognized report object.")
|
|
546
358
|
|
|
547
359
|
# Using the bracket accessor because we want to throw an exception if RecordId doesn't exist in the report.
|
|
548
|
-
# This should only possibly be the case with system reports, as quick reports will include the record ID
|
|
360
|
+
# This should only possibly be the case with system reports, as quick reports will include the record ID and
|
|
549
361
|
# we forced any given custom report to have a record ID column.
|
|
550
362
|
ids: list[int] = [row["RecordId"] for row in results]
|
|
551
363
|
return self.query_models_by_id(wrapper_type, ids)
|
|
552
364
|
|
|
553
|
-
|
|
554
|
-
def map_by_id(models: Iterable[SapioRecord]) -> dict[int, SapioRecord]:
|
|
555
|
-
"""
|
|
556
|
-
Map the given records their record IDs.
|
|
557
|
-
|
|
558
|
-
:param models: The records to map.
|
|
559
|
-
:return: A dict mapping the record ID to each record.
|
|
560
|
-
"""
|
|
561
|
-
ret_dict: dict[int, SapioRecord] = {}
|
|
562
|
-
for model in models:
|
|
563
|
-
ret_dict.update({model.record_id: model})
|
|
564
|
-
return ret_dict
|
|
565
|
-
|
|
566
|
-
@staticmethod
|
|
567
|
-
def map_by_field(models: Iterable[SapioRecord], field_name: FieldIdentifier) \
|
|
568
|
-
-> dict[FieldValue, list[SapioRecord]]:
|
|
569
|
-
"""
|
|
570
|
-
Map the given records by one of their fields. If any two records share the same field value, they'll appear in
|
|
571
|
-
the same value list.
|
|
572
|
-
|
|
573
|
-
:param models: The records to map.
|
|
574
|
-
:param field_name: The field name to map against.
|
|
575
|
-
:return: A dict mapping field values to the records with that value.
|
|
576
|
-
"""
|
|
577
|
-
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
578
|
-
ret_dict: dict[FieldValue, list[SapioRecord]] = {}
|
|
579
|
-
for model in models:
|
|
580
|
-
val: FieldValue = model.get_field_value(field_name)
|
|
581
|
-
ret_dict.setdefault(val, []).append(model)
|
|
582
|
-
return ret_dict
|
|
583
|
-
|
|
584
|
-
@staticmethod
|
|
585
|
-
def map_by_unique_field(models: Iterable[SapioRecord], field_name: FieldIdentifier) \
|
|
586
|
-
-> dict[FieldValue, SapioRecord]:
|
|
587
|
-
"""
|
|
588
|
-
Uniquely map the given records by one of their fields. If any two records share the same field value, throws
|
|
589
|
-
an exception.
|
|
590
|
-
|
|
591
|
-
:param models: The records to map.
|
|
592
|
-
:param field_name: The field name to map against.
|
|
593
|
-
:return: A dict mapping field values to the record with that value.
|
|
594
|
-
"""
|
|
595
|
-
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
596
|
-
ret_dict: dict[FieldValue, SapioRecord] = {}
|
|
597
|
-
for model in models:
|
|
598
|
-
val: FieldValue = model.get_field_value(field_name)
|
|
599
|
-
if val in ret_dict:
|
|
600
|
-
raise SapioException(f"Value {val} encountered more than once in models list.")
|
|
601
|
-
ret_dict.update({val: model})
|
|
602
|
-
return ret_dict
|
|
603
|
-
|
|
604
|
-
# FR-47525: Add functions for getting and setting record image bytes.
|
|
605
|
-
def get_record_image(self, record: SapioRecord) -> bytes:
|
|
606
|
-
"""
|
|
607
|
-
Retrieve the record image for a given record.
|
|
608
|
-
|
|
609
|
-
:param record: The record model to retrieve the image of.
|
|
610
|
-
:return: The file bytes of the given record's image.
|
|
611
|
-
"""
|
|
612
|
-
record: DataRecord = AliasUtil.to_data_record(record)
|
|
613
|
-
with io.BytesIO() as data_sink:
|
|
614
|
-
def consume_data(chunk: bytes):
|
|
615
|
-
data_sink.write(chunk)
|
|
616
|
-
|
|
617
|
-
self.dr_man.get_record_image(record, consume_data)
|
|
618
|
-
data_sink.flush()
|
|
619
|
-
data_sink.seek(0)
|
|
620
|
-
file_bytes = data_sink.read()
|
|
621
|
-
return file_bytes
|
|
622
|
-
|
|
623
|
-
def set_record_image(self, record: SapioRecord, file_data: str | bytes) -> None:
|
|
624
|
-
"""
|
|
625
|
-
Set the record image for a given record.
|
|
626
|
-
|
|
627
|
-
:param record: The record model to set the image of.
|
|
628
|
-
:param file_data: The file data of the image to set on the record.
|
|
629
|
-
"""
|
|
630
|
-
record: DataRecord = AliasUtil.to_data_record(record)
|
|
631
|
-
with io.BytesIO(file_data.encode() if isinstance(file_data, str) else file_data) as stream:
|
|
632
|
-
self.dr_man.set_record_image(record, stream)
|
|
633
|
-
|
|
634
|
-
@staticmethod
|
|
635
|
-
def sum_of_field(models: Iterable[SapioRecord], field_name: FieldIdentifier) -> float:
|
|
636
|
-
"""
|
|
637
|
-
Sum up the numeric value of a given field across all input models. Excepts that all given models have a value.
|
|
638
|
-
If the field is an integer field, the value will be converted to a float.
|
|
639
|
-
|
|
640
|
-
:param models: The models to calculate the sum of.
|
|
641
|
-
:param field_name: The name of the numeric field to sum.
|
|
642
|
-
:return: The sum of the field values for the collection of models.
|
|
643
|
-
"""
|
|
644
|
-
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
645
|
-
field_sum: float = 0
|
|
646
|
-
for model in models:
|
|
647
|
-
val = model.get_field_value(field_name)
|
|
648
|
-
if isinstance(val, (int, float)):
|
|
649
|
-
field_sum += float(model.get_field_value(field_name))
|
|
650
|
-
return field_sum
|
|
651
|
-
|
|
652
|
-
@staticmethod
|
|
653
|
-
def mean_of_field(models: Collection[SapioRecord], field_name: FieldIdentifier) -> float:
|
|
654
|
-
"""
|
|
655
|
-
Calculate the average (arithmetic mean) of the numeric value of a given field across all input models. Excepts
|
|
656
|
-
that all given models have a value. If the field is an integer field, the value will be converted to a float.
|
|
657
|
-
|
|
658
|
-
:param models: The models to calculate the mean of.
|
|
659
|
-
:param field_name: The name of the numeric field to mean.
|
|
660
|
-
:return: The mean of the field values for the collection of models.
|
|
661
|
-
"""
|
|
662
|
-
return RecordHandler.sum_of_field(models, field_name) / len(models)
|
|
663
|
-
|
|
664
|
-
@staticmethod
|
|
665
|
-
def get_newest_record(records: Iterable[SapioRecord]) -> SapioRecord:
|
|
666
|
-
"""
|
|
667
|
-
Get the newest record from a list of records.
|
|
668
|
-
|
|
669
|
-
:param records: The list of records.
|
|
670
|
-
:return: The input record with the highest record ID. None if the input list is empty.
|
|
671
|
-
"""
|
|
672
|
-
return max(records, key=lambda x: x.record_id)
|
|
673
|
-
|
|
674
|
-
# FR-46696: Add a function for getting the oldest record in a list, just like we have one for the newest record.
|
|
675
|
-
@staticmethod
|
|
676
|
-
def get_oldest_record(records: Iterable[SapioRecord]) -> SapioRecord:
|
|
677
|
-
"""
|
|
678
|
-
Get the oldest record from a list of records.
|
|
679
|
-
|
|
680
|
-
:param records: The list of records.
|
|
681
|
-
:return: The input record with the lowest record ID. None if the input list is empty.
|
|
682
|
-
"""
|
|
683
|
-
return min(records, key=lambda x: x.record_id)
|
|
684
|
-
|
|
685
|
-
@staticmethod
|
|
686
|
-
def get_min_record(records: list[RecordModel], field: FieldIdentifier) -> RecordModel:
|
|
365
|
+
def add_model(self, wrapper_type: type[WrappedType] | str) -> WrappedType | PyRecordModel:
|
|
687
366
|
"""
|
|
688
|
-
|
|
367
|
+
Shorthand for using the instance manager to add a new record model of the given type.
|
|
689
368
|
|
|
690
|
-
:param
|
|
691
|
-
:
|
|
692
|
-
|
|
369
|
+
:param wrapper_type: The record model wrapper to use, or the data type name of the record.
|
|
370
|
+
:return: The newly added record model. If a data type name was used instead of a model wrapper, then the
|
|
371
|
+
returned record will be a PyRecordModel instead of a WrappedRecordModel.
|
|
693
372
|
"""
|
|
694
|
-
|
|
695
|
-
return min(records, key=lambda x: x.get_field_value(field))
|
|
373
|
+
return self.add_models(wrapper_type, 1)[0]
|
|
696
374
|
|
|
697
|
-
|
|
698
|
-
def get_max_record(records: list[RecordModel], field: FieldIdentifier) -> RecordModel:
|
|
375
|
+
def add_models(self, wrapper_type: type[WrappedType] | str, num: int) -> list[WrappedType] | list[PyRecordModel]:
|
|
699
376
|
"""
|
|
700
|
-
|
|
377
|
+
Shorthand for using the instance manager to add new record models of the given type.
|
|
701
378
|
|
|
702
|
-
:param
|
|
703
|
-
:param
|
|
704
|
-
:return: The record
|
|
379
|
+
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
380
|
+
:param num: The number of models to create.
|
|
381
|
+
:return: The newly added record models. If a data type name was used instead of a model wrapper, then the
|
|
382
|
+
returned records will be PyRecordModels instead of WrappedRecordModels.
|
|
705
383
|
"""
|
|
706
|
-
|
|
707
|
-
|
|
384
|
+
if isinstance(wrapper_type, str):
|
|
385
|
+
return self.inst_man.add_new_records(wrapper_type, num)
|
|
386
|
+
return self.inst_man.add_new_records_of_type(num, wrapper_type)
|
|
708
387
|
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
def get_values_list(records: list[RecordModel], field: FieldIdentifier) -> list[FieldValue]:
|
|
388
|
+
def add_models_with_data(self, wrapper_type: type[WrappedType] | str, fields: list[FieldIdentifierMap]) \
|
|
389
|
+
-> list[WrappedType] | list[PyRecordModel]:
|
|
712
390
|
"""
|
|
713
|
-
|
|
391
|
+
Shorthand for using the instance manager to add new models of the given type, and then initializing all those
|
|
392
|
+
models with the given fields.
|
|
714
393
|
|
|
715
|
-
:param
|
|
716
|
-
:param
|
|
717
|
-
:return:
|
|
718
|
-
|
|
394
|
+
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
395
|
+
:param fields: A list of field maps to initialize the record models with.
|
|
396
|
+
:return: The newly added record models with the provided fields set. The records will be in the same order as
|
|
397
|
+
the fields in the fields list. If a data type name was used instead of a model wrapper, then the returned
|
|
398
|
+
records will be PyRecordModels instead of WrappedRecordModels.
|
|
719
399
|
"""
|
|
720
|
-
|
|
721
|
-
|
|
400
|
+
fields: list[FieldMap] = AliasUtil.to_data_field_names_list_dict(fields)
|
|
401
|
+
models: list[WrappedType] = self.add_models(wrapper_type, len(fields))
|
|
402
|
+
for model, field_list in zip(models, fields):
|
|
403
|
+
model.set_field_values(field_list)
|
|
404
|
+
return models
|
|
722
405
|
|
|
723
|
-
|
|
724
|
-
|
|
406
|
+
def find_or_add_model(self, wrapper_type: type[WrappedType] | str, primary_identifier: FieldIdentifier,
|
|
407
|
+
id_value: FieldValue, secondary_identifiers: FieldIdentifierMap | None = None) \
|
|
408
|
+
-> WrappedType | PyRecordModel:
|
|
725
409
|
"""
|
|
726
|
-
|
|
410
|
+
Find a unique record that matches the given field values. If no such records exist, add a record model to the
|
|
411
|
+
cache with the identifying fields set to the desired values. This record will be created in the system when
|
|
412
|
+
you store and commit changes. If more than one record with the identifying values exists, throws an exception.
|
|
727
413
|
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
:return: A set of field values from the input record models.
|
|
731
|
-
"""
|
|
732
|
-
field: str = AliasUtil.to_data_field_name(field)
|
|
733
|
-
return {x.get_field_value(field) for x in records}
|
|
414
|
+
The record is searched for using the primary identifier field name and value. If multiple records are returned
|
|
415
|
+
by the query on this primary identifier, then the secondary identifiers are used to filter the results.
|
|
734
416
|
|
|
735
|
-
|
|
736
|
-
def set_values(records: list[RecordModel], field: FieldIdentifier, value: FieldValue) -> None:
|
|
737
|
-
"""
|
|
738
|
-
Set the value of a field on a list of record models.
|
|
417
|
+
Makes a webservice call to query for the existing record.
|
|
739
418
|
|
|
740
|
-
:param
|
|
741
|
-
:param
|
|
742
|
-
:param
|
|
419
|
+
:param wrapper_type: The record model wrapper to use, or the data type name of the record.
|
|
420
|
+
:param primary_identifier: The data field name of the field to search on.
|
|
421
|
+
:param id_value: The value of the identifying field to search for.
|
|
422
|
+
:param secondary_identifiers: Optional fields used to filter the records that are returned after searching on
|
|
423
|
+
the primary identifier.
|
|
424
|
+
:return: The record model with the identifying field value, either pulled from the system or newly created.
|
|
425
|
+
If a data type name was used instead of a model wrapper, then the returned record will be a PyRecordModel
|
|
426
|
+
instead of a WrappedRecordModel.
|
|
743
427
|
"""
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
428
|
+
# PR-46335: Initialize the secondary identifiers parameter if None is provided to avoid an exception.
|
|
429
|
+
# If no secondary identifiers were provided, use an empty dictionary.
|
|
430
|
+
if secondary_identifiers is None:
|
|
431
|
+
secondary_identifiers = {}
|
|
747
432
|
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
433
|
+
primary_identifier: str = AliasUtil.to_data_field_name(primary_identifier)
|
|
434
|
+
secondary_identifiers: FieldMap = AliasUtil.to_data_field_names_dict(secondary_identifiers)
|
|
435
|
+
unique_record: WrappedType | None = self.__find_model(wrapper_type, primary_identifier, id_value,
|
|
436
|
+
secondary_identifiers)
|
|
437
|
+
# If a unique record matched the identifiers, return it.
|
|
438
|
+
if unique_record is not None:
|
|
439
|
+
return unique_record
|
|
753
440
|
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
"""
|
|
760
|
-
# Update the existing fields map list if one is given.
|
|
761
|
-
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
762
|
-
existing_fields: list[FieldMap] = AliasUtil.to_data_field_names_list_dict(existing_fields)
|
|
763
|
-
if existing_fields:
|
|
764
|
-
values = list(values)
|
|
765
|
-
# The number of new values must match the length of the existing fields list.
|
|
766
|
-
if len(values) != len(existing_fields):
|
|
767
|
-
raise SapioException(f"Length of \"{field_name}\" values does not match the existing fields length.")
|
|
768
|
-
for field, value in zip(existing_fields, values):
|
|
769
|
-
field.update({field_name: value})
|
|
770
|
-
return existing_fields
|
|
771
|
-
# Otherwise, create a new fields map list.
|
|
772
|
-
return [{field_name: value} for value in values]
|
|
441
|
+
# If none of the results matched the identifiers, create a new record with all identifiers set.
|
|
442
|
+
# Put the primary identifier and value into the secondary identifiers list and use that as the fields map
|
|
443
|
+
# for this new record.
|
|
444
|
+
secondary_identifiers.update({primary_identifier: id_value})
|
|
445
|
+
return self.add_models_with_data(wrapper_type, [secondary_identifiers])[0]
|
|
773
446
|
|
|
774
|
-
|
|
775
|
-
def get_from_all(records: Iterable[RecordModel], getter: _PropertyGetter[_PropertyType]) \
|
|
776
|
-
-> list[RecordModelPropertyType]:
|
|
447
|
+
def create_models(self, wrapper_type: type[WrappedType] | str, num: int) -> list[WrappedType] | list[PyRecordModel]:
|
|
777
448
|
"""
|
|
778
|
-
|
|
779
|
-
record models
|
|
780
|
-
record.
|
|
449
|
+
Shorthand for creating new records via the data record manager and then returning them as wrapped
|
|
450
|
+
record models. Useful in cases where your record model needs to have a valid record ID.
|
|
781
451
|
|
|
782
|
-
|
|
783
|
-
:param getter: The getter to use to get the property from each record.
|
|
784
|
-
:return: A list of the property values from the input record models. The value at the matching index of the
|
|
785
|
-
input records is the results of using the getter on that record.
|
|
786
|
-
"""
|
|
787
|
-
return [x.get(getter) for x in records]
|
|
452
|
+
Makes a webservice call to create the data records.
|
|
788
453
|
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
454
|
+
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
455
|
+
:param num: The number of new records to create.
|
|
456
|
+
:return: The newly created record models. If a data type name was used instead of a model wrapper, then the
|
|
457
|
+
returned records will be PyRecordModels instead of WrappedRecordModels.
|
|
792
458
|
"""
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
459
|
+
dt: str = AliasUtil.to_data_type_name(wrapper_type)
|
|
460
|
+
if isinstance(wrapper_type, str):
|
|
461
|
+
wrapper_type = None
|
|
462
|
+
return self.wrap_models(self.dr_man.add_data_records(dt, num), wrapper_type)
|
|
796
463
|
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
:return: A list of the property values that were set on the input record models. The value at the matching index
|
|
800
|
-
of the input records is the results of using the setter on that record.
|
|
464
|
+
def create_models_with_data(self, wrapper_type: type[WrappedType] | str, fields: list[FieldIdentifierMap]) \
|
|
465
|
+
-> list[WrappedType] | list[PyRecordModel]:
|
|
801
466
|
"""
|
|
802
|
-
|
|
467
|
+
Shorthand for creating new records via the data record manager with field data to initialize the records with
|
|
468
|
+
and then returning them as wrapped record models. Useful in cases where your record model needs to have a valid
|
|
469
|
+
record ID.
|
|
803
470
|
|
|
804
|
-
|
|
805
|
-
def add_to_all(records: Iterable[RecordModel], adder: _PropertyAdder[_PropertyType]) \
|
|
806
|
-
-> list[RecordModelPropertyType]:
|
|
807
|
-
"""
|
|
808
|
-
Use an adder property on all records in a list of record models. For example, you can iterate over a list of
|
|
809
|
-
record models using an adder of Child.create(SampleModel) to create a new SampleModel child on each record.
|
|
471
|
+
Makes a webservice call to create the data records.
|
|
810
472
|
|
|
811
|
-
:param
|
|
812
|
-
:param
|
|
813
|
-
:return:
|
|
814
|
-
|
|
473
|
+
:param wrapper_type: The record model wrapper to use, or the data type name of the records.
|
|
474
|
+
:param fields: The field map list to initialize the new data records with.
|
|
475
|
+
:return: The newly created record models. If a data type name was used instead of a model wrapper, then the
|
|
476
|
+
returned records will be PyRecordModels instead of WrappedRecordModels.
|
|
815
477
|
"""
|
|
816
|
-
|
|
478
|
+
dt: str = AliasUtil.to_data_type_name(wrapper_type)
|
|
479
|
+
if isinstance(wrapper_type, str):
|
|
480
|
+
wrapper_type = None
|
|
481
|
+
fields: list[FieldMap] = AliasUtil.to_data_field_names_list_dict(fields)
|
|
482
|
+
return self.wrap_models(self.dr_man.add_data_records_with_data(dt, fields), wrapper_type)
|
|
817
483
|
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
-> list[RecordModelPropertyType]:
|
|
821
|
-
"""
|
|
822
|
-
Use a remover property on all records in a list of record models. For example, you can iterate over a list of
|
|
823
|
-
record models using a remover of Parents.ref(records) to remove a list of parents from each record.
|
|
824
|
-
|
|
825
|
-
:param records: The list of record models to remove the property from.
|
|
826
|
-
:param remover: The remover to use to remove the property from each record.
|
|
827
|
-
:return: A list of the property values that were removed from the input record models. The value at the matching
|
|
828
|
-
index of the input records is the results of using the remover on that record.
|
|
829
|
-
"""
|
|
830
|
-
return [x.remove(remover) for x in records]
|
|
831
|
-
|
|
832
|
-
# FR-47527: Created functions for manipulating relationships between records,
|
|
833
|
-
def get_extension(self, model: RecordModel, wrapper_type: type[WrappedType] | str) \
|
|
834
|
-
-> WrappedType | PyRecordModel | None:
|
|
835
|
-
"""
|
|
836
|
-
Given a record with an extension record related to it, return the extension record as a record model.
|
|
837
|
-
This will retrieve an extension record without doing a webservice request to the server. The input record and
|
|
838
|
-
extension record will be considered related to one another if you later use load_child or load_parent on the
|
|
839
|
-
input record or extension record respectively.
|
|
840
|
-
|
|
841
|
-
:param model: The record model to get the extension for.
|
|
842
|
-
:param wrapper_type: The record model wrapper to use, or the data type name of the extension record. If a data
|
|
843
|
-
type name is provided, the returned record will be a PyRecordModel instead of a WrappedRecordModel.
|
|
844
|
-
:return: The extension record model for the input record model, or None if no extension record exists.
|
|
845
|
-
"""
|
|
846
|
-
ext_dt: str = AliasUtil.to_data_type_name(wrapper_type)
|
|
847
|
-
ext_fields: FieldMap = {}
|
|
848
|
-
for field, value in AliasUtil.to_field_map(model).items():
|
|
849
|
-
if field.startswith(ext_dt + "."):
|
|
850
|
-
ext_fields[field.removeprefix(ext_dt + ".")] = value
|
|
851
|
-
if not ext_fields or ext_fields.get("RecordId") is None:
|
|
852
|
-
return None
|
|
853
|
-
ext_rec: DataRecord = DataRecord(ext_dt, ext_fields.get("RecordId"), ext_fields)
|
|
854
|
-
ext_model: WrappedType | PyRecordModel = self.wrap_model(ext_rec, wrapper_type)
|
|
855
|
-
self._spoof_child_load(model, ext_model)
|
|
856
|
-
self._spoof_parent_load(ext_model, model)
|
|
857
|
-
return ext_model
|
|
858
|
-
|
|
859
|
-
def get_or_add_parent(self, record: RecordModel, parent_type: type[WrappedType] | str) \
|
|
484
|
+
def find_or_create_model(self, wrapper_type: type[WrappedType] | str, primary_identifier: FieldIdentifier,
|
|
485
|
+
id_value: FieldValue, secondary_identifiers: FieldIdentifierMap | None = None) \
|
|
860
486
|
-> WrappedType | PyRecordModel:
|
|
861
487
|
"""
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
:return: The parent record model of the given type.
|
|
869
|
-
"""
|
|
870
|
-
parent_dt: str = AliasUtil.to_data_type_name(parent_type)
|
|
871
|
-
wrapper: type[WrappedType] | None = parent_type if isinstance(parent_type, type) else None
|
|
872
|
-
record: PyRecordModel = RecordModelInstanceManager.unwrap(record)
|
|
873
|
-
parent: PyRecordModel | None = record.get_parent_of_type(parent_dt)
|
|
874
|
-
if parent is not None:
|
|
875
|
-
return self.wrap_model(parent, wrapper) if wrapper else parent
|
|
876
|
-
return record.add(Parent.create(wrapper)) if wrapper else record.add(Parent.create_by_name(parent_dt))
|
|
877
|
-
|
|
878
|
-
def get_or_add_child(self, record: RecordModel, child_type: type[WrappedType] | str) -> WrappedType | PyRecordModel:
|
|
879
|
-
"""
|
|
880
|
-
Given a record model, retrieve the singular child record model of a given type. If a child of the given type
|
|
881
|
-
does not exist, a new one will be created. The children of the given data type must already be loaded.
|
|
882
|
-
|
|
883
|
-
:param record: The record model to get the child of.
|
|
884
|
-
:param child_type: The record model wrapper of the child, or the data type name of the child. If a data type
|
|
885
|
-
name is provided, the returned record will be a PyRecordModel instead of a WrappedRecordModel.
|
|
886
|
-
:return: The child record model of the given type.
|
|
887
|
-
"""
|
|
888
|
-
child_dt: str = AliasUtil.to_data_type_name(child_type)
|
|
889
|
-
wrapper: type[WrappedType] | None = child_type if isinstance(child_type, type) else None
|
|
890
|
-
record: PyRecordModel = RecordModelInstanceManager.unwrap(record)
|
|
891
|
-
child: PyRecordModel | None = record.get_child_of_type(child_dt)
|
|
892
|
-
if child is not None:
|
|
893
|
-
return self.wrap_model(child, wrapper) if wrapper else child
|
|
894
|
-
return record.add(Child.create(wrapper)) if wrapper else record.add(Child.create_by_name(child_dt))
|
|
895
|
-
|
|
896
|
-
def get_or_add_side_link(self, record: RecordModel, side_link_field: FieldIdentifier,
|
|
897
|
-
side_link_type: type[WrappedType] | str) -> WrappedType | PyRecordModel:
|
|
898
|
-
"""
|
|
899
|
-
Given a record model, retrieve the singular side link record model of a given type. If a side link of the given
|
|
900
|
-
type does not exist, a new one will be created. The side links of the given data type must already be loaded.
|
|
901
|
-
|
|
902
|
-
:param record: The record model to get the side link of.
|
|
903
|
-
:param side_link_field: The field name of the side link to get.
|
|
904
|
-
:param side_link_type: The record model wrapper of the side link, or the data type name of the side link. If a
|
|
905
|
-
data type name is provided, the returned record will be a PyRecordModel instead of a WrappedRecordModel.
|
|
906
|
-
:return: The side link record model of the given type.
|
|
907
|
-
"""
|
|
908
|
-
side_link_field: str = AliasUtil.to_data_field_name(side_link_field)
|
|
909
|
-
wrapper: type[WrappedType] | None = side_link_type if isinstance(side_link_type, type) else None
|
|
910
|
-
record: PyRecordModel = RecordModelInstanceManager.unwrap(record)
|
|
911
|
-
side_link: PyRecordModel | None = record.get_forward_side_link(side_link_field)
|
|
912
|
-
if side_link is not None:
|
|
913
|
-
return self.wrap_model(side_link, wrapper) if wrapper else side_link
|
|
914
|
-
side_link: WrappedType | PyRecordModel = self.add_model(side_link_type)
|
|
915
|
-
record.set(ForwardSideLink.ref(side_link_field, side_link))
|
|
916
|
-
return side_link
|
|
488
|
+
Find a unique record that matches the given field values. If no such records exist, create one with the
|
|
489
|
+
identifying fields set to the desired values. If more than one record with the identifying values exists,
|
|
490
|
+
throws an exception.
|
|
491
|
+
|
|
492
|
+
The record is searched for using the primary identifier field name and value. If multiple records are returned
|
|
493
|
+
by the query on this primary identifier, then the secondary identifiers are used to filter the results.
|
|
917
494
|
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
"""
|
|
921
|
-
Set the parents of a record model to a list of parent record models of a given type. The parents of the given
|
|
922
|
-
data type must already be loaded. This method will add the parents to the record model if they are not already
|
|
923
|
-
parents, and remove any existing parents that are not in the input list.
|
|
495
|
+
Makes a webservice call to query for the existing record. Makes an additional webservice call if the record
|
|
496
|
+
needs to be created.
|
|
924
497
|
|
|
925
|
-
:param
|
|
926
|
-
:param
|
|
927
|
-
:param
|
|
498
|
+
:param wrapper_type: The record model wrapper to use, or the data type name of the record.
|
|
499
|
+
:param primary_identifier: The data field name of the field to search on.
|
|
500
|
+
:param id_value: The value of the identifying field to search for.
|
|
501
|
+
:param secondary_identifiers: Optional fields used to filter the records that are returned after searching on
|
|
502
|
+
the primary identifier.
|
|
503
|
+
:return: The record model with the identifying field value, either pulled from the system or newly created.
|
|
504
|
+
If a data type name was used instead of a model wrapper, then the returned record will be a PyRecordModel
|
|
505
|
+
instead of a WrappedRecordModel.
|
|
928
506
|
"""
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
record.add(Parent.ref(parent))
|
|
934
|
-
for parent in existing_parents:
|
|
935
|
-
if parent not in parents:
|
|
936
|
-
record.remove(Parent.ref(parent))
|
|
507
|
+
# PR-46335: Initialize the secondary identifiers parameter if None is provided to avoid an exception.
|
|
508
|
+
# If no secondary identifiers were provided, use an empty dictionary.
|
|
509
|
+
if secondary_identifiers is None:
|
|
510
|
+
secondary_identifiers = {}
|
|
937
511
|
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
512
|
+
primary_identifier: str = AliasUtil.to_data_field_name(primary_identifier)
|
|
513
|
+
secondary_identifiers: FieldMap = AliasUtil.to_data_field_names_dict(secondary_identifiers)
|
|
514
|
+
unique_record: WrappedType | None = self.__find_model(wrapper_type, primary_identifier, id_value,
|
|
515
|
+
secondary_identifiers)
|
|
516
|
+
# If a unique record matched the identifiers, return it.
|
|
517
|
+
if unique_record is not None:
|
|
518
|
+
return unique_record
|
|
944
519
|
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
existing_children: list[PyRecordModel] = record.get(Children.of_type_name(child_dt))
|
|
951
|
-
for child in children:
|
|
952
|
-
if child not in existing_children:
|
|
953
|
-
record.add(Child.ref(child))
|
|
954
|
-
for child in existing_children:
|
|
955
|
-
if child not in children:
|
|
956
|
-
record.remove(Child.ref(child))
|
|
520
|
+
# If none of the results matched the identifiers, create a new record with all identifiers set.
|
|
521
|
+
# Put the primary identifier and value into the secondary identifiers list and use that as the fields map
|
|
522
|
+
# for this new record.
|
|
523
|
+
secondary_identifiers.update({primary_identifier: id_value})
|
|
524
|
+
return self.create_models_with_data(wrapper_type, [secondary_identifiers])[0]
|
|
957
525
|
|
|
958
526
|
@staticmethod
|
|
959
527
|
def map_to_parent(models: Iterable[WrappedRecordModel], parent_type: type[WrappedType])\
|
|
@@ -1122,56 +690,76 @@ class RecordHandler:
|
|
|
1122
690
|
return return_dict
|
|
1123
691
|
|
|
1124
692
|
@staticmethod
|
|
1125
|
-
def
|
|
1126
|
-
|
|
693
|
+
def map_by_forward_side_links(models: Iterable[WrappedRecordModel], field_name: FieldIdentifier,
|
|
694
|
+
side_link_type: type[WrappedType]) -> dict[WrappedType, list[WrappedRecordModel]]:
|
|
1127
695
|
"""
|
|
1128
696
|
Take a list of record models and map them by their forward side link. Essentially an inversion of
|
|
1129
|
-
map_to_forward_side_link
|
|
697
|
+
map_to_forward_side_link. Input models that share a forward side link will end up in the same list.
|
|
1130
698
|
The forward side link must already be loaded.
|
|
1131
699
|
|
|
1132
700
|
:param models: A list of record models.
|
|
1133
701
|
:param field_name: The field name on the record models where the side link is located.
|
|
1134
702
|
:param side_link_type: The record model wrapper of the forward side links.
|
|
1135
|
-
:return: A dict[SideLink, ModelType]. If an input model doesn't have a forward side link of the given type
|
|
703
|
+
:return: A dict[SideLink, list[ModelType]]. If an input model doesn't have a forward side link of the given type
|
|
1136
704
|
pointing to it, then it will not be in the resulting dictionary.
|
|
1137
705
|
"""
|
|
1138
706
|
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
1139
707
|
to_side_link: dict[WrappedRecordModel, WrappedType] = RecordHandler\
|
|
1140
708
|
.map_to_forward_side_link(models, field_name, side_link_type)
|
|
1141
|
-
by_side_link: dict[WrappedType, WrappedRecordModel] = {}
|
|
709
|
+
by_side_link: dict[WrappedType, list[WrappedRecordModel]] = {}
|
|
1142
710
|
for record, side_link in to_side_link.items():
|
|
1143
711
|
if side_link is None:
|
|
1144
712
|
continue
|
|
1145
|
-
|
|
1146
|
-
raise SapioException(f"Side link {side_link.data_type_name} {side_link.record_id} encountered more "
|
|
1147
|
-
f"than once in models list.")
|
|
1148
|
-
by_side_link[side_link] = record
|
|
713
|
+
by_side_link.setdefault(side_link, []).append(record)
|
|
1149
714
|
return by_side_link
|
|
1150
715
|
|
|
1151
716
|
@staticmethod
|
|
1152
|
-
def
|
|
1153
|
-
|
|
717
|
+
def map_by_forward_side_link(models: Iterable[WrappedRecordModel], field_name: FieldIdentifier,
|
|
718
|
+
side_link_type: type[WrappedType]) -> dict[WrappedType, WrappedRecordModel]:
|
|
1154
719
|
"""
|
|
1155
720
|
Take a list of record models and map them by their forward side link. Essentially an inversion of
|
|
1156
|
-
map_to_forward_side_link
|
|
721
|
+
map_to_forward_side_link, but if two records share the same forward link, an exception is thrown.
|
|
1157
722
|
The forward side link must already be loaded.
|
|
1158
723
|
|
|
1159
724
|
:param models: A list of record models.
|
|
1160
725
|
:param field_name: The field name on the record models where the side link is located.
|
|
1161
726
|
:param side_link_type: The record model wrapper of the forward side links.
|
|
1162
|
-
:return: A dict[SideLink,
|
|
727
|
+
:return: A dict[SideLink, ModelType]. If an input model doesn't have a forward side link of the given type
|
|
1163
728
|
pointing to it, then it will not be in the resulting dictionary.
|
|
1164
729
|
"""
|
|
1165
730
|
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
1166
731
|
to_side_link: dict[WrappedRecordModel, WrappedType] = RecordHandler\
|
|
1167
732
|
.map_to_forward_side_link(models, field_name, side_link_type)
|
|
1168
|
-
by_side_link: dict[WrappedType,
|
|
733
|
+
by_side_link: dict[WrappedType, WrappedRecordModel] = {}
|
|
1169
734
|
for record, side_link in to_side_link.items():
|
|
1170
735
|
if side_link is None:
|
|
1171
736
|
continue
|
|
1172
|
-
|
|
737
|
+
if side_link in by_side_link:
|
|
738
|
+
raise SapioException(f"Side link {side_link.data_type_name} {side_link.record_id} encountered more "
|
|
739
|
+
f"than once in models list.")
|
|
740
|
+
by_side_link[side_link] = record
|
|
1173
741
|
return by_side_link
|
|
1174
742
|
|
|
743
|
+
@staticmethod
|
|
744
|
+
def map_to_reverse_side_links(models: Iterable[WrappedRecordModel], field_name: FieldIdentifier,
|
|
745
|
+
side_link_type: type[WrappedType]) -> dict[WrappedRecordModel, list[WrappedType]]:
|
|
746
|
+
"""
|
|
747
|
+
Map a list of record models to a list reverse side links of a given type. The reverse side links must already
|
|
748
|
+
be loaded.
|
|
749
|
+
|
|
750
|
+
:param models: A list of record models.
|
|
751
|
+
:param field_name: The field name on the side linked model where the side link to the given record models is
|
|
752
|
+
located.
|
|
753
|
+
:param side_link_type: The record model wrapper of the reverse side links.
|
|
754
|
+
:return: A dict[ModelType, list[SideLink]]. If an input model doesn't have reverse side links of the given type,
|
|
755
|
+
then it will map to an empty list.
|
|
756
|
+
"""
|
|
757
|
+
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
758
|
+
return_dict: dict[WrappedRecordModel, list[WrappedType]] = {}
|
|
759
|
+
for model in models:
|
|
760
|
+
return_dict[model] = model.get_reverse_side_link(field_name, side_link_type)
|
|
761
|
+
return return_dict
|
|
762
|
+
|
|
1175
763
|
@staticmethod
|
|
1176
764
|
def map_to_reverse_side_link(models: Iterable[WrappedRecordModel], field_name: FieldIdentifier,
|
|
1177
765
|
side_link_type: type[WrappedType]) -> dict[WrappedRecordModel, WrappedType]:
|
|
@@ -1197,24 +785,28 @@ class RecordHandler:
|
|
|
1197
785
|
return return_dict
|
|
1198
786
|
|
|
1199
787
|
@staticmethod
|
|
1200
|
-
def
|
|
1201
|
-
side_link_type: type[WrappedType]) -> dict[
|
|
788
|
+
def map_by_reverse_side_links(models: Iterable[WrappedRecordModel], field_name: FieldIdentifier,
|
|
789
|
+
side_link_type: type[WrappedType]) -> dict[WrappedType, list[WrappedRecordModel]]:
|
|
1202
790
|
"""
|
|
1203
|
-
|
|
1204
|
-
|
|
791
|
+
Take a list of record models and map them by their reverse side links. Essentially an inversion of
|
|
792
|
+
map_to_reverse_side_links. Input models that share a reverse side link will end up in the same list.
|
|
793
|
+
The reverse side links must already be loaded.
|
|
1205
794
|
|
|
1206
795
|
:param models: A list of record models.
|
|
1207
796
|
:param field_name: The field name on the side linked model where the side link to the given record models is
|
|
1208
797
|
located.
|
|
1209
798
|
:param side_link_type: The record model wrapper of the reverse side links.
|
|
1210
|
-
:return: A dict[
|
|
1211
|
-
then it will
|
|
799
|
+
:return: A dict[SideLink, list[ModelType]]. If an input model doesn't have reverse side links of the given type
|
|
800
|
+
pointing to it, then it will not be in the resulting dictionary.
|
|
1212
801
|
"""
|
|
1213
802
|
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
803
|
+
to_side_links: dict[WrappedRecordModel, list[WrappedType]] = RecordHandler\
|
|
804
|
+
.map_to_reverse_side_links(models, field_name, side_link_type)
|
|
805
|
+
by_side_links: dict[WrappedType, list[WrappedRecordModel]] = {}
|
|
806
|
+
for record, side_links in to_side_links.items():
|
|
807
|
+
for side_link in side_links:
|
|
808
|
+
by_side_links.setdefault(side_link, []).append(record)
|
|
809
|
+
return by_side_links
|
|
1218
810
|
|
|
1219
811
|
@staticmethod
|
|
1220
812
|
def map_by_reverse_side_link(models: Iterable[WrappedRecordModel], field_name: FieldIdentifier,
|
|
@@ -1245,28 +837,138 @@ class RecordHandler:
|
|
|
1245
837
|
return by_side_link
|
|
1246
838
|
|
|
1247
839
|
@staticmethod
|
|
1248
|
-
def
|
|
1249
|
-
side_link_type: type[WrappedType]) -> dict[WrappedType, list[WrappedRecordModel]]:
|
|
840
|
+
def map_by_id(models: Iterable[SapioRecord]) -> dict[int, SapioRecord]:
|
|
1250
841
|
"""
|
|
1251
|
-
|
|
1252
|
-
map_to_reverse_side_links. Input models that share a reverse side link will end up in the same list.
|
|
1253
|
-
The reverse side links must already be loaded.
|
|
842
|
+
Map the given records their record IDs.
|
|
1254
843
|
|
|
1255
|
-
:param models:
|
|
1256
|
-
:
|
|
1257
|
-
|
|
1258
|
-
:
|
|
1259
|
-
|
|
1260
|
-
|
|
844
|
+
:param models: The records to map.
|
|
845
|
+
:return: A dict mapping the record ID to each record.
|
|
846
|
+
"""
|
|
847
|
+
ret_dict: dict[int, SapioRecord] = {}
|
|
848
|
+
for model in models:
|
|
849
|
+
ret_dict.update({model.record_id: model})
|
|
850
|
+
return ret_dict
|
|
851
|
+
|
|
852
|
+
@staticmethod
|
|
853
|
+
def map_by_field(models: Iterable[SapioRecord], field_name: FieldIdentifier) \
|
|
854
|
+
-> dict[FieldValue, list[SapioRecord]]:
|
|
855
|
+
"""
|
|
856
|
+
Map the given records by one of their fields. If any two records share the same field value, they'll appear in
|
|
857
|
+
the same value list.
|
|
858
|
+
|
|
859
|
+
:param models: The records to map.
|
|
860
|
+
:param field_name: The field name to map against.
|
|
861
|
+
:return: A dict mapping field values to the records with that value.
|
|
1261
862
|
"""
|
|
1262
863
|
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
864
|
+
ret_dict: dict[FieldValue, list[SapioRecord]] = {}
|
|
865
|
+
for model in models:
|
|
866
|
+
val: FieldValue = model.get_field_value(field_name)
|
|
867
|
+
ret_dict.setdefault(val, []).append(model)
|
|
868
|
+
return ret_dict
|
|
869
|
+
|
|
870
|
+
@staticmethod
|
|
871
|
+
def map_by_unique_field(models: Iterable[SapioRecord], field_name: FieldIdentifier) \
|
|
872
|
+
-> dict[FieldValue, SapioRecord]:
|
|
873
|
+
"""
|
|
874
|
+
Uniquely map the given records by one of their fields. If any two records share the same field value, throws
|
|
875
|
+
an exception.
|
|
876
|
+
|
|
877
|
+
:param models: The records to map.
|
|
878
|
+
:param field_name: The field name to map against.
|
|
879
|
+
:return: A dict mapping field values to the record with that value.
|
|
880
|
+
"""
|
|
881
|
+
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
882
|
+
ret_dict: dict[FieldValue, SapioRecord] = {}
|
|
883
|
+
for model in models:
|
|
884
|
+
val: FieldValue = model.get_field_value(field_name)
|
|
885
|
+
if val in ret_dict:
|
|
886
|
+
raise SapioException(f"Value {val} encountered more than once in models list.")
|
|
887
|
+
ret_dict.update({val: model})
|
|
888
|
+
return ret_dict
|
|
889
|
+
|
|
890
|
+
@staticmethod
|
|
891
|
+
def sum_of_field(models: Iterable[SapioRecord], field_name: FieldIdentifier) -> float:
|
|
892
|
+
"""
|
|
893
|
+
Sum up the numeric value of a given field across all input models. Excepts that all given models have a value.
|
|
894
|
+
If the field is an integer field, the value will be converted to a float.
|
|
895
|
+
|
|
896
|
+
:param models: The models to calculate the sum of.
|
|
897
|
+
:param field_name: The name of the numeric field to sum.
|
|
898
|
+
:return: The sum of the field values for the collection of models.
|
|
899
|
+
"""
|
|
900
|
+
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
901
|
+
field_sum: float = 0
|
|
902
|
+
for model in models:
|
|
903
|
+
field_sum += float(model.get_field_value(field_name))
|
|
904
|
+
return field_sum
|
|
905
|
+
|
|
906
|
+
@staticmethod
|
|
907
|
+
def mean_of_field(models: Iterable[SapioRecord], field_name: FieldIdentifier) -> float:
|
|
908
|
+
"""
|
|
909
|
+
Calculate the mean of the numeric value of a given field across all input models. Excepts that all given models
|
|
910
|
+
have a value. If the field is an integer field, the value will be converted to a float.
|
|
911
|
+
|
|
912
|
+
:param models: The models to calculate the mean of.
|
|
913
|
+
:param field_name: The name of the numeric field to mean.
|
|
914
|
+
:return: The mean of the field values for the collection of models.
|
|
915
|
+
"""
|
|
916
|
+
return RecordHandler.sum_of_field(models, field_name) / len(list(models))
|
|
917
|
+
|
|
918
|
+
@staticmethod
|
|
919
|
+
def get_newest_record(records: Iterable[SapioRecord]) -> SapioRecord:
|
|
920
|
+
"""
|
|
921
|
+
Get the newest record from a list of records.
|
|
922
|
+
|
|
923
|
+
:param records: The list of records.
|
|
924
|
+
:return: The input record with the highest record ID. None if the input list is empty.
|
|
925
|
+
"""
|
|
926
|
+
newest: SapioRecord | None = None
|
|
927
|
+
for record in records:
|
|
928
|
+
if newest is None or record.record_id > newest.record_id:
|
|
929
|
+
newest = record
|
|
930
|
+
return newest
|
|
931
|
+
|
|
932
|
+
# FR-46696: Add a function for getting the oldest record in a list, just like we have one for the newest record.
|
|
933
|
+
@staticmethod
|
|
934
|
+
def get_oldest_record(records: Iterable[SapioRecord]) -> SapioRecord:
|
|
935
|
+
"""
|
|
936
|
+
Get the oldest record from a list of records.
|
|
937
|
+
|
|
938
|
+
:param records: The list of records.
|
|
939
|
+
:return: The input record with the lowest record ID. None if the input list is empty.
|
|
940
|
+
"""
|
|
941
|
+
oldest: SapioRecord | None = None
|
|
942
|
+
for record in records:
|
|
943
|
+
if oldest is None or record.record_id < oldest.record_id:
|
|
944
|
+
oldest = record
|
|
945
|
+
return oldest
|
|
946
|
+
|
|
947
|
+
@staticmethod
|
|
948
|
+
def values_to_field_maps(field_name: FieldIdentifier, values: Iterable[FieldValue],
|
|
949
|
+
existing_fields: list[FieldMap] | None = None) -> list[FieldMap]:
|
|
950
|
+
"""
|
|
951
|
+
Add a list of values for a specific field to a list of dictionaries pairing each value to that field name.
|
|
952
|
+
|
|
953
|
+
:param field_name: The name of the field that the values are from.
|
|
954
|
+
:param values: A list of field values.
|
|
955
|
+
:param existing_fields: An optional existing fields map list to add the new values to. Values are added in the
|
|
956
|
+
list in the same order that they appear. If no existing fields are provided, returns a new fields map list.
|
|
957
|
+
:return: A fields map list that contains the given values mapped by the given field name.
|
|
958
|
+
"""
|
|
959
|
+
# Update the existing fields map list if one is given.
|
|
960
|
+
field_name: str = AliasUtil.to_data_field_name(field_name)
|
|
961
|
+
existing_fields: list[FieldMap] = AliasUtil.to_data_field_names_list_dict(existing_fields)
|
|
962
|
+
if existing_fields:
|
|
963
|
+
values = list(values)
|
|
964
|
+
# The number of new values must match the length of the existing fields list.
|
|
965
|
+
if len(values) != len(existing_fields):
|
|
966
|
+
raise SapioException(f"Length of \"{field_name}\" values does not match the existing fields length.")
|
|
967
|
+
for field, value in zip(existing_fields, values):
|
|
968
|
+
field.update({field_name: value})
|
|
969
|
+
return existing_fields
|
|
970
|
+
# Otherwise, create a new fields map list.
|
|
971
|
+
return [{field_name: value} for value in values]
|
|
1270
972
|
|
|
1271
973
|
# FR-46155: Update relationship path traversing functions to be non-static and take in a wrapper type so that the
|
|
1272
974
|
# output can be wrapped instead of requiring the user to wrap the output.
|
|
@@ -1369,9 +1071,7 @@ class RecordHandler:
|
|
|
1369
1071
|
elif direction == RelationshipNodeType.DESCENDANT:
|
|
1370
1072
|
next_search.update(self.an_man.get_descendant_of_type(search, data_type))
|
|
1371
1073
|
elif direction == RelationshipNodeType.FORWARD_SIDE_LINK:
|
|
1372
|
-
|
|
1373
|
-
if side_link:
|
|
1374
|
-
next_search.add(side_link)
|
|
1074
|
+
next_search.add(search.get_forward_side_link(node.data_field_name))
|
|
1375
1075
|
elif direction == RelationshipNodeType.REVERSE_SIDE_LINK:
|
|
1376
1076
|
next_search.update(search.get_reverse_side_link(data_type, node.data_field_name))
|
|
1377
1077
|
else:
|
|
@@ -1421,8 +1121,7 @@ class RecordHandler:
|
|
|
1421
1121
|
elif direction == RelationshipNodeType.DESCENDANT:
|
|
1422
1122
|
current = list(self.an_man.get_descendant_of_type(current[0], data_type))
|
|
1423
1123
|
elif direction == RelationshipNodeType.FORWARD_SIDE_LINK:
|
|
1424
|
-
|
|
1425
|
-
current = [side_link] if side_link else []
|
|
1124
|
+
current = [current[0].get_forward_side_link(node.data_field_name)]
|
|
1426
1125
|
elif direction == RelationshipNodeType.REVERSE_SIDE_LINK:
|
|
1427
1126
|
current = current[0].get_reverse_side_link(data_type, node.data_field_name)
|
|
1428
1127
|
else:
|
|
@@ -1470,42 +1169,3 @@ class RecordHandler:
|
|
|
1470
1169
|
if record_type != model_type:
|
|
1471
1170
|
raise SapioException(f"Data record of type {record_type} cannot be wrapped by the record model wrapper "
|
|
1472
1171
|
f"of type {model_type}")
|
|
1473
|
-
|
|
1474
|
-
@staticmethod
|
|
1475
|
-
def _spoof_child_load(model: RecordModel, child: RecordModel) -> None:
|
|
1476
|
-
"""
|
|
1477
|
-
Spoof the loading of a child record on a record model. This is useful for when you have records that you know
|
|
1478
|
-
are related but didn't use the relationship manager to load the relationship, which would make a webservice
|
|
1479
|
-
call.
|
|
1480
|
-
"""
|
|
1481
|
-
RecordHandler._spoof_children_load(model, [child])
|
|
1482
|
-
|
|
1483
|
-
@staticmethod
|
|
1484
|
-
def _spoof_children_load(model: RecordModel, children: list[RecordModel]) -> None:
|
|
1485
|
-
"""
|
|
1486
|
-
Spoof the loading of child records on a record model. This is useful for when you have records that you know
|
|
1487
|
-
are related but didn't use the relationship manager to load the relationship, which would make a webservice
|
|
1488
|
-
"""
|
|
1489
|
-
model: PyRecordModel = RecordModelInstanceManager.unwrap(model)
|
|
1490
|
-
child_dt: str = AliasUtil.to_singular_data_type_name(children)
|
|
1491
|
-
# noinspection PyProtectedMember
|
|
1492
|
-
model._mark_children_loaded(child_dt, RecordModelInstanceManager.unwrap_list(children))
|
|
1493
|
-
|
|
1494
|
-
@staticmethod
|
|
1495
|
-
def _spoof_parent_load(model: RecordModel, parent: RecordModel) -> None:
|
|
1496
|
-
"""
|
|
1497
|
-
Spoof the loading of a parent record on a record model. This is useful for when you have records that you know
|
|
1498
|
-
are related but didn't use the relationship manager to load the relationship, which would make a webservice
|
|
1499
|
-
"""
|
|
1500
|
-
RecordHandler._spoof_parents_load(model, [parent])
|
|
1501
|
-
|
|
1502
|
-
@staticmethod
|
|
1503
|
-
def _spoof_parents_load(model: RecordModel, parents: list[RecordModel]) -> None:
|
|
1504
|
-
"""
|
|
1505
|
-
Spoof the loading of parent records on a record model. This is useful for when you have records that you know
|
|
1506
|
-
are related but didn't use the relationship manager to load the relationship, which would make a webservice
|
|
1507
|
-
"""
|
|
1508
|
-
model: PyRecordModel = RecordModelInstanceManager.unwrap(model)
|
|
1509
|
-
parent_dt: str = AliasUtil.to_singular_data_type_name(parents)
|
|
1510
|
-
# noinspection PyProtectedMember
|
|
1511
|
-
model._mark_children_loaded(parent_dt, RecordModelInstanceManager.unwrap_list(parents))
|