labstep 3.35.0__tar.gz → 3.36.0__tar.gz

{labstep-3.35.0 → labstep-3.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labstep
-Version: 3.35.0
+Version: 3.36.0
 Summary: Python SDK for working with the Labstep API
 Home-page: http://github.com/Labstep/labstepPy
 Author: Labstep

labstep-3.36.0/labstep/constants/version.py

@@ -0,0 +1 @@
+VERSION = "3.36.0"

{labstep-3.35.0 → labstep-3.36.0}/labstep/entities/experiment/model.py

@@ -717,6 +717,47 @@ class Experiment(EntityPrimary):
 
         return self.root_experiment.addJupyterNotebook(name, data)
 
+    def addSmartTable(self, name=UNSPECIFIED, extraParams={}):
+        """
+        Add a new smart table to an Experiment.
+
+        Parameters
+        ----------
+        name (str)
+            The name of the smart table.
+
+        Returns
+        -------
+        :class:`~labstep.entities.experimentSmartTable.model.ExperimentSmartTable`
+            The newly added smart table entity.
+
+        Example
+        -------
+        ::
+
+            experiment = user.getExperiment(17000)
+            experiment.addSmartTable(name='My Smart Table')
+        """
+        return self.root_experiment.addSmartTable(name=name, extraParams=extraParams)
+
+    def getSmartTables(self):
+        """
+        Returns a list of the smart tables in an Experiment.
+
+        Returns
+        -------
+        List[:class:`~labstep.entities.experimentSmartTable.model.ExperimentSmartTable`]
+            List of the smart tables in an Experiment.
+
+        Example
+        -------
+        ::
+
+            experiment = user.getExperiment(17000)
+            smart_tables = experiment.getSmartTables()
+        """
+        return self.root_experiment.getSmartTables()
+
     def addConditions(self, number_of_conditions):
         """
         Add conditions to the experiment

{labstep-3.35.0 → labstep-3.36.0}/labstep/entities/experimentCondition/repository.py

@@ -7,8 +7,7 @@ def addExperimentConditions(entity, number_of_conditions):
     from labstep.generic.entity.repository import newEntities
     from labstep.entities.experimentCondition.model import ExperimentCondition
 
-    conditions = [{f'{entity.__entityName__}_guid': entity.guid}
-                  ] * number_of_conditions
+    conditions = [{f"{entity.__entityName__}_guid": entity.guid}] * number_of_conditions
 
     return newEntities(entity.__user__, ExperimentCondition, conditions)
 
@@ -18,9 +17,12 @@ def getExperimentConditions(entity):
     from labstep.entities.experimentCondition.model import ExperimentCondition
     from labstep.constants import UNSPECIFIED
 
-
     params = {
-        f'{entity.__entityName__}_guid': entity.guid if hasattr(entity,'guid') else UNSPECIFIED,
+        f"{entity.__entityName__}_id": (
+            entity.guid if hasattr(entity, "guid") else UNSPECIFIED
+        ),
     }
-    
-    return getEntities(entity.__user__, ExperimentCondition, count=UNSPECIFIED,filterParams=params)
+
+    return getEntities(
+        entity.__user__, ExperimentCondition, count=UNSPECIFIED, filterParams=params
+    )

{labstep-3.35.0 → labstep-3.36.0}/labstep/entities/experimentDataField/repository.py

@@ -20,59 +20,59 @@ def getDataFields(entity, count=UNSPECIFIED, extraParams={}):
 
     params = {}
 
-    if hasattr(entity, 'metadata_thread') is False:
+    if hasattr(entity, "metadata_thread") is False:
         entity.update()
 
     if isinstance(entity, ExperimentProtocol):
-        params = {
-            "metadata_thread_id": entity.metadata_thread["id"]}
+        params = {"metadata_thread_id": entity.metadata_thread["id"]}
 
     elif isinstance(entity, Resource):
-        params = {
-            "multiplexing_input_resource_id": entity.id,
-            "has_value": True
-        }
+        params = {"multiplexing_input_resource_id": entity.id, "has_value": True}
         dataWhenInput = entityRepository.getEntities(
-            entity.__user__, ExperimentDataField, count=count, filterParams={
-                **params, **extraParams})
+            entity.__user__,
+            ExperimentDataField,
+            count=count,
+            filterParams={**params, **extraParams},
+        )
 
-        params = {
-            "multiplexing_output_resource_id": entity.id,
-            "has_value": True
-        }
+        params = {"multiplexing_output_resource_id": entity.id, "has_value": True}
         dataWhenOutput = entityRepository.getEntities(
-            entity.__user__, ExperimentDataField, count=count, filterParams={
-                **params, **extraParams})
+            entity.__user__,
+            ExperimentDataField,
+            count=count,
+            filterParams={**params, **extraParams},
+        )
 
         return dataWhenInput + dataWhenOutput
 
     elif isinstance(entity, ResourceItem):
-        params = {
-            "multiplexing_input_resource_item_id": entity.id,
-            "has_value": True
-        }
+        params = {"multiplexing_input_resource_item_id": entity.id, "has_value": True}
         dataWhenInput = entityRepository.getEntities(
-            entity.__user__, ExperimentDataField, count=count, filterParams={
-                **params, **extraParams})
+            entity.__user__,
+            ExperimentDataField,
+            count=count,
+            filterParams={**params, **extraParams},
+        )
 
-        params = {
-            "multiplexing_output_resource_item_id": entity.id,
-            "has_value": True
-        }
+        params = {"multiplexing_output_resource_item_id": entity.id, "has_value": True}
         dataWhenOutput = entityRepository.getEntities(
-            entity.__user__, ExperimentDataField, count=count, filterParams={
-                **params, **extraParams})
+            entity.__user__,
+            ExperimentDataField,
+            count=count,
+            filterParams={**params, **extraParams},
+        )
 
         return dataWhenInput + dataWhenOutput
 
     return entityRepository.getEntities(
-        entity.__user__, ExperimentDataField, count=count, filterParams={
-            **params, **extraParams}
+        entity.__user__,
+        ExperimentDataField,
+        count=count,
+        filterParams={**params, **extraParams},
     )
 
 
 def addDataFieldTo(
-
     entity,
     fieldName,
     fieldType="default",
@@ -89,7 +89,7 @@ def addDataFieldTo(
     else:
         fileId = UNSPECIFIED
 
-    if hasattr(entity, 'metadata_thread') is False:
+    if hasattr(entity, "metadata_thread") is False:
         entity.update()
 
     params = {
@@ -107,12 +107,18 @@ def addDataFieldTo(
     return entityRepository.newEntity(entity.__user__, ExperimentDataField, params)
 
 
-def editDataField(dataField, fieldName=UNSPECIFIED, value=UNSPECIFIED, is_variable=UNSPECIFIED, extraParams={}):
+def editDataField(
+    dataField,
+    fieldName=UNSPECIFIED,
+    value=UNSPECIFIED,
+    is_variable=UNSPECIFIED,
+    extraParams={},
+):
     params = {
         "label": handleString(fieldName),
         "value": handleString(value),
         "is_variable": is_variable,
-        **extraParams
+        **extraParams,
     }
     return entityRepository.editEntity(dataField, params)
 
@@ -122,43 +128,43 @@ def getDataFieldValue(dataField):
     if dataField.device_data is not None:
         dataField = DeviceData(dataField.device_data, dataField.__user__)
 
-    if dataField.type == 'default':
+    if dataField.type == "default":
         return dataField.value
 
-    if dataField.type == 'numeric':
+    if dataField.type == "numeric":
         return dataField.number
 
-    if dataField.type == 'date':
+    if dataField.type == "date":
         if dataField.date is None:
             return None
         return formatDate(dataField.date, time=False)
 
-    if dataField.type == 'datetime':
+    if dataField.type == "datetime":
         return formatDate(dataField.date)
 
-    if dataField.type == 'options':
+    if dataField.type == "options":
         if dataField.options is None:
             return None
 
-        keys = [k for k, v in dataField.options['values'].items() if v]
+        keys = [k for k, v in dataField.options["values"].items() if v]
 
         if keys == []:
             return None
 
-        if dataField.options['is_allow_multiple']:
+        if dataField.options["is_allow_multiple"]:
             return keys
 
         return keys[0]
 
-    if dataField.type == 'file':
+    if dataField.type == "file":
 
         if len(dataField.files) == 1:
             return File(dataField.files[0], dataField.__user__)
         else:
             return EntityList(dataField.files, File, dataField.__user__)
 
-    if dataField.type == 'sequence':
-        return json.loads(dataField.sequence['data'])
+    if dataField.type == "sequence":
+        return json.loads(dataField.sequence["data"])
 
     return None
 
@@ -166,13 +172,14 @@ def getDataFieldValue(dataField):
 def setDataFieldValue(dataField, value, condition_id=None):
     if condition_id is not None:
         if dataField.is_variable is False:
-            raise Exception(
-                'Cannot set value for conditions on a constant data field')
+            raise Exception("Cannot set value for conditions on a constant data field")
 
         conditionDataField = entityRepository.getEntities(
-            dataField.__user__, ExperimentDataField, count=UNSPECIFIED, filterParams={
-                'protocol_condition_id': condition_id
-        }).get(dataField.guid, searchKey='variable_template_guid')
+            dataField.__user__,
+            ExperimentDataField,
+            count=UNSPECIFIED,
+            filterParams={"protocol_condition_id": condition_id},
+        ).get(dataField.guid, searchKey="variable_template_guid")
 
         if conditionDataField is None:
             params = {
@@ -181,27 +188,26 @@ def setDataFieldValue(dataField, value, condition_id=None):
                 "variable_template_id": dataField.id,
                 "protocol_condition_id": condition_id,
             }
-            newField = entityRepository.newEntity(dataField.__user__, ExperimentDataField, params)
+            newField = entityRepository.newEntity(
+                dataField.__user__, ExperimentDataField, params
+            )
             setDataFieldValue(newField, value)
         else:
-            return setDataFieldValue(conditionDataField,value)
-
+            return setDataFieldValue(conditionDataField, value)
 
-    if condition_id is None and dataField.is_variable is True:
-        raise Exception(
-            'Please specify a condition ID for variable data fields')
+    if condition_id is None and dataField.is_variable is True and dataField.variable_template_guid is None:
+        raise Exception("Please specify a condition ID for variable data fields")
 
+    if dataField.type == "default":
+        return dataField.edit(extraParams={"value": str(value)})
 
-    if dataField.type == 'default':
-        return dataField.edit(extraParams={'value': str(value)})
+    if dataField.type == "numeric":
+        return dataField.edit(extraParams={"number": float(value)})
 
-    if dataField.type == 'numeric':
-        return dataField.edit(extraParams={'number': float(value)})
+    if dataField.type == "date" or dataField.type == "datetime":
+        return dataField.edit(extraParams={"date": handleDate(value)})
 
-    if dataField.type == 'date' or dataField.type == 'datetime':
-        return dataField.edit(extraParams={'date': handleDate(value)})
-
-    if dataField.type == 'options':
+    if dataField.type == "options":
 
         if isinstance(value, list) is False:
             value = [str(value)]
@@ -209,31 +215,25 @@ def setDataFieldValue(dataField, value, condition_id=None):
         options = dataField.options
 
         if options is None:
-            options = {
-                'is_allow_multiple': False,
-                'is_allow_add': True,
-                'values': {}
-            }
+            options = {"is_allow_multiple": False, "is_allow_add": True, "values": {}}
 
-        if options['values'] is None:
-            options['values'] = {}
+        if options["values"] is None:
+            options["values"] = {}
 
-        options['values'] = {key: False for key in options['values'].keys()}
+        options["values"] = {key: False for key in options["values"].keys()}
 
-        if options['is_allow_multiple'] is False and len(value) > 1:
-            raise Exception(
-                'Specifying multiple values for this field is forbidden. ')
+        if options["is_allow_multiple"] is False and len(value) > 1:
+            raise Exception("Specifying multiple values for this field is forbidden. ")
 
         for activeKey in value:
-            options['values'][activeKey] = True
+            options["values"][activeKey] = True
 
-        return dataField.edit(extraParams={'options': options})
+        return dataField.edit(extraParams={"options": options})
 
-    if dataField.type == 'file':
+    if dataField.type == "file":
         if isinstance(value, File) is False:
-            raise Exception(
-                'Please specify a Labstep File object as the value')
+            raise Exception("Please specify a Labstep File object as the value")
 
-        return dataField.edit(extraParams={'file_id': value.id})
+        return dataField.edit(extraParams={"file_id": value.id})
 
     return None

{labstep-3.35.0 → labstep-3.36.0}/labstep/entities/experimentInventoryField/repository.py

@@ -14,15 +14,23 @@ def getExperimentInventoryField(user, experiment_inventoryfield_id):
     )
 
 
-def getExperimentInventoryFields(user, experiment_id, count=UNSPECIFIED, extraParams={}):
-    params = {
-        'experiment_id': experiment_id,
-        **extraParams
-    }
+def getExperimentInventoryFields(
+    user, experiment_id, count=UNSPECIFIED, extraParams={}
+):
+    params = {"experiment_id": experiment_id, **extraParams}
     return entityRepository.getEntities(user, ExperimentInventoryField, count, params)
 
 
-def newExperimentInventoryField(user, experiment_id, name, resource_id=UNSPECIFIED, resource_item_id=UNSPECIFIED, amount=UNSPECIFIED, units=UNSPECIFIED, extraParams={}):
+def newExperimentInventoryField(
+    user,
+    experiment_id,
+    name,
+    resource_id=UNSPECIFIED,
+    resource_item_id=UNSPECIFIED,
+    amount=UNSPECIFIED,
+    units=UNSPECIFIED,
+    extraParams={},
+):
     params = {
         "experiment_id": experiment_id,
         "name": name,
@@ -39,18 +47,27 @@ def newExperimentInventoryField(user, experiment_id, name, resource_id=UNSPECIFI
     return entityRepository.newEntity(user, ExperimentInventoryField, params)
 
 
-def editExperimentInventoryField(expermient_inventoryfield, name=UNSPECIFIED, amount=UNSPECIFIED, units=UNSPECIFIED, resource_id=UNSPECIFIED, resource_item_id=UNSPECIFIED, extraParams={}):
+def editExperimentInventoryField(
+    expermient_inventoryfield,
+    name=UNSPECIFIED,
+    amount=UNSPECIFIED,
+    units=UNSPECIFIED,
+    resource_id=UNSPECIFIED,
+    resource_item_id=UNSPECIFIED,
+    extraParams={},
+):
     params = {
         "name": name,
-        "value": amount,
+        "value": str(amount) if amount is not UNSPECIFIED else UNSPECIFIED,
         "units": units,
         "resource_id": resource_id,
         "resource_item_id": resource_item_id,
-        **extraParams
+        **extraParams,
     }
 
     return entityRepository.editEntity(expermient_inventoryfield, params)
 
+
 def getValue(experiment_inventory_field, condition_id=UNSPECIFIED):
     """
     Get the value of an Experiment Inventory Field for a specific condition.
@@ -68,7 +85,12 @@ def getValue(experiment_inventory_field, condition_id=UNSPECIFIED):
     return experiment_inventory_field.getValue(condition_id)
 
 
-def setValue(experiment_inventory_field, amount, resource_item_id=UNSPECIFIED, condition_id=UNSPECIFIED):
+def setValue(
+    experiment_inventory_field,
+    amount,
+    resource_item_id=UNSPECIFIED,
+    condition_id=UNSPECIFIED,
+):
     """
     Set the value of an Experiment Inventory Field for a specific condition.
 
@@ -88,26 +110,33 @@ def setValue(experiment_inventory_field, amount, resource_item_id=UNSPECIFIED, c
     """
     if condition_id is not UNSPECIFIED:
         if experiment_inventory_field.is_variable is False:
-            raise Exception(
-                'Cannot set value for conditions on a constant field')
+            raise Exception("Cannot set value for conditions on a constant field")
 
         conditionInventoryField = entityRepository.getEntities(
-            experiment_inventory_field.__user__, ExperimentInventoryField, count=UNSPECIFIED, filterParams={
-                'protocol_condition_id': condition_id
-        }).get(experiment_inventory_field.guid, searchKey='variable_template_guid')
+            experiment_inventory_field.__user__,
+            ExperimentInventoryField,
+            count=UNSPECIFIED,
+            filterParams={"protocol_condition_id": condition_id},
+        ).get(experiment_inventory_field.guid, searchKey="variable_template_guid")
 
         if conditionInventoryField is None:
             params = {
-                "is_input":experiment_inventory_field.is_input,
-                "is_output":experiment_inventory_field.is_output,
-                "experiment_id": experiment_inventory_field.experiment['id'],
+                "is_input": experiment_inventory_field.is_input,
+                "is_output": experiment_inventory_field.is_output,
+                "experiment_id": experiment_inventory_field.experiment["id"],
                 "variable_template_id": experiment_inventory_field.id,
                 "protocol_condition_id": condition_id,
                 "resource_item_id": resource_item_id,
-                "value": amount,
+                "value": str(amount) if amount is not UNSPECIFIED else UNSPECIFIED,
             }
-            conditionInventoryField = entityRepository.newEntity(experiment_inventory_field.__user__, ExperimentInventoryField, params)
+            conditionInventoryField = entityRepository.newEntity(
+                experiment_inventory_field.__user__, ExperimentInventoryField, params
+            )
 
-        return conditionInventoryField.edit(amount=amount, resource_item_id=resource_item_id)
+        return conditionInventoryField.edit(
+            amount=amount, resource_item_id=resource_item_id
+        )
 
-    return experiment_inventory_field.edit(amount=amount, resource_item_id=resource_item_id)
+    return experiment_inventory_field.edit(
+        amount=amount, resource_item_id=resource_item_id
+    )