sapiopycommons 2024.8.28a313__py3-none-any.whl → 2024.8.28a315__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 +407 -69
  2. sapiopycommons/chem/IndigoMolecules.py +1 -0
  3. sapiopycommons/chem/Molecules.py +1 -0
  4. sapiopycommons/customreport/__init__.py +0 -0
  5. sapiopycommons/customreport/column_builder.py +60 -0
  6. sapiopycommons/customreport/custom_report_builder.py +125 -0
  7. sapiopycommons/customreport/term_builder.py +299 -0
  8. sapiopycommons/datatype/attachment_util.py +11 -10
  9. sapiopycommons/eln/experiment_handler.py +209 -48
  10. sapiopycommons/eln/experiment_report_util.py +118 -0
  11. sapiopycommons/files/complex_data_loader.py +5 -4
  12. sapiopycommons/files/file_bridge.py +31 -24
  13. sapiopycommons/files/file_bridge_handler.py +340 -0
  14. sapiopycommons/files/file_data_handler.py +2 -5
  15. sapiopycommons/files/file_util.py +50 -10
  16. sapiopycommons/files/file_validator.py +92 -6
  17. sapiopycommons/files/file_writer.py +44 -15
  18. sapiopycommons/general/accession_service.py +375 -0
  19. sapiopycommons/general/aliases.py +147 -3
  20. sapiopycommons/general/audit_log.py +196 -0
  21. sapiopycommons/general/custom_report_util.py +211 -37
  22. sapiopycommons/general/popup_util.py +17 -0
  23. sapiopycommons/general/sapio_links.py +50 -0
  24. sapiopycommons/general/time_util.py +40 -0
  25. sapiopycommons/multimodal/multimodal.py +146 -0
  26. sapiopycommons/multimodal/multimodal_data.py +486 -0
  27. sapiopycommons/processtracking/endpoints.py +22 -22
  28. sapiopycommons/recordmodel/record_handler.py +481 -97
  29. sapiopycommons/rules/eln_rule_handler.py +34 -25
  30. sapiopycommons/rules/on_save_rule_handler.py +34 -31
  31. sapiopycommons/webhook/webhook_handlers.py +147 -26
  32. sapiopycommons/webhook/webservice_handlers.py +67 -0
  33. {sapiopycommons-2024.8.28a313.dist-info → sapiopycommons-2024.8.28a315.dist-info}/METADATA +4 -2
  34. sapiopycommons-2024.8.28a315.dist-info/RECORD +50 -0
  35. sapiopycommons-2024.8.28a313.dist-info/RECORD +0 -38
  36. {sapiopycommons-2024.8.28a313.dist-info → sapiopycommons-2024.8.28a315.dist-info}/WHEEL +0 -0
  37. {sapiopycommons-2024.8.28a313.dist-info → sapiopycommons-2024.8.28a315.dist-info}/licenses/LICENSE +0 -0
@@ -6,6 +6,7 @@ indigo = Indigo()
6
6
  renderer = IndigoRenderer(indigo)
7
7
  indigo.setOption("render-output-format", "svg")
8
8
  indigo.setOption("ignore-stereochemistry-errors", True)
9
+ indigo.setOption("render-stereo-style", "ext")
9
10
  indigo.setOption("aromaticity-model", "generic")
10
11
  indigo.setOption("render-coloring", True)
11
12
  indigo_inchi = IndigoInchi(indigo);
@@ -181,6 +181,7 @@ def mol_to_sapio_substance(mol: Mol, include_stereoisomers: bool = False,
181
181
  # We need to test the INCHI can be loaded back to indigo.
182
182
  indigo_mol = indigo.loadMolecule(molBlock)
183
183
  indigo_mol.aromatize()
184
+ indigo_inchi.resetOptions()
184
185
  indigo_inchi_str = indigo_inchi.getInchi(indigo_mol)
185
186
  molecule["inchi"] = indigo_inchi_str
186
187
  indigo_inchi_key_str = indigo_inchi.getInchiKey(indigo_inchi_str)
File without changes
@@ -0,0 +1,60 @@
1
+ from sapiopylib.rest.pojo.CustomReport import ReportColumn
2
+ from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
3
+
4
+ from sapiopycommons.general.aliases import DataTypeIdentifier, FieldIdentifier, AliasUtil
5
+ from sapiopycommons.general.exceptions import SapioException
6
+
7
+ # The system fields that every record has and their field types. System fields aren't generated as record model fields
8
+ # for all platform version, hence the need to create a dict for them in the off chance that they're not present on
9
+ # the model wrapper.
10
+ SYSTEM_FIELDS: dict[str, FieldType] = {
11
+ "DataRecordName": FieldType.IDENTIFIER,
12
+ "RecordId": FieldType.LONG,
13
+ "DateCreated": FieldType.DATE,
14
+ "CreatedBy": FieldType.STRING,
15
+ "VeloxLastModifiedDate": FieldType.DATE,
16
+ "VeloxLastModifiedBy": FieldType.STRING
17
+ }
18
+
19
+
20
+ class ColumnBuilder:
21
+ """
22
+ A class for building report columns for custom reports.
23
+ """
24
+ @staticmethod
25
+ def build_column(data_type: DataTypeIdentifier, field: FieldIdentifier, field_type: FieldType | None = None) \
26
+ -> ReportColumn:
27
+ """
28
+ Build a ReportColumn from a variety of possible inputs.
29
+
30
+ :param data_type: An object that can be used to identify a data type.
31
+ :param field: An object that can be used to identify a data field.
32
+ :param field_type: The field type of the provided field. This is only required if the field type cannot be
33
+ determined from the given data type and field, which occurs when the given field is a string and the
34
+ given data type is not a wrapped record model or record model wrapper.
35
+ :return: A ReportColumn for the inputs.
36
+ """
37
+ # Get the data type and field names from the inputs.
38
+ data_type_name = AliasUtil.to_data_type_name(data_type)
39
+ field_name = AliasUtil.to_data_field_name(field)
40
+ if field_type is None:
41
+ field_type = ColumnBuilder.__field_type(data_type, field)
42
+ if field_type is None:
43
+ raise SapioException("The field_type parameter is required for the provided data_type and field inputs.")
44
+ return ReportColumn(data_type_name, field_name, field_type)
45
+
46
+ @staticmethod
47
+ def __field_type(data_type: DataTypeIdentifier, field: FieldIdentifier) -> FieldType | None:
48
+ """
49
+ Given a record model wrapper and a field name, return the field type for that field. Accounts for system fields.
50
+
51
+ :param data_type: The record model wrapper that the field is on.
52
+ :param field: The field name to return the type of.
53
+ :return: The field type of the given field name.
54
+ """
55
+ # Check if the field name is a system field. If it us, use the field type defined in this file.
56
+ field_name: str = AliasUtil.to_data_field_name(field)
57
+ if field_name in SYSTEM_FIELDS:
58
+ return SYSTEM_FIELDS.get(field_name)
59
+ # Otherwise, check if the field type can be found from the wrapper.
60
+ return AliasUtil.to_field_type(field_name, data_type)
@@ -0,0 +1,125 @@
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)
@@ -0,0 +1,299 @@
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,10 +1,9 @@
1
1
  import io
2
2
 
3
- from sapiopylib.rest.User import SapioUser
4
- from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
3
+ from sapiopylib.rest.DataMgmtService import DataMgmtServer
5
4
  from sapiopylib.rest.utils.recordmodel.RecordModelWrapper import WrappedType
6
5
 
7
- from sapiopycommons.general.aliases import AliasUtil, SapioRecord
6
+ from sapiopycommons.general.aliases import AliasUtil, SapioRecord, UserIdentifier
8
7
  from sapiopycommons.general.exceptions import SapioException
9
8
  from sapiopycommons.recordmodel.record_handler import RecordHandler
10
9
 
@@ -12,31 +11,32 @@ from sapiopycommons.recordmodel.record_handler import RecordHandler
12
11
  # FR-46064 - Initial port of PyWebhookUtils to sapiopycommons.
13
12
  class AttachmentUtil:
14
13
  @staticmethod
15
- def get_attachment_bytes(context: SapioWebhookContext, attachment: SapioRecord) -> bytes:
14
+ def get_attachment_bytes(context: UserIdentifier, attachment: SapioRecord) -> bytes:
16
15
  """
17
16
  Get the data bytes for the given attachment record. Makes a webservice call to retrieve the data.
18
17
 
19
- :param context: The current webhook context.
18
+ :param context: The current webhook context or a user object to send requests from.
20
19
  :param attachment: The attachment record.
21
20
  :return: The bytes for the attachment's file data.
22
21
  """
23
22
  attachment = AliasUtil.to_data_record(attachment)
23
+ dr_man = DataMgmtServer.get_data_record_manager(AliasUtil.to_sapio_user(context))
24
24
  with io.BytesIO() as data_sink:
25
25
  def consume_data(chunk: bytes):
26
26
  data_sink.write(chunk)
27
- context.data_record_manager.get_attachment_data(attachment, consume_data)
27
+ dr_man.get_attachment_data(attachment, consume_data)
28
28
  data_sink.flush()
29
29
  data_sink.seek(0)
30
30
  file_bytes = data_sink.read()
31
31
  return file_bytes
32
32
 
33
33
  @staticmethod
34
- def set_attachment_bytes(context: SapioWebhookContext, attachment: SapioRecord,
34
+ def set_attachment_bytes(context: UserIdentifier, attachment: SapioRecord,
35
35
  file_name: str, file_bytes: bytes) -> None:
36
36
  """
37
37
  Set the attachment data for a given attachment record. Makes a webservice call to set the data.
38
38
 
39
- :param context: The current webhook context.
39
+ :param context: The current webhook context or a user object to send requests from.
40
40
  :param attachment: The attachment record. Must be an existing data record that is an attachment type.
41
41
  :param file_name: The name of the attachment.
42
42
  :param file_bytes: The bytes of the attachment data.
@@ -45,11 +45,12 @@ class AttachmentUtil:
45
45
  raise SapioException("Provided record cannot have its attachment data set, as it does not exist in the "
46
46
  "system yet.")
47
47
  attachment = AliasUtil.to_data_record(attachment)
48
+ dr_man = DataMgmtServer.get_data_record_manager(AliasUtil.to_sapio_user(context))
48
49
  with io.BytesIO(file_bytes) as stream:
49
- context.data_record_manager.set_attachment_data(attachment, file_name, stream)
50
+ dr_man.set_attachment_data(attachment, file_name, stream)
50
51
 
51
52
  @staticmethod
52
- def create_attachment(context: SapioWebhookContext | SapioUser, file_name: str, file_bytes: bytes,
53
+ def create_attachment(context: UserIdentifier, file_name: str, file_bytes: bytes,
53
54
  wrapper_type: type[WrappedType]) -> WrappedType:
54
55
  """
55
56
  Create an attachment data type and initialize its attachment bytes at the same time.