labkey 3.4.0__py3-none-any.whl → 4.0.0__py3-none-any.whl

labkey/__init__.py

@@ -14,6 +14,6 @@
 # limitations under the License.
 #
 __title__ = "labkey"
-__version__ = "3.4.0"
+__version__ = "4.0.0"
 __author__ = "LabKey"
 __license__ = "Apache License 2.0"

labkey/domain.py

@@ -48,6 +48,9 @@ class PropertyDescriptor:
         self.default_value_type = kwargs.pop(
             "default_value_type", kwargs.pop("defaultValueType", None)
         )
+        self.derivation_data_scope = kwargs.pop(
+            "derivation_data_scope", kwargs.pop("derivationDataScope", None)
+        )
         self.description = kwargs.pop("description", None)
         self.dimension = kwargs.pop("dimension", None)
         self.disable_editing = kwargs.pop("disable_editing", kwargs.pop("disableEditing", None))
@@ -120,6 +123,7 @@ class PropertyDescriptor:
             "defaultScale": self.default_scale,
             "defaultValue": self.default_value,
             "defaultValueType": self.default_value_type,
+            "derivationDataScope": self.derivation_data_scope,
             "description": self.description,
             "dimension": self.dimension,
             "disableEditing": self.disable_editing,

labkey/query.py

@@ -15,15 +15,15 @@
 #
 """
 ############################################################################
-NAME: 
-LabKey Query API 
+NAME:
+LabKey Query API
 
-SUMMARY:  
+SUMMARY:
 This module provides functions for interacting with data on a LabKey Server.
 
 DESCRIPTION:
-This module is designed to simplify querying and manipulating data in LabKey Server.  
-Its APIs are modeled after the LabKey Server JavaScript APIs of the same names. 
+This module is designed to simplify querying and manipulating data in LabKey Server.
+Its APIs are modeled after the LabKey Server JavaScript APIs of the same names.
 
 Installation and Setup for the LabKey Python API:
 https://github.com/LabKey/labkey-api-python/blob/master/README.md
@@ -41,7 +41,7 @@ https://www.labkey.org/home/developer/forum/project-start.view
 ############################################################################
 """
 import functools
-from typing import List, TextIO
+from typing import List, Literal, NotRequired, TextIO, TypedDict
 
 from .server_context import ServerContext
 from .utils import waf_encode
@@ -196,7 +196,7 @@ def delete_rows(
     :param transacted: whether all of the updates should be done in a single transaction
     :param audit_behavior: used to override the audit behavior for the update. See class query.AuditBehavior
     :param audit_user_comment: used to provide a comment that will be attached to certain detailed audit log records
-    :param timeout: timeout of request in seconds (defaults to 30s)
+    :param timeout: timeout of request in seconds (defaults to 300s)
     :return:
     """
     url = server_context.build_url("query", "deleteRows.api", container_path=container_path)
@@ -232,7 +232,7 @@ def truncate_table(
     :param schema_name: schema of table
     :param query_name: table name to delete from
     :param container_path: labkey container path if not already set in context
-    :param timeout: timeout of request in seconds (defaults to 30s)
+    :param timeout: timeout of request in seconds (defaults to 300s)
     :return:
     """
     url = server_context.build_url("query", "truncateTable.api", container_path=container_path)
@@ -275,7 +275,7 @@ def execute_sql(
     :param save_in_session: save query result as a named view to the session
     :param parameters: parameter values to pass through to a parameterized query
     :param required_version: Api version of response
-    :param timeout: timeout of request in seconds (defaults to 30s)
+    :param timeout: timeout of request in seconds (defaults to 300s)
     :param waf_encode_sql: WAF encode sql in request (defaults to True)
     :return:
     """
@@ -331,7 +331,7 @@ def insert_rows(
     :param transacted: whether all of the updates should be done in a single transaction
     :param audit_behavior: used to override the audit behavior for the update. See class query.AuditBehavior
     :param audit_user_comment: used to provide a comment that will be attached to certain detailed audit log records
-    :param timeout: timeout of request in seconds (defaults to 30s)
+    :param timeout: timeout of request in seconds (defaults to 300s)
     :return:
     """
     url = server_context.build_url("query", "insertRows.api", container_path=container_path)
@@ -407,6 +407,93 @@ def import_rows(
     return server_context.make_request(url, payload, method="POST", file_payload=file_payload)
 
 
+class Command(TypedDict):
+    """
+    TypedDict representing a command for saveRows API.
+    """
+
+    audit_behavior: NotRequired[AuditBehavior]
+    audit_user_comment: NotRequired[str]
+    command: Literal["insert", "update", "delete"]
+    container_path: NotRequired[str]
+    extra_context: NotRequired[dict]
+    query_name: str
+    rows: List[any]
+    schema_name: str
+    skip_reselect_rows: NotRequired[bool]
+
+
+def save_rows(
+    server_context: ServerContext,
+    commands: List[Command],
+    api_version: float = None,
+    container_path: str = None,
+    extra_context: dict = None,
+    timeout: int = _default_timeout,
+    transacted: bool = None,
+    validate_only: bool = None,
+):
+    """
+    Save inserts, updates, and/or deletes to potentially multiple tables with a single request.
+    :param server_context: A LabKey server context. See utils.create_server_context.
+    :param commands: A List of the update/insert/delete operations to be performed.
+    :param api_version: decimal value that indicates the response version of the api. If this is 13.2 or higher, a
+    request that fails validation will be returned as a successful response. Use the 'errorCount' and 'committed'
+    properties in the response to tell if it committed or not.
+    :param container_path: folder path if not already part of server_context
+    :param extra_context: Extra context object passed into the transformation/validation script environment.
+    :param timeout: Request timeout in seconds (defaults to 300s)
+    :param transacted: Whether all the commands should be done in a single transaction, so they all succeed or all
+    fail. Defaults to true.
+    :param validate_only: Whether the server should attempt to proceed through all the commands but not commit them to
+    the database. Useful for scenarios like giving incremental validation feedback as a user fills out a UI form but
+    does not save anything until they explicitly request a save.
+    """
+    url = server_context.build_url("query", "saveRows.api", container_path=container_path)
+
+    json_commands = []
+    for command in commands:
+        json_command = {
+            "command": command["command"],
+            "queryName": command["query_name"],
+            "schemaName": command["schema_name"],
+            "rows": command["rows"],
+        }
+
+        if command.get("audit_behavior") is not None:
+            json_command["auditBehavior"] = command["audit_behavior"]
+
+        if command.get("audit_user_comment") is not None:
+            json_command["auditUserComment"] = command["audit_user_comment"]
+
+        if command.get("container_path") is not None:
+            json_command["containerPath"] = command["container_path"]
+
+        if command.get("extra_context") is not None:
+            json_command["extraContext"] = command["extra_context"]
+
+        if command.get("skip_reselect_rows") is not None:
+            json_command["skipReselectRows"] = command["skip_reselect_rows"]
+
+        json_commands.append(json_command)
+
+    payload = {"commands": json_commands}
+
+    if api_version is not None:
+        payload["apiVersion"] = api_version
+
+    if extra_context is not None:
+        payload["extraContext"] = extra_context
+
+    if transacted is not None:
+        payload["transacted"] = transacted
+
+    if validate_only is not None:
+        payload["validateOnly"] = validate_only
+
+    return server_context.make_request(url, json=payload, timeout=timeout)
+
+
 def select_rows(
     server_context: ServerContext,
     schema_name: str,
@@ -450,7 +537,7 @@ def select_rows(
     :param include_update_column: Boolean value that indicates whether to include an Update link column in results
     :param selection_key:
     :param required_version: decimal value that indicates the response version of the api
-    :param timeout: Request timeout in seconds (defaults to 30s)
+    :param timeout: Request timeout in seconds (defaults to 300s)
     :param ignore_filter: Boolean, if true, the command will ignore any filter that may be part of the chosen view.
     :return:
     """
@@ -534,7 +621,7 @@ def update_rows(
     :param transacted: whether all of the updates should be done in a single transaction
     :param audit_behavior: used to override the audit behavior for the update. See class query.AuditBehavior
     :param audit_user_comment: used to provide a comment that will be attached to certain detailed audit log records
-    :param timeout: timeout of request in seconds (defaults to 30s)
+    :param timeout: timeout of request in seconds (defaults to 300s)
     :return:
     """
     url = server_context.build_url("query", "updateRows.api", container_path=container_path)
@@ -580,7 +667,7 @@ def move_rows(
     :param transacted: whether all of the updates should be done in a single transaction
     :param audit_behavior: used to override the audit behavior for the update. See class query.AuditBehavior
     :param audit_user_comment: used to provide a comment that will be attached to certain detailed audit log records
-    :param timeout: timeout of request in seconds (defaults to 30s)
+    :param timeout: timeout of request in seconds (defaults to 300s)
     :return:
     """
     url = server_context.build_url("query", "moveRows.api", container_path=container_path)
@@ -726,6 +813,28 @@ class QueryWrapper:
             import_lookup_by_alternate_key,
         )
 
+    @functools.wraps(save_rows)
+    def save_rows(
+        self,
+        commands: List[Command],
+        api_version: float = None,
+        container_path: str = None,
+        extra_context: dict = None,
+        timeout: int = _default_timeout,
+        transacted: bool = None,
+        validate_only: bool = None,
+    ):
+        return save_rows(
+            self.server_context,
+            commands,
+            api_version,
+            container_path,
+            extra_context,
+            timeout,
+            transacted,
+            validate_only,
+        )
+
     @functools.wraps(select_rows)
     def select_rows(
         self,

{labkey-3.4.0.dist-info → labkey-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labkey
-Version: 3.4.0
+Version: 4.0.0
 Summary: Python client API for LabKey Server
 Home-page: https://github.com/LabKey/labkey-api-python
 Author: LabKey
@@ -19,6 +19,7 @@ Classifier: Operating System :: Microsoft
 Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
 License-File: LICENSE.txt
 Requires-Dist: requests
 Provides-Extra: test
@@ -37,6 +38,7 @@ Requires-Dist: setuptools; extra == "build"
 Requires-Dist: build; extra == "build"
 Requires-Dist: twine; extra == "build"
 Requires-Dist: wheel; extra == "build"
+Requires-Dist: packaging; extra == "build"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -49,6 +51,7 @@ Dynamic: maintainer
 Dynamic: maintainer-email
 Dynamic: provides-extra
 Dynamic: requires-dist
+Dynamic: requires-python
 Dynamic: summary
 
 Python client API for LabKey Server. Supports query and experiment APIs.

{labkey-3.4.0.dist-info → labkey-4.0.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
-labkey/__init__.py,sha256=dM58BofELTYOYGq-HlslSKn1Vqqi2wIc_hH-L6Miu6s,695
+labkey/__init__.py,sha256=T4v8wZcrOlithsBeKo-Bz0QDkEGNeKqYuz2cT2lhkRA,695
 labkey/api_wrapper.py,sha256=OxnV6_5jONWiwsi24TOXTKP5inXtAfABGqXAPua3eCM,1427
 labkey/container.py,sha256=DXmLhGsNnN_QLXa_tMCM0Xf_Kkz7B8KjRFhJT5I4FtY,5497
-labkey/domain.py,sha256=HpZ2zz1lqJcet4np_cCq06LfrCJsBClsPvSsCTKAj9M,22829
+labkey/domain.py,sha256=WVkmtWNsQMe5wKV5cToc7ph1oLbrAOf5iiHtL9_qo8s,23028
 labkey/exceptions.py,sha256=00x-4oP_2d0SfZKxsGIs8QGvXiNq2y7C5hAzuzT3Gkk,3619
 labkey/experiment.py,sha256=6U4BXnYHNXCUF_mee0maK_CZDVm_lbMjC82ywx9YCTE,12062
-labkey/query.py,sha256=zQH7qO2UH8aSHLa8GhEklNvEb6fj2cjdB3AI4Q4m2n8,27133
+labkey/query.py,sha256=dlVlmRZEDX5YZW7az4NOLIBpOyVn48M8EMe2IaXGIX0,31176
 labkey/security.py,sha256=wX_4qQkllh-y7U4cqYIxs89XHGUtbC5cCebBKbgl0Y8,15417
 labkey/server_context.py,sha256=pM8GtVu403mD8DQ3yz5mpC-DMUq-ZWPA-JzEHTRIJhA,7871
 labkey/storage.py,sha256=WpgpTWQzgig_qJXMGszFcFjtf8oMd2-6TBehSkpJPUg,6144
 labkey/utils.py,sha256=oL6qmHkpzLTm_9c7gSEzumv_MVh5s8fj6bOrbuslrV0,3233
-labkey-3.4.0.dist-info/licenses/LICENSE.txt,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
-labkey-3.4.0.dist-info/METADATA,sha256=ylw_5Z7GEKb-di9tDYJHO2aQEQ8mhajp2tpzEFN4hLQ,1733
-labkey-3.4.0.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-labkey-3.4.0.dist-info/top_level.txt,sha256=DQIk1fQNg7NxxBsEt_K7k-aopiH87jmnU98zwDp0n04,7
-labkey-3.4.0.dist-info/RECORD,,
+labkey-4.0.0.dist-info/licenses/LICENSE.txt,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
+labkey-4.0.0.dist-info/METADATA,sha256=zM_7ByQficZ-sE_kmXjm8hR4hDS8YLGb4TWqPY9yxYo,1825
+labkey-4.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+labkey-4.0.0.dist-info/top_level.txt,sha256=DQIk1fQNg7NxxBsEt_K7k-aopiH87jmnU98zwDp0n04,7
+labkey-4.0.0.dist-info/RECORD,,

{labkey-3.4.0.dist-info → labkey-4.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any