sapiopycommons 2024.8.27a310__py3-none-any.whl → 2024.8.28a313__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.

Files changed (37) hide show
  1. sapiopycommons/callbacks/callback_util.py +69 -407
  2. sapiopycommons/chem/IndigoMolecules.py +0 -1
  3. sapiopycommons/chem/Molecules.py +0 -1
  4. sapiopycommons/datatype/attachment_util.py +10 -11
  5. sapiopycommons/eln/experiment_handler.py +48 -209
  6. sapiopycommons/files/complex_data_loader.py +4 -5
  7. sapiopycommons/files/file_bridge.py +24 -31
  8. sapiopycommons/files/file_data_handler.py +5 -2
  9. sapiopycommons/files/file_util.py +10 -50
  10. sapiopycommons/files/file_validator.py +6 -92
  11. sapiopycommons/files/file_writer.py +15 -44
  12. sapiopycommons/general/aliases.py +3 -147
  13. sapiopycommons/general/custom_report_util.py +37 -211
  14. sapiopycommons/general/popup_util.py +0 -17
  15. sapiopycommons/general/time_util.py +0 -40
  16. sapiopycommons/processtracking/endpoints.py +22 -22
  17. sapiopycommons/recordmodel/record_handler.py +97 -481
  18. sapiopycommons/rules/eln_rule_handler.py +25 -34
  19. sapiopycommons/rules/on_save_rule_handler.py +31 -34
  20. sapiopycommons/webhook/webhook_handlers.py +26 -147
  21. {sapiopycommons-2024.8.27a310.dist-info → sapiopycommons-2024.8.28a313.dist-info}/METADATA +2 -4
  22. sapiopycommons-2024.8.28a313.dist-info/RECORD +38 -0
  23. sapiopycommons/customreport/__init__.py +0 -0
  24. sapiopycommons/customreport/column_builder.py +0 -60
  25. sapiopycommons/customreport/custom_report_builder.py +0 -125
  26. sapiopycommons/customreport/term_builder.py +0 -299
  27. sapiopycommons/eln/experiment_report_util.py +0 -118
  28. sapiopycommons/files/file_bridge_handler.py +0 -340
  29. sapiopycommons/general/accession_service.py +0 -375
  30. sapiopycommons/general/audit_log.py +0 -196
  31. sapiopycommons/general/sapio_links.py +0 -50
  32. sapiopycommons/multimodal/multimodal.py +0 -146
  33. sapiopycommons/multimodal/multimodal_data.py +0 -486
  34. sapiopycommons/webhook/webservice_handlers.py +0 -67
  35. sapiopycommons-2024.8.27a310.dist-info/RECORD +0 -50
  36. {sapiopycommons-2024.8.27a310.dist-info → sapiopycommons-2024.8.28a313.dist-info}/WHEEL +0 -0
  37. {sapiopycommons-2024.8.27a310.dist-info → sapiopycommons-2024.8.28a313.dist-info}/licenses/LICENSE +0 -0
@@ -1,125 +0,0 @@
1
- from sapiopylib.rest.pojo.CustomReport import ReportColumn, CustomReportCriteria, AbstractReportTerm, \
2
- ExplicitJoinDefinition, RelatedRecordCriteria, QueryRestriction, FieldCompareReportTerm
3
- from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
4
-
5
- from sapiopycommons.customreport.column_builder import ColumnBuilder
6
- from sapiopycommons.general.aliases import DataTypeIdentifier, FieldIdentifier, AliasUtil, SapioRecord
7
- from sapiopycommons.general.exceptions import SapioException
8
-
9
-
10
- class CustomReportBuilder:
11
- """
12
- A class used for building custom reports. Look into using the TermBuilder and ColumnBuilder classes for building
13
- parts of a custom report.
14
- """
15
- root_data_type: DataTypeIdentifier
16
- data_type_name: str
17
- root_term: AbstractReportTerm | None
18
- record_criteria: RelatedRecordCriteria
19
- column_list: list[ReportColumn]
20
- join_list: list[ExplicitJoinDefinition]
21
-
22
- def __init__(self, root_data_type: DataTypeIdentifier):
23
- """
24
- :param root_data_type: An object that can be used to identify a data type name. Used as the root data type name
25
- of this search.
26
- """
27
- self.root_data_type = root_data_type
28
- self.data_type_name = AliasUtil.to_data_type_name(root_data_type)
29
- self.root_term = None
30
- self.record_criteria = RelatedRecordCriteria(QueryRestriction.QUERY_ALL)
31
- self.column_list = []
32
- self.join_list = []
33
-
34
- def has_root_term(self) -> bool:
35
- """
36
- :return: Whether this report builder has had its root term set.
37
- """
38
- return self.root_term is not None
39
-
40
- def set_root_term(self, term: AbstractReportTerm) -> None:
41
- """
42
- Set the root term of the report. Use the TermBuilder class to construct the report terms.
43
-
44
- :param term: The term to set as the root term.
45
- """
46
- self.root_term = term
47
-
48
- def has_columns(self) -> bool:
49
- """
50
- :return: Whether this report builder has any report columns.
51
- """
52
- return bool(self.column_list)
53
-
54
- def add_column(self, field: FieldIdentifier, field_type: FieldType = None,
55
- *, data_type: DataTypeIdentifier | None = None) -> None:
56
- """
57
- Add a column to this report builder.
58
-
59
- :param field: An object that can be used to identify a data field.
60
- :param field_type: The field type of the provided field. This is only required if the field type cannot be
61
- determined from the given data type and field, which occurs when the given field is a string and the
62
- given data type is not a wrapped record model or record model wrapper.
63
- :param data_type: An object that can be used to identify a data type. If not provided, uses the root data type
64
- provided when this builder was initialized. You'll only want to specify this value when adding a column
65
- that is from a different data type than the root data type.
66
- """
67
- if data_type is None:
68
- data_type = self.root_data_type
69
- self.column_list.append(ColumnBuilder.build_column(data_type, field, field_type))
70
-
71
- def add_columns(self, fields: list[FieldIdentifier], *, data_type: DataTypeIdentifier | None = None) -> None:
72
- """
73
- Add columns to this report builder.
74
-
75
- :param fields: A list of objects that can be used to identify data fields.
76
- :param data_type: An object that can be used to identify a data type. If not provided, uses the root data type
77
- provided when this builder was initialized. You'll only want to specify this value when adding a column
78
- that is from a different data type than the root data type.
79
- """
80
- for field in fields:
81
- self.add_column(field, data_type=data_type)
82
-
83
- def set_query_restriction(self, base_record: SapioRecord, search_related: QueryRestriction) -> None:
84
- """
85
- Set a restriction on the report for this report builder such that the returned results must be related in
86
- some way to the provided base record. Without this, the report searches all records in the system that match the
87
- root term.
88
-
89
- :param base_record: The base record to run the search from.
90
- :param search_related: Determine the relationship of the related records that can appear in the search, be those
91
- children, parents, descendants, or ancestors.
92
- """
93
- if search_related == QueryRestriction.QUERY_ALL:
94
- raise SapioException("The search_related must be something other than QUERY_ALL when setting a query restriction.")
95
- self.record_criteria = RelatedRecordCriteria(search_related,
96
- AliasUtil.to_record_id(base_record),
97
- AliasUtil.to_data_type_name(base_record))
98
-
99
- def add_join(self, comparison_term: FieldCompareReportTerm) -> None:
100
- """
101
- Add a join statement to this report builder.
102
-
103
- :param comparison_term: The field comparison term to join with. The left side data type name of this term will
104
- be the data type that is joined against.
105
- """
106
- self.join_list.append(ExplicitJoinDefinition(comparison_term.left_data_type_name, comparison_term))
107
-
108
- def build_report_criteria(self, page_size: int = 0, page_number: int = -1, case_sensitive: bool = False,
109
- owner_restriction_set: list[str] = None) -> CustomReportCriteria:
110
- """
111
- Generate a CustomReportCriteria using the column list, root term, and root data type from this report builder.
112
- You can use the CustomReportManager or CustomReportUtil to run the constructed report.
113
-
114
- :param page_size: The page size of the custom report.
115
- :param page_number: The page number of the current report.
116
- :param case_sensitive: When searching texts, should the search be case-sensitive?
117
- :param owner_restriction_set: Specifies to only return records if the record is owned by this list of usernames.
118
- :return: A CustomReportCriteria from this report builder.
119
- """
120
- if not self.has_root_term():
121
- raise SapioException("Cannot build a report with no root term.")
122
- if not self.has_columns():
123
- raise SapioException("Cannot build a report with no columns.")
124
- return CustomReportCriteria(self.column_list, self.root_term, self.record_criteria, self.data_type_name,
125
- case_sensitive, page_size, page_number, owner_restriction_set, self.join_list)
@@ -1,299 +0,0 @@
1
- from typing import Iterable
2
-
3
- from sapiopylib.rest.pojo.CustomReport import RawTermOperation, CompositeTermOperation, RawReportTerm, \
4
- CompositeReportTerm, AbstractReportTerm, FieldCompareReportTerm
5
-
6
- from sapiopycommons.general.aliases import DataTypeIdentifier, AliasUtil, FieldIdentifier
7
-
8
- # Raw term operations, for comparing field values.
9
- EQ = RawTermOperation.EQUAL_TO_OPERATOR
10
- NEQ = RawTermOperation.NOT_EQUAL_TO_OPERATOR
11
- LT = RawTermOperation.LESS_THAN_OPERATOR
12
- LTE = RawTermOperation.LESS_THAN_OR_EQUAL_OPERATOR
13
- GT = RawTermOperation.GREATER_THAN_OPERATOR
14
- GTE = RawTermOperation.GREATER_THAN_OR_EQUAL_OPERATOR
15
-
16
- # Composite term operations, for comparing two terms.
17
- AND = CompositeTermOperation.AND_OPERATOR
18
- OR = CompositeTermOperation.OR_OPERATOR
19
-
20
- # Forms that field term values can take.
21
- TermValue = str | int | float | bool | Iterable | None
22
-
23
-
24
- class TermBuilder:
25
- """
26
- A class that allows for the easier constructions of custom report terms.
27
- """
28
- @staticmethod
29
- def all_records_term(data_type: DataTypeIdentifier) -> RawReportTerm:
30
- """
31
- Create a raw report term that captures all records of the given data type.
32
-
33
- :param data_type: The data type of this term.
34
- :return: A raw report term for "data_type.RecordId >= 0".
35
- """
36
- return RawReportTerm(AliasUtil.to_data_type_name(data_type), "RecordId", GTE, TermBuilder.to_term_val(0))
37
-
38
- @staticmethod
39
- def is_term(data_type: DataTypeIdentifier, field: FieldIdentifier, value: TermValue,
40
- *, trim: bool = False) -> RawReportTerm:
41
- """
42
- Create a raw report term for comparing a field value with an equals operation.
43
-
44
- :param data_type: The data type of this term.
45
- :param field: The data field of this term.
46
- :param value: The value to compare for this term.
47
- :param trim: Whether the string of the given value should be trimmed of trailing and leading whitespace.
48
- :return: A raw report term for "data_type.field = value".
49
- """
50
- return RawReportTerm(AliasUtil.to_data_type_name(data_type), AliasUtil.to_data_field_name(field), EQ,
51
- TermBuilder.to_term_val(value), trim)
52
-
53
- @staticmethod
54
- def not_term(data_type: DataTypeIdentifier, field: FieldIdentifier, value: TermValue,
55
- *, trim: bool = False) -> RawReportTerm:
56
- """
57
- Create a raw report term for comparing a field value with a not equals operation.
58
-
59
- :param data_type: The data type of this term.
60
- :param field: The data field of this term.
61
- :param value: The value to compare for this term.
62
- :param trim: Whether the string of the given value should be trimmed of trailing and leading whitespace.
63
- :return: A raw report term for "data_type.field != value".
64
- """
65
- return RawReportTerm(AliasUtil.to_data_type_name(data_type), AliasUtil.to_data_field_name(field), NEQ,
66
- TermBuilder.to_term_val(value), trim)
67
-
68
- @staticmethod
69
- def lt_term(data_type: DataTypeIdentifier, field: FieldIdentifier, value: TermValue,
70
- *, trim: bool = False) -> RawReportTerm:
71
- """
72
- Create a raw report term for comparing a field value with a less than operation.
73
-
74
- :param data_type: The data type of this term.
75
- :param field: The data field of this term.
76
- :param value: The value to compare for this term.
77
- :param trim: Whether the string of the given value should be trimmed of trailing and leading whitespace.
78
- :return: A raw report term for "data_type.field < value".
79
- """
80
- return RawReportTerm(AliasUtil.to_data_type_name(data_type), AliasUtil.to_data_field_name(field), LT,
81
- TermBuilder.to_term_val(value), trim)
82
-
83
- @staticmethod
84
- def lte_term(data_type: DataTypeIdentifier, field: FieldIdentifier, value: TermValue,
85
- *, trim: bool = False) -> RawReportTerm:
86
- """
87
- Create a raw report term for comparing a field value with a less than or equal to operation.
88
-
89
- :param data_type: The data type of this term.
90
- :param field: The data field of this term.
91
- :param value: The value to compare for this term.
92
- :param trim: Whether the string of the given value should be trimmed of trailing and leading whitespace.
93
- :return: A raw report term for "data_type.field <= value".
94
- """
95
- return RawReportTerm(AliasUtil.to_data_type_name(data_type), AliasUtil.to_data_field_name(field), LTE,
96
- TermBuilder.to_term_val(value), trim)
97
-
98
- @staticmethod
99
- def gt_term(data_type: DataTypeIdentifier, field: FieldIdentifier, value: TermValue,
100
- *, trim: bool = False) -> RawReportTerm:
101
- """
102
- Create a raw report term for comparing a field value with a greater than operation.
103
-
104
- :param data_type: The data type of this term.
105
- :param field: The data field of this term.
106
- :param value: The value to compare for this term.
107
- :param trim: Whether the string of the given value should be trimmed of trailing and leading whitespace.
108
- :return: A raw report term for "data_type.field > value".
109
- """
110
- return RawReportTerm(AliasUtil.to_data_type_name(data_type), AliasUtil.to_data_field_name(field), GT,
111
- TermBuilder.to_term_val(value), trim)
112
-
113
- @staticmethod
114
- def gte_term(data_type: DataTypeIdentifier, field: FieldIdentifier, value: TermValue,
115
- *, trim: bool = False) -> RawReportTerm:
116
- """
117
- Create a raw report term for comparing a field value with a greater than or equal to operation.
118
-
119
- :param data_type: The data type of this term.
120
- :param field: The data field of this term.
121
- :param value: The value to compare for this term.
122
- :param trim: Whether the string of the given value should be trimmed of trailing and leading whitespace.
123
- :return: A raw report term for "data_type.field >= value".
124
- """
125
- return RawReportTerm(AliasUtil.to_data_type_name(data_type), AliasUtil.to_data_field_name(field), GTE,
126
- TermBuilder.to_term_val(value), trim)
127
-
128
- @staticmethod
129
- def compare_is_term(data_type_A: DataTypeIdentifier, field_A: FieldIdentifier,
130
- data_type_B: DataTypeIdentifier, field_B: FieldIdentifier,
131
- *, trim: bool = False) -> FieldCompareReportTerm:
132
- """
133
- Create a field comparison report term for comparing field values between data types with an equals operation.
134
-
135
- :param data_type_A: The data type for the left side of this term.
136
- :param field_A: The data field for the left side of this term.
137
- :param data_type_B: The data type for the right side of this term.
138
- :param field_B: The data field for the right side of this term.
139
- :param trim: Whether the field values should be trimmed of trailing and leading whitespace for comparing.
140
- :return: A field comparison report term for "data_type_A.field_A = data_type_B.field_B".
141
- """
142
- return FieldCompareReportTerm(AliasUtil.to_data_type_name(data_type_A), AliasUtil.to_data_field_name(field_A), EQ,
143
- AliasUtil.to_data_type_name(data_type_B), AliasUtil.to_data_field_name(field_B), trim)
144
-
145
- @staticmethod
146
- def compare_not_term(data_type_A: DataTypeIdentifier, field_A: FieldIdentifier,
147
- data_type_B: DataTypeIdentifier, field_B: FieldIdentifier,
148
- *, trim: bool = False) -> FieldCompareReportTerm:
149
- """
150
- Create a field comparison report term for comparing field values between data types with a not equals operation.
151
-
152
- :param data_type_A: The data type for the left side of this term.
153
- :param field_A: The data field for the left side of this term.
154
- :param data_type_B: The data type for the right side of this term.
155
- :param field_B: The data field for the right side of this term.
156
- :param trim: Whether the field values should be trimmed of trailing and leading whitespace for comparing.
157
- :return: A field comparison report term for "data_type_A.field_A != data_type_B.field_B".
158
- """
159
- return FieldCompareReportTerm(AliasUtil.to_data_type_name(data_type_A), AliasUtil.to_data_field_name(field_A), NEQ,
160
- AliasUtil.to_data_type_name(data_type_B), AliasUtil.to_data_field_name(field_B), trim)
161
-
162
- @staticmethod
163
- def compare_lt_term(data_type_A: DataTypeIdentifier, field_A: FieldIdentifier,
164
- data_type_B: DataTypeIdentifier, field_B: FieldIdentifier,
165
- *, trim: bool = False) -> FieldCompareReportTerm:
166
- """
167
- Create a field comparison report term for comparing field values between data types with a less than operation.
168
-
169
- :param data_type_A: The data type for the left side of this term.
170
- :param field_A: The data field for the left side of this term.
171
- :param data_type_B: The data type for the right side of this term.
172
- :param field_B: The data field for the right side of this term.
173
- :param trim: Whether the field values should be trimmed of trailing and leading whitespace for comparing.
174
- :return: A field comparison report term for "data_type_A.field_A < data_type_B.field_B".
175
- """
176
- return FieldCompareReportTerm(AliasUtil.to_data_type_name(data_type_A), AliasUtil.to_data_field_name(field_A), LT,
177
- AliasUtil.to_data_type_name(data_type_B), AliasUtil.to_data_field_name(field_B), trim)
178
-
179
- @staticmethod
180
- def compare_lte_term(data_type_A: DataTypeIdentifier, field_A: FieldIdentifier,
181
- data_type_B: DataTypeIdentifier, field_B: FieldIdentifier,
182
- *, trim: bool = False) -> FieldCompareReportTerm:
183
- """
184
- Create a field comparison report term for comparing field values between data types with a less than or equal
185
- to operation.
186
-
187
- :param data_type_A: The data type for the left side of this term.
188
- :param field_A: The data field for the left side of this term.
189
- :param data_type_B: The data type for the right side of this term.
190
- :param field_B: The data field for the right side of this term.
191
- :param trim: Whether the field values should be trimmed of trailing and leading whitespace for comparing.
192
- :return: A field comparison report term for "data_type_A.field_A <= data_type_B.field_B".
193
- """
194
- return FieldCompareReportTerm(AliasUtil.to_data_type_name(data_type_A), AliasUtil.to_data_field_name(field_A), LTE,
195
- AliasUtil.to_data_type_name(data_type_B), AliasUtil.to_data_field_name(field_B), trim)
196
-
197
- @staticmethod
198
- def compare_gt_term(data_type_A: DataTypeIdentifier, field_A: FieldIdentifier,
199
- data_type_B: DataTypeIdentifier, field_B: FieldIdentifier,
200
- *, trim: bool = False) -> FieldCompareReportTerm:
201
- """
202
- Create a field comparison report term for comparing field values between data types with a greater than
203
- operation.
204
-
205
- :param data_type_A: The data type for the left side of this term.
206
- :param field_A: The data field for the left side of this term.
207
- :param data_type_B: The data type for the right side of this term.
208
- :param field_B: The data field for the right side of this term.
209
- :param trim: Whether the field values should be trimmed of trailing and leading whitespace for comparing.
210
- :return: A field comparison report term for "data_type_A.field_A > data_type_B.field_B".
211
- """
212
- return FieldCompareReportTerm(AliasUtil.to_data_type_name(data_type_A), AliasUtil.to_data_field_name(field_A), GT,
213
- AliasUtil.to_data_type_name(data_type_B), AliasUtil.to_data_field_name(field_B), trim)
214
-
215
- @staticmethod
216
- def compare_gte_term(data_type_A: DataTypeIdentifier, field_A: FieldIdentifier,
217
- data_type_B: DataTypeIdentifier, field_B: FieldIdentifier,
218
- *, trim: bool = False) -> FieldCompareReportTerm:
219
- """
220
- Create a field comparison report term for comparing field values between data types with a greater than or
221
- equal to operation.
222
-
223
- :param data_type_A: The data type for the left side of this term.
224
- :param field_A: The data field for the left side of this term.
225
- :param data_type_B: The data type for the right side of this term.
226
- :param field_B: The data field for the right side of this term.
227
- :param trim: Whether the field values should be trimmed of trailing and leading whitespace for comparing.
228
- :return: A field comparison report term for "data_type_A.field_A >= data_type_B.field_B".
229
- """
230
- return FieldCompareReportTerm(AliasUtil.to_data_type_name(data_type_A), AliasUtil.to_data_field_name(field_A), GTE,
231
- AliasUtil.to_data_type_name(data_type_B), AliasUtil.to_data_field_name(field_B), trim)
232
-
233
- @staticmethod
234
- def or_terms(a: AbstractReportTerm, b: AbstractReportTerm, *, is_negated: bool = False) -> CompositeReportTerm:
235
- """
236
- Combine two report terms with an OR operation.
237
-
238
- :param a: The first term in the operation.
239
- :param b: The second term in the operation.
240
- :param is_negated: Whether the returned term should be negated (i.e. turn this into a nor operation).
241
- :return: A composite report term for "A or B".
242
- """
243
- return CompositeReportTerm(a, OR, b, is_negated)
244
-
245
- @staticmethod
246
- def and_terms(a: AbstractReportTerm, b: AbstractReportTerm, *, is_negated: bool = False) -> CompositeReportTerm:
247
- """
248
- Combine two report terms with an AND operation.
249
-
250
- :param a: The first term in the operation.
251
- :param b: The second term in the operation.
252
- :param is_negated: Whether the returned term should be negated (i.e. turn this into a nand operation).
253
- :return: A composite report term for "A and B".
254
- """
255
- return CompositeReportTerm(a, AND, b, is_negated)
256
-
257
- @staticmethod
258
- def xor_terms(a: AbstractReportTerm, b: AbstractReportTerm, *, is_negated: bool = False) -> CompositeReportTerm:
259
- """
260
- Combine two report terms with a XOR operation. Note that a XOR operation doesn't actually exist for custom
261
- reports. This instead constructs a term that is "(A or B) and !(A and B)", which is equivalent to a XOR
262
- operation.
263
-
264
- :param a: The first term in the operation.
265
- :param b: The second term in the operation.
266
- :param is_negated: Whether the returned term should be negated (i.e. turn this into an xnor operation).
267
- :return: A composite report term for "A xor B".
268
- """
269
- return TermBuilder.and_terms(TermBuilder.or_terms(a, b),
270
- TermBuilder.and_terms(a, b, is_negated=True),
271
- is_negated=is_negated)
272
-
273
- @staticmethod
274
- def to_term_val(value: TermValue) -> str:
275
- """
276
- Convert the given value to be used in a custom report term to a string. Term values may be strings, integers,
277
- floats, booleans, or lists of values.
278
-
279
- :param value: A value to be used in a custom report term.
280
- :return: The provided value formatted as a string that can be used
281
- """
282
- # If the given value is already a string, then nothing needs to be done with it.
283
- if not isinstance(value, str):
284
- # If the given value is None, then use an empty string for the search instead.
285
- if value is None:
286
- value = ""
287
- # If the given value is an iterable object, then the return value is the contents of that iterable
288
- # in a comma separated list surrounded by curly braces.
289
- elif isinstance(value, Iterable):
290
- # When converting a list of values to a string, values in the list which are already strings should be
291
- # put in quotation marks so that strings that contain commas do not get split up. All other value
292
- # types can be simply converted to a string, though.
293
- def convert_list_value(val: TermValue) -> str:
294
- return f"'{val}'" if isinstance(val, str) else str(val)
295
- value = "{" + ",".join([convert_list_value(x) for x in value]) + "}"
296
- else:
297
- # Otherwise, the value is simply cast to a string.
298
- value = str(value)
299
- return value
@@ -1,118 +0,0 @@
1
- from sapiopylib.rest.User import SapioUser
2
- from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
3
- from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
4
-
5
- from sapiopycommons.customreport.custom_report_builder import CustomReportBuilder
6
- from sapiopycommons.customreport.term_builder import TermBuilder
7
- from sapiopycommons.general.aliases import SapioRecord, UserIdentifier, AliasUtil
8
- from sapiopycommons.general.custom_report_util import CustomReportUtil
9
- from sapiopycommons.recordmodel.record_handler import RecordHandler
10
-
11
- _NOTEBOOK_ID = "EXPERIMENTID"
12
- _RECORD_ID = "RECORDID"
13
-
14
-
15
- # FR-46908 - Provide a utility class that holds experiment related custom reports e.g. getting all the experiments
16
- # that given records were used in or getting all records of a datatype used in given experiments.
17
- class ExperimentReportUtil:
18
- @staticmethod
19
- def map_records_to_experiment_ids(context: UserIdentifier, records: list[SapioRecord]) \
20
- -> dict[SapioRecord, list[int]]:
21
- """
22
- Return a dictionary mapping each record to a list of ids of experiments that they were used in.
23
- If a record wasn't used in any experiments then it will be mapped to an empty list.
24
-
25
- :param context: The current webhook context or a user object to send requests from.
26
- :param records: a list of records of the same data type.
27
- :return: a dictionary mapping each record to a list of ids of each experiment it was used in.
28
- """
29
- if not records:
30
- return {}
31
-
32
- user: SapioUser = AliasUtil.to_sapio_user(context)
33
- data_type_name: str = AliasUtil.to_singular_data_type_name(records)
34
-
35
- record_ids = [record.record_id for record in records]
36
- rows = ExperimentReportUtil.__get_record_experiment_relation_rows(user, data_type_name, record_ids=record_ids)
37
-
38
- id_to_record: dict[int, SapioRecord] = RecordHandler.map_by_id(records)
39
- record_to_exps: dict[SapioRecord, set[int]] = {record: set() for record in records}
40
- for row in rows:
41
- record_id: int = row[_RECORD_ID]
42
- exp_id: int = row[_NOTEBOOK_ID]
43
- record = id_to_record[record_id]
44
- record_to_exps[record].add(exp_id)
45
-
46
- return {record: list(exps) for record, exps in record_to_exps.items()}
47
-
48
- @staticmethod
49
- def map_experiments_to_records_of_type(context: UserIdentifier, exp_ids: list[int],
50
- wrapper_type: type[WrappedType]) -> dict[int, list[WrappedType]]:
51
- """
52
- Return a dictionary mapping each experiment id to a list of records of the given type that were used in each experiment.
53
- If an experiment didn't use any records of the given type then it will be mapped to an empty list.
54
-
55
- :param context: The current webhook context or a user object to send requests from.
56
- :param exp_ids: a list of experiment ids. These are specifically the Notebook Experiment ids which can be found in the title of the experiment.
57
- :param wrapper_type: The record model wrapper to use, corresponds to which data type we will query for.
58
- :return: a dictionary mapping each experiment id to a list of records of the given type that were used in that experiment.
59
- """
60
- if not exp_ids:
61
- return {}
62
-
63
- user = AliasUtil.to_sapio_user(context)
64
- record_handler = RecordHandler(user)
65
- data_type_name: str = wrapper_type.get_wrapper_data_type_name()
66
-
67
- rows = ExperimentReportUtil.__get_record_experiment_relation_rows(user, data_type_name, exp_ids=exp_ids)
68
- record_ids: set[int] = {row[_RECORD_ID] for row in rows}
69
- records = record_handler.query_models_by_id(wrapper_type, record_ids)
70
-
71
- id_to_record: dict[int, WrappedType] = RecordHandler.map_by_id(records)
72
- exp_to_records: dict[int, set[SapioRecord]] = {exp: set() for exp in exp_ids}
73
- for row in rows:
74
- record_id: int = row[_RECORD_ID]
75
- exp_id: int = row[_NOTEBOOK_ID]
76
- record = id_to_record[record_id]
77
- exp_to_records[exp_id].add(record)
78
-
79
- return {exp: list(records) for exp, records in exp_to_records.items()}
80
-
81
- @staticmethod
82
- def __get_record_experiment_relation_rows(user: SapioUser, data_type_name: str, record_ids: list[int] | None = None,
83
- exp_ids: list[int] | None = None) -> list[dict[str, int]]:
84
- """
85
- Return a list of dicts mapping \"RECORDID\" to the record id and \"EXPERIMENTID\" to the experiment id.
86
- At least one of record_ids and exp_ids should be provided.
87
- """
88
- assert (record_ids or exp_ids)
89
-
90
- if record_ids:
91
- records_term = TermBuilder.is_term(data_type_name, "RECORDID", record_ids)
92
- else:
93
- # Get all records of the given type
94
- records_term = TermBuilder.all_records_term(data_type_name)
95
-
96
- if exp_ids:
97
- exp_term = TermBuilder.is_term("NOTEBOOKEXPERIMENT", "EXPERIMENTID", exp_ids)
98
- else:
99
- # Get all experiments
100
- exp_term = TermBuilder.gte_term("NOTEBOOKEXPERIMENT", "EXPERIMENTID", "0")
101
-
102
- root_term = TermBuilder.and_terms(records_term, exp_term)
103
-
104
- # Join records on the experiment entry records that correspond to them.
105
- records_entry_join = TermBuilder.compare_is_term("EXPERIMENTENTRYRECORD", "RECORDID", data_type_name, "RECORDID")
106
- # Join entry records on the experiment entries they are in.
107
- experiment_entry_enb_entry_join = TermBuilder.compare_is_term("ENBENTRY", "ENTRYID", "EXPERIMENTENTRYRECORD", "ENTRYID")
108
- # Join entries on the experiments they are in.
109
- enb_entry_experiment_join = TermBuilder.compare_is_term("NOTEBOOKEXPERIMENT", "EXPERIMENTID", "ENBENTRY", "EXPERIMENTID")
110
-
111
- report_builder = CustomReportBuilder(data_type_name)
112
- report_builder.set_root_term(root_term)
113
- report_builder.add_column("RECORDID", FieldType.LONG, data_type=data_type_name)
114
- report_builder.add_column("EXPERIMENTID", FieldType.LONG, data_type="NOTEBOOKEXPERIMENT")
115
- report_builder.add_join(records_entry_join)
116
- report_builder.add_join(experiment_entry_enb_entry_join)
117
- report_builder.add_join(enb_entry_experiment_join)
118
- return CustomReportUtil.run_custom_report(user, report_builder.build_report_criteria())