Merge pull request #19 from tuneinsight/release-v1.3.0

v1.3.0 release

Author: fhoussiau

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tuneinsight
-Version: 1.2.3
+Version: 1.3.0
 Summary: Official Python SDK for the Tune Insight API. The current version is compatible with the same version of the API.
 License: Apache-2.0
 Author: Tune Insight SA
@@ -22,7 +22,7 @@ Requires-Dist: ipython (==8.18.1)
 Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
 Requires-Dist: jupyter (>=1.1.1,<2.0.0) ; extra == "full"
 Requires-Dist: jupyter-client (>=8.6.3,<9.0.0) ; extra == "full"
-Requires-Dist: jupyterlab (>=4.3.6,<5.0.0) ; extra == "full"
+Requires-Dist: jupyterlab (>=4.4.8,<5.0.0) ; extra == "full"
 Requires-Dist: matplotlib (>=3.5.0,<4.0.0)
 Requires-Dist: notebook (>=7.3.3,<8.0.0) ; extra == "full"
 Requires-Dist: pandas (>=2.2.3,<3.0.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tuneinsight"
-version = "1.2.3"  # Ignored.
+version = "1.3.0"  # Ignored.
 description = "Official Python SDK for the Tune Insight API. The current version is compatible with the same version of the API."
 authors = ["Tune Insight SA"]
 license = "Apache-2.0"
@@ -46,7 +46,7 @@ cryptography = "^44.0.1"
 # Extras for the "full" install (somewhat heavy packages).
 notebook = { version = "^7.3.3", optional = true}
 jupyter = { version = "^1.1.1", optional = true}
-jupyterlab = { version = "^4.3.6", optional = true}
+jupyterlab = { version = "^4.4.8", optional = true}
 tornado = { version = "^6.5.0", optional = true}
 jupyter-client = { version = "^8.6.3", optional = true}
 

src/tuneinsight/api/api-checksum

@@ -1 +1 @@
-0dd37e1807bf51ece84bc941f8c7521fd124ef5f3384bcba294809ac098ecaa1
+45ef3a4d2aed31f445016f57fd45409cd6b70cf9d8d4a2520e336b5573fee9a3

src/tuneinsight/api/sdk/models/__init__.py

@@ -186,6 +186,8 @@
 from .get_query_list_sort_by import GetQueryListSortBy
 from .get_result_list_order import GetResultListOrder
 from .get_result_list_sort_by import GetResultListSortBy
+from .get_translated_query_command import GetTranslatedQueryCommand
+from .get_translated_query_command_result import GetTranslatedQueryCommandResult
 from .get_user_preference_key import GetUserPreferenceKey
 from .group_by_type import GroupByType
 from .group_info import GroupInfo
@@ -276,6 +278,7 @@
 from .privacy_summary_computation import PrivacySummaryComputation
 from .privacy_warning import PrivacyWarning
 from .privacy_warning_severity import PrivacyWarningSeverity
+from .privacy_warning_type import PrivacyWarningType
 from .private_search import PrivateSearch
 from .private_search_database import PrivateSearchDatabase
 from .private_search_query import PrivateSearchQuery
@@ -298,6 +301,7 @@
 from .quantiles import Quantiles
 from .query import Query
 from .query_bookmark_definition import QueryBookmarkDefinition
+from .query_output_variable import QueryOutputVariable
 from .query_status import QueryStatus
 from .realm_role import RealmRole
 from .regression_type import RegressionType
@@ -568,6 +572,8 @@
     "GetQueryListSortBy",
     "GetResultListOrder",
     "GetResultListSortBy",
+    "GetTranslatedQueryCommand",
+    "GetTranslatedQueryCommandResult",
     "GetUserPreferenceKey",
     "GroupByType",
     "GroupInfo",
@@ -658,6 +664,7 @@
     "PrivacySummaryComputation",
     "PrivacyWarning",
     "PrivacyWarningSeverity",
+    "PrivacyWarningType",
     "PrivateSearch",
     "PrivateSearchDatabase",
     "PrivateSearchQuery",
@@ -680,6 +687,7 @@
     "Quantiles",
     "Query",
     "QueryBookmarkDefinition",
+    "QueryOutputVariable",
     "QueryStatus",
     "RealmRole",
     "RegressionType",

src/tuneinsight/api/sdk/models/aggregated_dataset_length.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union, cast
 
 import attr
 
@@ -47,6 +47,8 @@ class AggregatedDatasetLength:
             ...}
         local_input_id (Union[Unset, str]): Unique identifier of a data object.
         owner (Union[Unset, str]): The username of the end user who requested the computation.
+        participants (Union[Unset, List[str]]): list of preferred participants (using their alias) to run the
+            computation with.
         precision (Union[Unset, None, int]): optional minimum required bit precision to guarantee when aggregating
             results.
             If the precision is set to `x`, then the user can expect the results error to be bounded by `2^(-x)`
@@ -92,6 +94,7 @@ class AggregatedDatasetLength:
     local_input: Union[Unset, "LocalInput"] = UNSET
     local_input_id: Union[Unset, str] = UNSET
     owner: Union[Unset, str] = UNSET
+    participants: Union[Unset, List[str]] = UNSET
     precision: Union[Unset, None, int] = UNSET
     preprocessing_parameters: Union[Unset, "ComputationPreprocessingParameters"] = UNSET
     project_id: Union[Unset, str] = UNSET
@@ -133,6 +136,10 @@ def to_dict(self) -> Dict[str, Any]:
 
         local_input_id = self.local_input_id
         owner = self.owner
+        participants: Union[Unset, List[str]] = UNSET
+        if not isinstance(self.participants, Unset):
+            participants = self.participants
+
         precision = self.precision
         preprocessing_parameters: Union[Unset, Dict[str, Any]] = UNSET
         if not isinstance(self.preprocessing_parameters, Unset):
@@ -191,6 +198,8 @@ def to_dict(self) -> Dict[str, Any]:
             field_dict["localInputID"] = local_input_id
         if owner is not UNSET:
             field_dict["owner"] = owner
+        if participants is not UNSET:
+            field_dict["participants"] = participants
         if precision is not UNSET:
             field_dict["precision"] = precision
         if preprocessing_parameters is not UNSET:
@@ -273,6 +282,8 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
         owner = d.pop("owner", UNSET)
 
+        participants = cast(List[str], d.pop("participants", UNSET))
+
         precision = d.pop("precision", UNSET)
 
         _preprocessing_parameters = d.pop("preprocessingParameters", UNSET)
@@ -325,6 +336,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
             local_input=local_input,
             local_input_id=local_input_id,
             owner=owner,
+            participants=participants,
             precision=precision,
             preprocessing_parameters=preprocessing_parameters,
             project_id=project_id,

src/tuneinsight/api/sdk/models/collective_key_switch.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union, cast
 
 import attr
 
@@ -48,6 +48,8 @@ class CollectiveKeySwitch:
             ...}
         local_input_id (Union[Unset, str]): Unique identifier of a data object.
         owner (Union[Unset, str]): The username of the end user who requested the computation.
+        participants (Union[Unset, List[str]]): list of preferred participants (using their alias) to run the
+            computation with.
         precision (Union[Unset, None, int]): optional minimum required bit precision to guarantee when aggregating
             results.
             If the precision is set to `x`, then the user can expect the results error to be bounded by `2^(-x)`
@@ -95,6 +97,7 @@ class CollectiveKeySwitch:
     local_input: Union[Unset, "LocalInput"] = UNSET
     local_input_id: Union[Unset, str] = UNSET
     owner: Union[Unset, str] = UNSET
+    participants: Union[Unset, List[str]] = UNSET
     precision: Union[Unset, None, int] = UNSET
     preprocessing_parameters: Union[Unset, "ComputationPreprocessingParameters"] = UNSET
     project_id: Union[Unset, str] = UNSET
@@ -138,6 +141,10 @@ def to_dict(self) -> Dict[str, Any]:
 
         local_input_id = self.local_input_id
         owner = self.owner
+        participants: Union[Unset, List[str]] = UNSET
+        if not isinstance(self.participants, Unset):
+            participants = self.participants
+
         precision = self.precision
         preprocessing_parameters: Union[Unset, Dict[str, Any]] = UNSET
         if not isinstance(self.preprocessing_parameters, Unset):
@@ -198,6 +205,8 @@ def to_dict(self) -> Dict[str, Any]:
             field_dict["localInputID"] = local_input_id
         if owner is not UNSET:
             field_dict["owner"] = owner
+        if participants is not UNSET:
+            field_dict["participants"] = participants
         if precision is not UNSET:
             field_dict["precision"] = precision
         if preprocessing_parameters is not UNSET:
@@ -284,6 +293,8 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
         owner = d.pop("owner", UNSET)
 
+        participants = cast(List[str], d.pop("participants", UNSET))
+
         precision = d.pop("precision", UNSET)
 
         _preprocessing_parameters = d.pop("preprocessingParameters", UNSET)
@@ -339,6 +350,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
             local_input=local_input,
             local_input_id=local_input_id,
             owner=owner,
+            participants=participants,
             precision=precision,
             preprocessing_parameters=preprocessing_parameters,
             project_id=project_id,

src/tuneinsight/api/sdk/models/computation_definition.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union, cast
 
 import attr
 
@@ -48,6 +48,8 @@ class ComputationDefinition:
             ...}
         local_input_id (Union[Unset, str]): Unique identifier of a data object.
         owner (Union[Unset, str]): The username of the end user who requested the computation.
+        participants (Union[Unset, List[str]]): list of preferred participants (using their alias) to run the
+            computation with.
         precision (Union[Unset, None, int]): optional minimum required bit precision to guarantee when aggregating
             results.
             If the precision is set to `x`, then the user can expect the results error to be bounded by `2^(-x)`
@@ -92,6 +94,7 @@ class ComputationDefinition:
     local_input: Union[Unset, "LocalInput"] = UNSET
     local_input_id: Union[Unset, str] = UNSET
     owner: Union[Unset, str] = UNSET
+    participants: Union[Unset, List[str]] = UNSET
     precision: Union[Unset, None, int] = UNSET
     preprocessing_parameters: Union[Unset, "ComputationPreprocessingParameters"] = UNSET
     project_id: Union[Unset, str] = UNSET
@@ -132,6 +135,10 @@ def to_dict(self) -> Dict[str, Any]:
 
         local_input_id = self.local_input_id
         owner = self.owner
+        participants: Union[Unset, List[str]] = UNSET
+        if not isinstance(self.participants, Unset):
+            participants = self.participants
+
         precision = self.precision
         preprocessing_parameters: Union[Unset, Dict[str, Any]] = UNSET
         if not isinstance(self.preprocessing_parameters, Unset):
@@ -189,6 +196,8 @@ def to_dict(self) -> Dict[str, Any]:
             field_dict["localInputID"] = local_input_id
         if owner is not UNSET:
             field_dict["owner"] = owner
+        if participants is not UNSET:
+            field_dict["participants"] = participants
         if precision is not UNSET:
             field_dict["precision"] = precision
         if preprocessing_parameters is not UNSET:
@@ -269,6 +278,8 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
         owner = d.pop("owner", UNSET)
 
+        participants = cast(List[str], d.pop("participants", UNSET))
+
         precision = d.pop("precision", UNSET)
 
         _preprocessing_parameters = d.pop("preprocessingParameters", UNSET)
@@ -319,6 +330,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
             local_input=local_input,
             local_input_id=local_input_id,
             owner=owner,
+            participants=participants,
             precision=precision,
             preprocessing_parameters=preprocessing_parameters,
             project_id=project_id,

src/tuneinsight/api/sdk/models/cross_standard_query.py

@@ -6,6 +6,7 @@
 
 if TYPE_CHECKING:
     from ..models.advanced_filter import AdvancedFilter
+    from ..models.query_output_variable import QueryOutputVariable
 
 
 T = TypeVar("T", bound="CrossStandardQuery")
@@ -24,13 +25,17 @@ class CrossStandardQuery:
 
         Attributes:
             filter_ (Union[Unset, AdvancedFilter]): Abstract subclass of a filter for cross-standard queries.
-            variables (Union[Unset, List[str]]): The variables to be extracted from the cohort. Each variable should either
-                be the name
+            output_variables (Union[Unset, List['QueryOutputVariable']]): The variables to be extracted from the cohort.
+                Each variable should either be the name
                 of a feature (directly attached to a record), or a unique identifier defined in a filter
                 for series variables (variables attached to a record that contain a list of values).
+            unit (Union[Unset, str]): The unit of the feasibility query (i.e., what is a record -- should be "patient").
+            variables (Union[Unset, List[str]]): Legacy version of the above output variables
     """
 
     filter_: Union[Unset, "AdvancedFilter"] = UNSET
+    output_variables: Union[Unset, List["QueryOutputVariable"]] = UNSET
+    unit: Union[Unset, str] = UNSET
     variables: Union[Unset, List[str]] = UNSET
     additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
 
@@ -39,6 +44,15 @@ def to_dict(self) -> Dict[str, Any]:
         if not isinstance(self.filter_, Unset):
             filter_ = self.filter_.to_dict()
 
+        output_variables: Union[Unset, List[Dict[str, Any]]] = UNSET
+        if not isinstance(self.output_variables, Unset):
+            output_variables = []
+            for output_variables_item_data in self.output_variables:
+                output_variables_item = output_variables_item_data.to_dict()
+
+                output_variables.append(output_variables_item)
+
+        unit = self.unit
         variables: Union[Unset, List[str]] = UNSET
         if not isinstance(self.variables, Unset):
             variables = self.variables
@@ -48,6 +62,10 @@ def to_dict(self) -> Dict[str, Any]:
         field_dict.update({})
         if filter_ is not UNSET:
             field_dict["filter"] = filter_
+        if output_variables is not UNSET:
+            field_dict["outputVariables"] = output_variables
+        if unit is not UNSET:
+            field_dict["unit"] = unit
         if variables is not UNSET:
             field_dict["variables"] = variables
 
@@ -56,6 +74,7 @@ def to_dict(self) -> Dict[str, Any]:
     @classmethod
     def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         from ..models.advanced_filter import AdvancedFilter
+        from ..models.query_output_variable import QueryOutputVariable
 
         d = src_dict.copy()
         _filter_ = d.pop("filter", UNSET)
@@ -65,10 +84,21 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         else:
             filter_ = AdvancedFilter.from_dict(_filter_)
 
+        output_variables = []
+        _output_variables = d.pop("outputVariables", UNSET)
+        for output_variables_item_data in _output_variables or []:
+            output_variables_item = QueryOutputVariable.from_dict(output_variables_item_data)
+
+            output_variables.append(output_variables_item)
+
+        unit = d.pop("unit", UNSET)
+
         variables = cast(List[str], d.pop("variables", UNSET))
 
         cross_standard_query = cls(
             filter_=filter_,
+            output_variables=output_variables,
+            unit=unit,
             variables=variables,
         )
 

src/tuneinsight/api/sdk/models/data_schema.py

@@ -16,13 +16,16 @@ class DataSchema:
     """aims to provide a flexible definition of a data schema, which includes the tables and their relationships.
 
     Attributes:
+        name (Union[Unset, str]): optional name for the schema.
         tables (Union[Unset, List['SchemaTable']]):
     """
 
+    name: Union[Unset, str] = UNSET
     tables: Union[Unset, List["SchemaTable"]] = UNSET
     additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
+        name = self.name
         tables: Union[Unset, List[Dict[str, Any]]] = UNSET
         if not isinstance(self.tables, Unset):
             tables = []
@@ -34,6 +37,8 @@ def to_dict(self) -> Dict[str, Any]:
         field_dict: Dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update({})
+        if name is not UNSET:
+            field_dict["name"] = name
         if tables is not UNSET:
             field_dict["tables"] = tables
 
@@ -44,6 +49,8 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         from ..models.schema_table import SchemaTable
 
         d = src_dict.copy()
+        name = d.pop("name", UNSET)
+
         tables = []
         _tables = d.pop("tables", UNSET)
         for tables_item_data in _tables or []:
@@ -52,6 +59,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
             tables.append(tables_item)
 
         data_schema = cls(
+            name=name,
             tables=tables,
         )