labkey 3.0.0__tar.gz → 3.1.0__tar.gz

{labkey-3.0.0 → labkey-3.1.0}/CHANGE.txt

@@ -2,6 +2,17 @@
 LabKey Python Client API News
 +++++++++++
 
+What's New in the LabKey 3.1.0 package
+==============================
+
+*Release date: 04/03/2024*
+- ServerContext
+    - Add allow_redirects flag (defaults to False) to constructor
+    - Add allow_redirects flag to make_request
+- APIWrapper: Add allow_redirects flag (defaults to False)
+- Add UnexpectedRedirectError
+    - thrown when allow_redirects is False and the server issues a redirect
+
 What's New in the LabKey 3.0.0 package
 ==============================
 

{labkey-3.0.0/labkey.egg-info → labkey-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labkey
-Version: 3.0.0
+Version: 3.1.0
 Summary: Python client API for LabKey Server
 Home-page: https://github.com/LabKey/labkey-api-python
 Author: LabKey

{labkey-3.0.0 → labkey-3.1.0}/labkey/__init__.py

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

{labkey-3.0.0 → labkey-3.1.0}/labkey/api_wrapper.py

@@ -22,6 +22,7 @@ class APIWrapper:
         verify_ssl=True,
         api_key=None,
         disable_csrf=False,
+        allow_redirects=False,
     ):
         self.server_context = ServerContext(
             domain=domain,
@@ -31,6 +32,7 @@ class APIWrapper:
             verify_ssl=verify_ssl,
             api_key=api_key,
             disable_csrf=disable_csrf,
+            allow_redirects=allow_redirects,
         )
         self.container = ContainerWrapper(self.server_context)
         self.domain = DomainWrapper(self.server_context)

{labkey-3.0.0 → labkey-3.1.0}/labkey/exceptions.py

@@ -47,7 +47,22 @@ class RequestError(exceptions.RequestException):
             self.message = "No response received"
 
     def __str__(self):
-        return repr(self.message)
+        return str(self.message)
+
+
+class UnexpectedRedirectError(RequestError):
+    default_msg = "Unexpected redirect occurred"
+
+    def __init__(self, server_response, **kwargs):
+        super().__init__(server_response, **kwargs)
+
+        location = server_response.headers.get("Location", "")
+
+        # If the server is redirecting from http to https the user probably has a misconfigured ServerContext with use_ssl=False
+        if server_response.url.startswith("http://") and location.startswith("https://"):
+            self.message = "Redirected from http to https, set use_ssl=True in your APIWrapper or ServerContext"
+        elif location != "":
+            self.message = f"Unexpected redirect to: {location}"
 
 
 class QueryNotFoundError(RequestError):

{labkey-3.0.0 → labkey-3.1.0}/labkey/query.py

@@ -258,7 +258,7 @@ def execute_sql(
     parameters: dict = None,
     required_version: float = None,
     timeout: int = _default_timeout,
-    waf_encode_sql: bool = True
+    waf_encode_sql: bool = True,
 ):
     """
     Execute sql query against a LabKey server.
@@ -535,7 +535,12 @@ def move_rows(
     """
     url = server_context.build_url("query", "moveRows.api", container_path=container_path)
 
-    payload = {"targetContainerPath": target_container_path, "schemaName": schema_name, "queryName": query_name, "rows": rows}
+    payload = {
+        "targetContainerPath": target_container_path,
+        "schemaName": schema_name,
+        "queryName": query_name,
+        "rows": rows,
+    }
 
     if transacted is False:
         payload["transacted"] = transacted
@@ -582,7 +587,7 @@ class QueryWrapper:
             transacted,
             audit_behavior,
             audit_user_comment,
-            timeout
+            timeout,
         )
 
     @functools.wraps(truncate_table)
@@ -605,7 +610,7 @@ class QueryWrapper:
         parameters: dict = None,
         required_version: float = None,
         timeout: int = _default_timeout,
-        waf_encode_sql: bool = True
+        waf_encode_sql: bool = True,
     ):
         return execute_sql(
             self.server_context,
@@ -620,7 +625,7 @@ class QueryWrapper:
             parameters,
             required_version,
             timeout,
-            waf_encode_sql
+            waf_encode_sql,
         )
 
     @functools.wraps(insert_rows)
@@ -646,7 +651,7 @@ class QueryWrapper:
             transacted,
             audit_behavior,
             audit_user_comment,
-            timeout
+            timeout,
         )
 
     @functools.wraps(select_rows)
@@ -716,7 +721,7 @@ class QueryWrapper:
             transacted,
             audit_behavior,
             audit_user_comment,
-            timeout
+            timeout,
         )
 
     @functools.wraps(move_rows)
@@ -742,5 +747,5 @@ class QueryWrapper:
             transacted,
             audit_behavior,
             audit_user_comment,
-            timeout
+            timeout,
         )

{labkey-3.0.0 → labkey-3.1.0}/labkey/security.py

@@ -279,7 +279,7 @@ def stop_impersonating(server_context: ServerContext):
     Stop impersonating a user while keeping the original user logged in.
     """
     url = server_context.build_url(LOGIN_CONTROLLER, "stopImpersonating.api")
-    return server_context.make_request(url)
+    return server_context.make_request(url, allow_redirects=True)
 
 
 @dataclass

{labkey-3.0.0 → labkey-3.1.0}/labkey/server_context.py

@@ -8,6 +8,7 @@ from labkey.exceptions import (
     QueryNotFoundError,
     ServerContextError,
     ServerNotFoundError,
+    UnexpectedRedirectError,
 )
 
 API_KEY_TOKEN = "apikey"
@@ -29,7 +30,8 @@ def handle_response(response, non_json_response=False):
                 content=response.content,
             )
             return result
-
+    elif sc == 302:
+        raise UnexpectedRedirectError(response)
     elif sc == 401:
         raise RequestAuthorizationError(response)
     elif sc == 404:
@@ -62,6 +64,7 @@ class ServerContext:
         verify_ssl=True,
         api_key=None,
         disable_csrf=False,
+        allow_redirects=False,
     ):
         self._container_path = container_path
         self._context_path = context_path
@@ -70,6 +73,7 @@ class ServerContext:
         self._verify_ssl = verify_ssl
         self._api_key = api_key
         self._disable_csrf = disable_csrf
+        self.allow_redirects = allow_redirects
         self._session = requests.Session()
         self._session.headers.update({"User-Agent": f"LabKey Python API/{__version__}"})
 
@@ -174,7 +178,9 @@ class ServerContext:
         non_json_response: bool = False,
         file_payload: any = None,
         json: dict = None,
+        allow_redirects=False,
     ) -> any:
+        allow_redirects_ = allow_redirects or self.allow_redirects
         if self._api_key is not None:
             if self._session.headers.get(API_KEY_TOKEN) is not self._api_key:
                 self._session.headers.update({API_KEY_TOKEN: self._api_key})
@@ -189,7 +195,13 @@ class ServerContext:
 
         try:
             if method == "GET":
-                response = self._session.get(url, params=payload, headers=headers, timeout=timeout)
+                response = self._session.get(
+                    url,
+                    params=payload,
+                    headers=headers,
+                    timeout=timeout,
+                    allow_redirects=allow_redirects_,
+                )
             else:
                 if file_payload is not None:
                     response = self._session.post(
@@ -198,6 +210,7 @@ class ServerContext:
                         files=file_payload,
                         headers=headers,
                         timeout=timeout,
+                        allow_redirects=allow_redirects_,
                     )
                 elif json is not None:
                     if headers is None:
@@ -206,10 +219,20 @@ class ServerContext:
                     headers_ = {**headers, "Content-Type": "application/json"}
                     # sort_keys is a hack to make unit tests work
                     data = json_dumps(json, sort_keys=True)
-                    response = self._session.post(url, data=data, headers=headers_, timeout=timeout)
+                    response = self._session.post(
+                        url,
+                        data=data,
+                        headers=headers_,
+                        timeout=timeout,
+                        allow_redirects=allow_redirects_,
+                    )
                 else:
                     response = self._session.post(
-                        url, data=payload, headers=headers, timeout=timeout
+                        url,
+                        data=payload,
+                        headers=headers,
+                        timeout=timeout,
+                        allow_redirects=allow_redirects_,
                     )
             return handle_response(response, non_json_response)
         except RequestException as e:

{labkey-3.0.0 → labkey-3.1.0/labkey.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labkey
-Version: 3.0.0
+Version: 3.1.0
 Summary: Python client API for LabKey Server
 Home-page: https://github.com/LabKey/labkey-api-python
 Author: LabKey