sapiopycommons 2025.4.17a488__py3-none-any.whl → 2025.4.22a490__py3-none-any.whl

sapiopycommons-2025.4.22a490.dist-info/RECORD

@@ -0,0 +1,85 @@
+sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/ai/tool_of_tools.py,sha256=zYmQ4rNX-qYQnc-vNDnYZjtv9JgmQAmVVuHfVOdBF3w,46984
+sapiopycommons/ai/tool_service_base.py,sha256=YJoHWTPD10TXXmZUKZIS6ryrV3Xqzt6TWNMNFaD8aQ4,10911
+sapiopycommons/ai/api/plan/proto/step_output_pb2.py,sha256=-5pyXHpDOVwM1FnbSyVKZ7UY2--DbvI1U2JxhsrCAtA,2527
+sapiopycommons/ai/api/plan/proto/step_output_pb2.pyi,sha256=4zIkURW-I_688qCtwRDbl53vRpoWHBpok5bAgopgSRE,1921
+sapiopycommons/ai/api/plan/proto/step_output_pb2_grpc.py,sha256=byasn9F38obmcDiMTRuLOmTHF8uzFadUciNfasaygTE,917
+sapiopycommons/ai/api/plan/proto/step_pb2.py,sha256=6qjydntkqu81b9rmcB2td-jBSfhXsA1dLKJ56PBLaxM,2378
+sapiopycommons/ai/api/plan/proto/step_pb2.pyi,sha256=LNR5iHcop9_0dwFgpHSfeuxwK0esmm1dx6fFY17SxQg,2032
+sapiopycommons/ai/api/plan/proto/step_pb2_grpc.py,sha256=p8iIDb3GJ0Fsy_TlwivXwRz_VeejSI7IDcEc4CNRvwM,910
+sapiopycommons/ai/api/plan/script/proto/script_pb2.py,sha256=MgltofGYEirWXHpUNI3bkogAq8tcMr4mLe77a2Md4hs,3575
+sapiopycommons/ai/api/plan/script/proto/script_pb2.pyi,sha256=BtYJeXdAyzWPB0Woe3s5MJL_RCYc_-bkfu2xb8-0jJg,4780
+sapiopycommons/ai/api/plan/script/proto/script_pb2_grpc.py,sha256=tjE-oFduGGZNuUMzRXosb2h5TaMT_Z-KKPHjm3KLoUs,6783
+sapiopycommons/ai/api/plan/tool/proto/entry_pb2.py,sha256=IHZWU6JG6WUPpqHvhipcfhsTkH0lL5N6x8u78CFr3yU,3868
+sapiopycommons/ai/api/plan/tool/proto/entry_pb2.pyi,sha256=Zc1LyJQmj_Qkha1Wnua2Fx4vs6FEScaSX-xDb1Xi-rw,4287
+sapiopycommons/ai/api/plan/tool/proto/entry_pb2_grpc.py,sha256=nnm3JI2mwfklOWs_8qtbbzPhT-P9deitnFpfDNiOCcY,916
+sapiopycommons/ai/api/plan/tool/proto/tool_pb2.py,sha256=quu96N7pDXw3cdzFrf6ykQIrOvhDFaLfRHgqSY1M1TI,4983
+sapiopycommons/ai/api/plan/tool/proto/tool_pb2.pyi,sha256=SZpr7mIU1Et1uefXbBr5jG-oJM_B6Ro7ZlWnT972s94,7304
+sapiopycommons/ai/api/plan/tool/proto/tool_pb2_grpc.py,sha256=InZkCC6ySInC2xZb3U61i3tClyycxv3mIO0qRZ70OGM,6834
+sapiopycommons/ai/api/session/proto/sapio_conn_info_pb2.py,sha256=LO35H0ojxcENWqDgMARqFIAmYU4iinVzdmbCcbYen4E,2063
+sapiopycommons/ai/api/session/proto/sapio_conn_info_pb2.pyi,sha256=9uHCNMVriDd72lsrWWH2irUB_5VG0mYyL_vhZWdOkns,1597
+sapiopycommons/ai/api/session/proto/sapio_conn_info_pb2_grpc.py,sha256=bXZMcjFHRAaQ3MqTz7oycWw9LaSlaBChyqW2VzZWEAk,924
+sapiopycommons/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/callbacks/callback_util.py,sha256=sz76LzD9sVLPMcoOpmzPe1aILGXcpHfyZ-qex8oR11c,130849
+sapiopycommons/callbacks/field_builder.py,sha256=p2XacN99MuKk3ite8GAqstUMpixqugul2CsC4gB83-o,38620
+sapiopycommons/chem/IndigoMolecules.py,sha256=slM2y39zZFHc468c366EqR8T-GYJ24UnM9HWAqWFEwQ,3900
+sapiopycommons/chem/Molecules.py,sha256=5PzRyE1s-Z3nfwh3Y4dCNdQOIJGhog08wyZvgTkKwyU,12384
+sapiopycommons/chem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/customreport/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/customreport/auto_pagers.py,sha256=3-XXWrP7r41a_Y-8YLPnfm0s65m4qEEUqu4azX47oPI,14828
+sapiopycommons/customreport/column_builder.py,sha256=0RO53e9rKPZ07C--KcepN6_tpRw_FxF3O9vdG0ilKG8,3014
+sapiopycommons/customreport/custom_report_builder.py,sha256=BlTxZ4t1sfZA2Ciur1EfYvkZxHxJ7ADwYNAe2zwiN0c,7176
+sapiopycommons/customreport/term_builder.py,sha256=PNp71NF1vFxidk5v6uQNi9oQR9KJIk8WfhyntvvZN-U,18573
+sapiopycommons/datatype/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/datatype/attachment_util.py,sha256=N-nhsJ0oxa_Ft6Y6VWeNFYLzfuQqsjhHA6_-yIt2wVw,3596
+sapiopycommons/datatype/data_fields.py,sha256=pczUlEcE0TeHEDU0Gkvu7voacSLPXCB7l9UbI1Tb6V0,5656
+sapiopycommons/datatype/pseudo_data_types.py,sha256=6TG7aJxgmUZ8FQkWBcgmbK5oy7AFFNtKOPpi1w1OOYA,27657
+sapiopycommons/eln/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/eln/experiment_handler.py,sha256=FeqmjnxN5WyDDstN3_AMSo9r7nQi-5zou4m-3K5JsYM,123363
+sapiopycommons/eln/experiment_report_util.py,sha256=NNNNPVD3_2ZAjoOqCMOnlnmPD0SCjDcgYi453ATSJBs,37027
+sapiopycommons/eln/experiment_tags.py,sha256=7-fpOiSqrjbXmWIJhEhaxMgLsVCPAtKqH8xRzpDVKoE,356
+sapiopycommons/eln/plate_designer.py,sha256=ix2cflz13PAHyu4deS3d5Qd3kQXk0C7IQxBQ2Dm9fEM,13692
+sapiopycommons/files/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/files/complex_data_loader.py,sha256=T39veNhvYl6j_uZjIIJ8Mk5Aa7otR5RB-g8XlAdkksA,1421
+sapiopycommons/files/file_bridge.py,sha256=vKbqxPexi15epr_-_qLrEfYoxNxB031mXN92iVtOMqE,9511
+sapiopycommons/files/file_bridge_handler.py,sha256=SEYDIQhSCmjI6qyLdDJE8JVKSd0WYvF7JvAq_Ahp9Do,25503
+sapiopycommons/files/file_data_handler.py,sha256=f96MlkMuQhUCi4oLnzJK5AiuElCp5jLI8_sJkZVwpws,36779
+sapiopycommons/files/file_util.py,sha256=w4Q7zYJb9YaPxrecmT4RT_OOibKMRP0NI1CyoOLfAP4,31747
+sapiopycommons/files/file_validator.py,sha256=ryg22-93csmRO_Pv0ZpWphNkB74xWZnHyJ23K56qLj0,28761
+sapiopycommons/files/file_writer.py,sha256=hACVl0duCjP28gJ1NPljkjagNCLod0ygUlPbvUmRDNM,17605
+sapiopycommons/flowcyto/flow_cyto.py,sha256=vs9WhXXKz3urpjL8QKSk56B-NSmQR3O3x_WFBKoeO10,3227
+sapiopycommons/flowcyto/flowcyto_data.py,sha256=mYKFuLbtpJ-EsQxLGtu4tNHVlygTxKixgJxJqD68F58,2596
+sapiopycommons/general/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/general/accession_service.py,sha256=QeNGd78Zr08ezWpThTuAkxO4bXusEcp5x9jJRZRwliA,13483
+sapiopycommons/general/aliases.py,sha256=alc2R5TOSKbZif3pcGZ706y23Y9F4HQPC-Kj4xJZ_Us,14503
+sapiopycommons/general/audit_log.py,sha256=KQq0PsvukUoE3l6TQb3-vpu5-MbSINpWlnQ9e7jojPg,8743
+sapiopycommons/general/custom_report_util.py,sha256=NwwmejSQLwSbrndEk1gPyFNYk9GZoS7Wrp9ab9moFgw,18014
+sapiopycommons/general/directive_util.py,sha256=7SeQrd2Ye5JHlXZtJZaVGgtaSLdq_Vm9EObuxf44Pz8,3905
+sapiopycommons/general/exceptions.py,sha256=aPlzK1cvxeMU5UsokYlLrIBGltUfJZ7LH8zvLh9DxpI,3233
+sapiopycommons/general/html_formatter.py,sha256=HE3OeGgwOw6x53zGSc4-UzP4-JoOmQIz3pX-DzNVg94,17138
+sapiopycommons/general/popup_util.py,sha256=HKILegU1uCL_6abNlNL0Wn3xgX2JNa_kJeq7e5CZu6Q,31923
+sapiopycommons/general/sapio_links.py,sha256=YkcVKNLrSGoM7tCCXBAsIbIxylctwdcEyhePrRMODe0,2859
+sapiopycommons/general/storage_util.py,sha256=ovmK_jN7v09BoX07XxwShpBUC5WYQOM7dbKV_VeLXJU,8892
+sapiopycommons/general/time_util.py,sha256=jU1urPoZRv6evNucR0-288EyT4PrsDpCr-H1-7BKq9A,12363
+sapiopycommons/multimodal/multimodal.py,sha256=PFaGJPbKvW__tnxb8KkgkJZOKjQdgxF_kGfD5chet1s,6779
+sapiopycommons/multimodal/multimodal_data.py,sha256=0BeVPr9HaC0hNTF1v1phTIKGruvNnwerHsD994qJKBg,15099
+sapiopycommons/processtracking/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/processtracking/custom_workflow_handler.py,sha256=QZVRDUXpHfYIKD9LtaOcOt0Sr3RGDaeGQb-LZYAgkCc,25117
+sapiopycommons/processtracking/endpoints.py,sha256=w5bziI2xC7450M95rCF8JpRwkoni1kEDibyAux9B12Q,10848
+sapiopycommons/recordmodel/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/recordmodel/record_handler.py,sha256=aPbR3OS0RlsKOGztY-LZaOmkXKUB8ZTw3qqdJKXwd6U,70872
+sapiopycommons/rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/rules/eln_rule_handler.py,sha256=1aC88brATcjL1O0Hd2hQ0XNguKsKh8xELXComotk3mQ,10772
+sapiopycommons/rules/on_save_rule_handler.py,sha256=J1YKjOGA1KUTwpnZMa7oIi5QU_4mBJrPygSHNDsMIIA,10539
+sapiopycommons/samples/aliquot.py,sha256=mWOJUqaQh0t3HklNuGdmuV7D5zzXs6fpLwtDdM6_XTo,3018
+sapiopycommons/sftpconnect/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/sftpconnect/sftp_builder.py,sha256=lFK3FeXk-sFLefW0hqY8WGUQDeYiGaT6yDACzT_zFgQ,3015
+sapiopycommons/webhook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sapiopycommons/webhook/webhook_context.py,sha256=D793uLsb1691SalaPnBUk3rOSxn_hYLhdvkaIxjNXss,1909
+sapiopycommons/webhook/webhook_handlers.py,sha256=L0HetSm43NvA5KyW3xbLpGFh2DbAaeZJVtXIEl2fvV8,39689
+sapiopycommons/webhook/webservice_handlers.py,sha256=Y5dHx_UFWFuSqaoPL6Re-fsKYRuxvCWZ8bj6KSZ3jfM,14285
+sapiopycommons-2025.4.22a490.dist-info/METADATA,sha256=zttU8KRjC2j6mRGxer76WEB_E8IPAOm_U3xENmQ-Tek,3143
+sapiopycommons-2025.4.22a490.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sapiopycommons-2025.4.22a490.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2025.4.22a490.dist-info/RECORD,,

sapiopycommons/eln/experiment_cache.py

@@ -1,188 +0,0 @@
-from __future__ import annotations
-
-from weakref import WeakValueDictionary
-
-from sapiopylib.rest.ELNService import ElnManager
-from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.datatype.FieldDefinition import AbstractVeloxFieldDefinition
-from sapiopylib.rest.pojo.eln.ElnExperiment import ElnTemplate, TemplateExperimentQuery
-from sapiopylib.rest.pojo.eln.SapioELNEnums import ElnBaseDataType
-from sapiopylib.rest.pojo.eln.field_set import ElnFieldSetInfo
-from sapiopylib.rest.pojo.eln.protocol_template import ProtocolTemplateInfo, ProtocolTemplateQuery
-
-from sapiopycommons.general.aliases import UserIdentifier, AliasUtil
-from sapiopycommons.general.exceptions import SapioException
-
-
-# FR-47530: Created a class that caches experiment template and predefined field information.
-class ExperimentCacheManager:
-    """
-    A class to manage the caching of experiment-related information.
-    """
-    user: SapioUser
-    eln_man: ElnManager
-
-    _templates: list[ElnTemplate]
-    """A list of experiment templates. Only cached when first accessed."""
-    _protocols: list[ProtocolTemplateInfo]
-    """A list of protocol templates. Only cached when first accessed."""
-    _field_sets: dict[str, ElnFieldSetInfo]
-    """A dictionary of field set name to field set. Only cached when first accessed."""
-    _field_set_fields: dict[int, list[AbstractVeloxFieldDefinition]]
-    """A dictionary of field set ID to field definitions. Only cached when first accessed."""
-    _predefined_fields: dict[str, dict[str, AbstractVeloxFieldDefinition]]
-    """A dictionary of ELN data type name to predefined field definitions. Only cached when first accessed."""
-
-    __instances: WeakValueDictionary[SapioUser, ExperimentCacheManager] = WeakValueDictionary()
-    __initialized: bool
-
-    def __new__(cls, context: UserIdentifier):
-        """
-        :param context: The current webhook context or a user object to send requests from.
-        """
-        user = AliasUtil.to_sapio_user(context)
-        obj = cls.__instances.get(user)
-        if not obj:
-            obj = object.__new__(cls)
-            obj.__initialized = False
-            cls.__instances[user] = obj
-        return obj
-
-    def __init__(self, context: UserIdentifier):
-        """
-        :param context: The current webhook context or a user object to send requests from.
-        """
-        if self.__initialized:
-            return
-        self.__initialized = True
-
-        self.user = AliasUtil.to_sapio_user(context)
-        self.eln_man = ElnManager(self.user)
-
-        self._field_set_fields = {}
-        self._predefined_fields = {}
-
-    def get_experiment_template(self, name: str, active: bool = True, version: int | None = None,
-                                first_match: bool = False, public: bool | None = True) -> ElnTemplate:
-        """
-        Get the experiment template with the given information.
-
-        :param name: The name of the template.
-        :param active: Whether the template is marked as active.
-        :param version: The version of the template to get. If None, the latest version will be returned.
-        :param first_match: If true, returns the first match found. If false, raises an exception.
-        :param public: Whether the template is public. If true, only pubic templates will be queried. If false, only
-            private templates will be queried. If None, both public and private templates will be queried. Non-public
-            templates do not have a version number, so this will always fail if public is false and a version number is
-            provided.
-        :return: The experiment template with the given information.
-        """
-        if not hasattr(self, "_templates"):
-            query = TemplateExperimentQuery()
-            query.active_templates_only = False
-            query.latest_version_only = False
-            self._templates = self.eln_man.get_template_experiment_list(query)
-        return self._find_template(self._templates, name, active, version, first_match, public)
-
-
-    def get_protocol_template(self, name: str, active: bool = True, version: int | None = None,
-                              first_match: bool = False, public: bool | None = True) -> ProtocolTemplateInfo:
-        """
-        Get the protocol template with the given information. Will throw an exception if multiple templates match
-        the given information.
-
-        :param name: The name of the template.
-        :param active: Whether the template is marked as active.
-        :param version: The version of the template to get. If None, the latest version will be returned.
-        :param first_match: If true, returns the first match found. If false, raises an exception.
-        :param public: Whether the template is public. If true, only pubic templates will be queried. If false, only
-            private templates will be queried. If None, both public and private templates will be queried. Non-public
-            templates do not have a version number, so this will always fail if public is false and a version number is
-            provided.
-        :return: The protocol template with the given information.
-        """
-        if not hasattr(self, "_protocols"):
-            query = ProtocolTemplateQuery()
-            query.active_templates_only = False
-            query.latest_version_only = False
-            self._protocols = self.eln_man.get_protocol_template_info_list(query)
-        return self._find_template(self._protocols, name, active, version, first_match, public)
-
-    @staticmethod
-    def _find_template(templates: list[ElnTemplate] | list[ProtocolTemplateInfo], name: str, active: bool,
-                       version: int, first_match: bool, public: bool | None) -> ElnTemplate | ProtocolTemplateInfo:
-        """
-        Find the experiment or protocol template with the given information.
-        """
-        matches = []
-        for template in templates:
-            if template.template_name != name:
-                continue
-            if template.active != active:
-                continue
-            if version is not None and template.template_version != version:
-                continue
-            if public is True and template.template_version is None:
-                continue
-            if public is False and template.template_version is not None:
-                continue
-            matches.append(template)
-        if not matches:
-            raise SapioException(f"No template with the name \"{name}\"" +
-                                 ("" if version is None else f" and the version {version}") +
-                                 f" found.")
-        # Only filter for the max version number if any of the matches actually have a version number.
-        versioned_matches = [x for x in matches if x.template_version is not None]
-        if version is None and versioned_matches:
-            return max(versioned_matches, key=lambda x: x.template_version)
-        if len(matches) > 1 and not first_match:
-            raise SapioException(f"Multiple templates with the name \"{name}\" found. Consider setting first_match to "
-                                 f"true, or restrict your search criteria further.")
-        return matches[0]
-
-    def get_predefined_field(self, field_name: str, data_type: ElnBaseDataType) -> AbstractVeloxFieldDefinition:
-        """
-        Get the predefined field of the given name for the given ELN data type.
-
-        :param field_name: The name of the field.
-        :param data_type: The ELN data type of the field.
-        :return: The predefined field of the given name for the given ELN data type.
-        """
-        return self.get_predefined_fields(data_type)[field_name]
-
-    def get_predefined_fields(self, data_type: ElnBaseDataType) -> dict[str, AbstractVeloxFieldDefinition]:
-        """
-        Get the predefined fields for the given ELN data type.
-
-        :param data_type: The ELN data type to get the predefined fields for.
-        :return: A dictionary of field name to field definition for the given ELN data type.
-        """
-        if data_type.data_type_name not in self._predefined_fields:
-            fields: list[AbstractVeloxFieldDefinition] = self.eln_man.get_predefined_fields(data_type)
-            self._predefined_fields[data_type.data_type_name] = {x.data_field_name: x for x in fields}
-        return self._predefined_fields[data_type.data_type_name]
-
-    def get_field_set(self, name: str) -> ElnFieldSetInfo:
-        """
-        Get the field set with the given name.
-
-        :param name: The name of the field set.
-        :return: The field set with the given name.
-        """
-        if not hasattr(self, "_field_sets"):
-            self._field_sets = {x.field_set_name: x for x in self.eln_man.get_field_set_info_list()}
-        return self._field_sets[name]
-
-    def get_field_set_fields(self, field_set: ElnFieldSetInfo | int) -> list[AbstractVeloxFieldDefinition]:
-        """
-        Get the fields of the given field set.
-
-        :param field_set: The field set to get the fields from. Can be either an ElnFieldSetInfo object or an integer
-            for the set ID.
-        :return: The fields of the given field set.
-        """
-        field_set: int = field_set if isinstance(field_set, int) else field_set.field_set_id
-        if field_set in self._field_set_fields:
-            return self._field_set_fields[field_set]
-        self._field_set_fields[field_set] = self.eln_man.get_predefined_fields_from_field_set_id(field_set)
-        return self._field_set_fields[field_set]