lusid-sdk 2.0.50b0__py3-none-any.whl → 2.1.683__py3-none-any.whl

lusid/api_client.py

@@ -155,7 +155,7 @@ class ApiClient:
             files=None, response_types_map=None, auth_settings=None,
             _return_http_data_only=None, collection_formats=None,
             _preload_content=True, _request_timeout=None, _host=None,
-            _request_auth=None):
+            _request_auth=None, opts=None):
 
         config = self.configuration
 
@@ -214,6 +214,8 @@ class ApiClient:
             url += "?" + url_query
 
         try:
+            # if returning http_data_only then we need to deserialise response.
+            _preload_content = True if _return_http_data_only else _preload_content
             # perform request and return response
             response_data = await self.request(
                 method, url,
@@ -221,7 +223,8 @@ class ApiClient:
                 headers=header_params,
                 post_params=post_params, body=body,
                 _preload_content=_preload_content,
-                _request_timeout=_request_timeout)
+                _request_timeout=_request_timeout,
+                opts=opts)
         except ApiException as e:
             if e.body:
                 e.body = e.body.decode('utf-8')
@@ -260,8 +263,8 @@ class ApiClient:
         else:
             return ApiResponse(status_code = response_data.status,
                            data = return_data,
-                           headers = response_data.getheaders(),
-                           raw_data = response_data.data)
+                           headers = response_data.getheaders() if _preload_content else response_data.headers,
+                           raw_data = response_data.data if _preload_content else response_data)
 
     def sanitize_for_serialization(self, obj):
         """Builds a JSON POST object.
@@ -370,7 +373,8 @@ class ApiClient:
                  response_types_map=None, auth_settings=None,
                  async_req=None, _return_http_data_only=None,
                  collection_formats=None, _preload_content=True,
-                 _request_timeout=None, _host=None, _request_auth=None):
+                 _request_timeout=None, _host=None, _request_auth=None,
+                 opts=None):
         """Makes the HTTP request (synchronous) and returns deserialized data.
 
         To make an async_req request, set the async_req parameter.
@@ -397,10 +401,9 @@ class ApiClient:
                                  Default is True.
         :param collection_formats: dict of collection formats for path, query,
             header, and post parameters.
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
+        :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
         :param _request_auth: set to override the auth_settings for an a single
                               request; this effectively ignores the authentication
                               in the spec for a single request.
@@ -419,7 +422,7 @@ class ApiClient:
                                    response_types_map, auth_settings,
                                    _return_http_data_only, collection_formats,
                                    _preload_content, _request_timeout, _host,
-                                   _request_auth)
+                                   _request_auth, opts)
 
         return self.pool.apply_async(self.__call_api, (resource_path,
                                                        method, path_params,
@@ -432,30 +435,34 @@ class ApiClient:
                                                        collection_formats,
                                                        _preload_content,
                                                        _request_timeout,
-                                                       _host, _request_auth))
+                                                       _host, _request_auth,
+                                                       opts))
 
     def request(self, method, url, query_params=None, headers=None,
                 post_params=None, body=None, _preload_content=True,
-                _request_timeout=None):
+                _request_timeout=None, opts=None):
         """Makes the HTTP request using RESTClient."""
         if method == "GET":
             return self.rest_client.get_request(url,
                                         query_params=query_params,
                                         _preload_content=_preload_content,
                                         _request_timeout=_request_timeout,
-                                        headers=headers)
+                                        headers=headers,
+                                        opts=opts)
         elif method == "HEAD":
             return self.rest_client.head_request(url,
                                          query_params=query_params,
                                          _preload_content=_preload_content,
                                          _request_timeout=_request_timeout,
-                                         headers=headers)
+                                         headers=headers,
+                                         opts=opts)
         elif method == "OPTIONS":
             return self.rest_client.options_request(url,
                                             query_params=query_params,
                                             headers=headers,
                                             _preload_content=_preload_content,
-                                            _request_timeout=_request_timeout)
+                                            _request_timeout=_request_timeout,
+                                            opts=opts)
         elif method == "POST":
             return self.rest_client.post_request(url,
                                          query_params=query_params,
@@ -463,7 +470,8 @@ class ApiClient:
                                          post_params=post_params,
                                          _preload_content=_preload_content,
                                          _request_timeout=_request_timeout,
-                                         body=body)
+                                         body=body,
+                                         opts=opts)
         elif method == "PUT":
             return self.rest_client.put_request(url,
                                         query_params=query_params,
@@ -471,7 +479,8 @@ class ApiClient:
                                         post_params=post_params,
                                         _preload_content=_preload_content,
                                         _request_timeout=_request_timeout,
-                                        body=body)
+                                        body=body,
+                                        opts=opts)
         elif method == "PATCH":
             return self.rest_client.patch_request(url,
                                           query_params=query_params,
@@ -479,14 +488,16 @@ class ApiClient:
                                           post_params=post_params,
                                           _preload_content=_preload_content,
                                           _request_timeout=_request_timeout,
-                                          body=body)
+                                          body=body,
+                                          opts=opts)
         elif method == "DELETE":
             return self.rest_client.delete_request(url,
                                            query_params=query_params,
                                            headers=headers,
                                            _preload_content=_preload_content,
                                            _request_timeout=_request_timeout,
-                                           body=body)
+                                           body=body,
+                                           opts=opts)
         else:
             raise ApiValueError(
                 "http method must be `GET`, `HEAD`, `OPTIONS`,"
@@ -544,7 +555,7 @@ class ApiClient:
             if k in collection_formats:
                 collection_format = collection_formats[k]
                 if collection_format == 'multi':
-                    new_params.extend((k, value) for value in v)
+                    new_params.extend((k, quote(str(value))) for value in v)
                 else:
                     if collection_format == 'ssv':
                         delimiter = ' '

lusid/api_response.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 from typing import Any, Dict, Optional
-from pydantic import Field, StrictInt, StrictStr
+from pydantic.v1 import Field, StrictInt, StrictStr
 
 class ApiResponse:
     """

lusid/configuration.py

@@ -26,6 +26,56 @@ JSON_SCHEMA_VALIDATION_KEYWORDS = {
     'minLength', 'pattern', 'maxItems', 'minItems'
 }
 
+class Timeouts:
+
+    @property
+    def total_timeout_ms(self):
+        return self.__total_timeout_ms
+
+    @total_timeout_ms.setter
+    def total_timeout_ms(self, value):
+        if not isinstance(value, int):
+            raise TypeError(f"total_timeout_ms must be type int but type '{type(value)}' used")
+        if value < 0:
+            raise ValueError(f"total_timeout_ms must be an integer greater than or equal to zero")
+        self.__total_timeout_ms = value
+
+    @property
+    def connect_timeout_ms(self):
+        return self.__connect_timeout_ms
+
+    @connect_timeout_ms.setter
+    def connect_timeout_ms(self, value):
+        if not isinstance(value, int):
+            raise TypeError(f"connect_timeout_ms must be type int but type '{type(value)}' used")
+        if value < 0:
+            raise ValueError(f"connect_timeout_ms must be an integer greater than or equal to zero")
+        self.__connect_timeout_ms = value
+
+    @property
+    def read_timeout_ms(self):
+        return self.__read_timeout_ms
+
+    @read_timeout_ms.setter
+    def read_timeout_ms(self, value):
+        if not isinstance(value, int):
+            raise TypeError(f"read_timeout_ms must be type int but type '{type(value)}' used")
+        if value < 0:
+            raise ValueError(f"read_timeout_ms must be an integer greater than or equal to zero")
+        self.__read_timeout_ms = value
+        
+    def __init__(self, total_timeout_ms: int, connect_timeout_ms: int, read_timeout_ms: int):
+        self.total_timeout_ms = total_timeout_ms
+        self.connect_timeout_ms = connect_timeout_ms
+        self.read_timeout_ms = read_timeout_ms
+        
+    def get_default():
+        return Timeouts(
+            total_timeout_ms=Configuration.DEFAULT_TOTAL_TIMEOUT_MS,
+            connect_timeout_ms=Configuration.DEFAULT_CONNECT_TIMEOUT_MS,
+            read_timeout_ms=Configuration.DEFAULT_READ_TIMEOUT_MS
+        )
+        
 class Configuration:
     """This class contains various settings of the API client.
 
@@ -55,6 +105,12 @@ class Configuration:
 
     :Example:
     """
+    
+    DEFAULT_TOTAL_TIMEOUT_MS: int = 1800_000
+    DEFAULT_CONNECT_TIMEOUT_MS: int = 0
+    DEFAULT_READ_TIMEOUT_MS: int = 0
+    DEFAULT_RATE_LIMIT_RETRIES: int = 2
+    DEFAULT_RETRIES: int = 3
 
     _default = None
 
@@ -65,7 +121,11 @@ class Configuration:
                  server_index=None, server_variables=None,
                  server_operation_index=None, server_operation_variables=None,
                  ssl_ca_cert=None,
-                 ) -> None:
+                 timeouts=Timeouts(
+                     total_timeout_ms=DEFAULT_TOTAL_TIMEOUT_MS,
+                     connect_timeout_ms=DEFAULT_CONNECT_TIMEOUT_MS,
+                     read_timeout_ms=DEFAULT_READ_TIMEOUT_MS),
+                 rate_limit_retries=DEFAULT_RATE_LIMIT_RETRIES) -> None:
         """Constructor
         """
         self._base_path = "https://www.lusid.com/api" if host is None else host
@@ -179,6 +239,9 @@ class Configuration:
         self.date_format = "%Y-%m-%d"
         """date format
         """
+        
+        self.timeouts = timeouts
+        self.rate_limit_retries = rate_limit_retries
 
     def __deepcopy__(self, memo):
         cls = self.__class__
@@ -356,12 +419,21 @@ class Configuration:
         """
         auth = {}
         if self.access_token is not None:
-            auth['oauth2'] = {
-                'type': 'oauth2',
-                'in': 'header',
-                'key': 'Authorization',
-                'value': 'Bearer ' + self.access_token
-            }
+
+            if isinstance(self.access_token, str):
+                auth['oauth2'] = {
+                    'type': 'bearer',
+                    'in': 'header',
+                    'key': 'Authorization',
+                    'value': 'Bearer ' + self.access_token
+                }
+            else:
+                auth['oauth2'] = {
+                    'type': 'bearer',
+                    'in': 'header',
+                    'key': 'Authorization',
+                    'value': 'Bearer ' + self.access_token.data
+                }
         return auth
 
     def to_debug_report(self):
@@ -373,7 +445,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.11.6001\n"\
+               "Version of the API: 0.11.7317\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 
@@ -438,3 +510,25 @@ class Configuration:
         """Fix base path."""
         self._base_path = value
         self.server_index = None
+
+    @property
+    def timeouts(self):
+        return self._timeouts
+
+    @timeouts.setter
+    def timeouts(self, value):
+        if not isinstance(value, Timeouts):
+            raise TypeError(f"timeouts must be type Timeouts but type '{type(value)}' used")
+        self._timeouts = value
+
+    @property
+    def rate_limit_retries(self):
+        return self._rate_limit_retries
+
+    @rate_limit_retries.setter
+    def rate_limit_retries(self, value):
+        if not isinstance(value, int):
+            raise TypeError(f"rate_limit_retries must be type int but type '{type(value)}' used")
+        if value < 0:
+            raise ValueError(f"rate_limit_retries must be greater than or equal to zero but was '{value}'")
+        self._rate_limit_retries = value

lusid/extensions/__init__.py

@@ -1,15 +1,20 @@
-from lusid.extensions.api_client_builder import build_client
 from lusid.extensions.api_client_factory import SyncApiClientFactory, ApiClientFactory
 from lusid.extensions.configuration_loaders import (
     ConfigurationLoader,
     SecretsFileConfigurationLoader,
     EnvironmentVariablesConfigurationLoader,
+    FileTokenConfigurationLoader,
     ArgsConfigurationLoader,
-    get_api_configuration,
 )
-from lusid.extensions.api_configuration import ApiConfiguration
-from lusid.extensions.retry import RetryingRestWrapper, RetryingRestWrapperAsync
-from lusid.extensions.proxy_config import ProxyConfig
-from lusid.extensions.refreshing_token import RefreshingToken
 from lusid.extensions.api_client import SyncApiClient
-from lusid.extensions.rest import RESTClientObject
+
+__all__ = [
+    "SyncApiClientFactory",
+    "ApiClientFactory",
+    "ConfigurationLoader",
+    "SecretsFileConfigurationLoader",
+    "EnvironmentVariablesConfigurationLoader",
+    "FileTokenConfigurationLoader",
+    "ArgsConfigurationLoader",
+    "SyncApiClient"
+]

lusid/extensions/api_client.py

@@ -154,7 +154,7 @@ class SyncApiClient:
             files=None, response_types_map=None, auth_settings=None,
             _return_http_data_only=None, collection_formats=None,
             _preload_content=True, _request_timeout=None, _host=None,
-            _request_auth=None):
+            _request_auth=None, opts=None):
 
         config = self.configuration
 
@@ -213,6 +213,8 @@ class SyncApiClient:
             url += "?" + url_query
 
         try:
+            # if returning http_data_only then we need to deserialise response.
+            _preload_content = True if _return_http_data_only else _preload_content
             # perform request and return response
             response_data = self.request(
                 method, url,
@@ -220,7 +222,8 @@ class SyncApiClient:
                 headers=header_params,
                 post_params=post_params, body=body,
                 _preload_content=_preload_content,
-                _request_timeout=_request_timeout)
+                _request_timeout=_request_timeout,
+                opts=opts)
         except ApiException as e:
             if e.body:
                 e.body = e.body.decode('utf-8')
@@ -369,7 +372,8 @@ class SyncApiClient:
                  response_types_map=None, auth_settings=None,
                  async_req=None, _return_http_data_only=None,
                  collection_formats=None, _preload_content=True,
-                 _request_timeout=None, _host=None, _request_auth=None):
+                 _request_timeout=None, _host=None, _request_auth=None,
+                 opts=None):
         """Makes the HTTP request (synchronous) and returns deserialized data.
 
         To make an async_req request, set the async_req parameter.
@@ -396,10 +400,9 @@ class SyncApiClient:
                                  Default is True.
         :param collection_formats: dict of collection formats for path, query,
             header, and post parameters.
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
+        :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
         :param _request_auth: set to override the auth_settings for an a single
                               request; this effectively ignores the authentication
                               in the spec for a single request.
@@ -418,7 +421,7 @@ class SyncApiClient:
                                    response_types_map, auth_settings,
                                    _return_http_data_only, collection_formats,
                                    _preload_content, _request_timeout, _host,
-                                   _request_auth)
+                                   _request_auth, opts)
 
         return self.pool.apply_async(self.__call_api, (resource_path,
                                                        method, path_params,
@@ -431,30 +434,33 @@ class SyncApiClient:
                                                        collection_formats,
                                                        _preload_content,
                                                        _request_timeout,
-                                                       _host, _request_auth))
+                                                       _host, _request_auth, opts))
 
     def request(self, method, url, query_params=None, headers=None,
                 post_params=None, body=None, _preload_content=True,
-                _request_timeout=None):
+                _request_timeout=None, opts=None):
         """Makes the HTTP request using RESTClient."""
         if method == "GET":
             return self.rest_client.get_request(url,
                                         query_params=query_params,
                                         _preload_content=_preload_content,
                                         _request_timeout=_request_timeout,
-                                        headers=headers)
+                                        headers=headers,
+                                        opts=opts)
         elif method == "HEAD":
             return self.rest_client.head_request(url,
                                          query_params=query_params,
                                          _preload_content=_preload_content,
                                          _request_timeout=_request_timeout,
-                                         headers=headers)
+                                         headers=headers,
+                                         opts=opts)
         elif method == "OPTIONS":
             return self.rest_client.options_request(url,
                                             query_params=query_params,
                                             headers=headers,
                                             _preload_content=_preload_content,
-                                            _request_timeout=_request_timeout)
+                                            _request_timeout=_request_timeout,
+                                            opts=opts)
         elif method == "POST":
             return self.rest_client.post_request(url,
                                          query_params=query_params,
@@ -462,7 +468,8 @@ class SyncApiClient:
                                          post_params=post_params,
                                          _preload_content=_preload_content,
                                          _request_timeout=_request_timeout,
-                                         body=body)
+                                         body=body,
+                                         opts=opts)
         elif method == "PUT":
             return self.rest_client.put_request(url,
                                         query_params=query_params,
@@ -470,7 +477,8 @@ class SyncApiClient:
                                         post_params=post_params,
                                         _preload_content=_preload_content,
                                         _request_timeout=_request_timeout,
-                                        body=body)
+                                        body=body,
+                                        opts=opts)
         elif method == "PATCH":
             return self.rest_client.patch_request(url,
                                           query_params=query_params,
@@ -478,14 +486,16 @@ class SyncApiClient:
                                           post_params=post_params,
                                           _preload_content=_preload_content,
                                           _request_timeout=_request_timeout,
-                                          body=body)
+                                          body=body,
+                                          opts=opts)
         elif method == "DELETE":
             return self.rest_client.delete_request(url,
                                            query_params=query_params,
                                            headers=headers,
                                            _preload_content=_preload_content,
                                            _request_timeout=_request_timeout,
-                                           body=body)
+                                           body=body,
+                                           opts=opts)
         else:
             raise ApiValueError(
                 "http method must be `GET`, `HEAD`, `OPTIONS`,"
@@ -543,7 +553,7 @@ class SyncApiClient:
             if k in collection_formats:
                 collection_format = collection_formats[k]
                 if collection_format == 'multi':
-                    new_params.extend((k, value) for value in v)
+                    new_params.extend((k, quote(str(value))) for value in v)
                 else:
                     if collection_format == 'ssv':
                         delimiter = ' '