lusid-sdk 2.1.435__py3-none-any.whl → 2.1.449__py3-none-any.whl

lusid/rest.py

@@ -68,6 +68,11 @@ class RESTClientObject:
 
         self.proxy = configuration.proxy
         self.proxy_headers = configuration.proxy_headers
+        self.timeout = aiohttp.ClientTimeout(
+            total=configuration.timeouts.total_timeout_ms / 1000.0 if configuration.timeouts != None and configuration.timeouts.total_timeout_ms != None else None,
+            connect=configuration.timeouts.connect_timeout_ms / 1000.0 if configuration.timeouts != None and configuration.timeouts.connect_timeout_ms != None else None,
+            sock_read=configuration.timeouts.read_timeout_ms / 1000.0 if configuration.timeouts != None and configuration.timeouts.read_timeout_ms != None else None,
+        )
 
         # https pool manager
         self.pool_manager = aiohttp.ClientSession(
@@ -80,7 +85,7 @@ class RESTClientObject:
 
     async def request(self, method, url, query_params=None, headers=None,
                       body=None, post_params=None, _preload_content=True,
-                      _request_timeout=None):
+                      _request_timeout=None, opts=None):
         """Execute request
 
         :param method: http request method
@@ -93,10 +98,9 @@ class RESTClientObject:
                             and `multipart/form-data`
         :param _preload_content: this is a non-applicable field for
                                  the AiohttpClient.
-        :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
         """
         method = method.upper()
         assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
@@ -112,7 +116,44 @@ class RESTClientObject:
         # url already contains the URL query string
         # so reset query_params to empty dict
         query_params = {}
-        timeout = _request_timeout or 5 * 60
+
+        # _request_timeout param cannot be removed for backwards compatability
+        # values from opts override values from _request_timeout
+        # try to get values from opts first, then _request_timeout, then self.timeout, else set to None
+        # timeout = _request_timeout or self.timeout
+        timeout = None
+        opts_total_timeout = opts.total_timeout_ms / 1000.0 if opts and opts.total_timeout_ms != None else None
+        opts_connect_timeout = opts.connect_timeout_ms / 1000.0 if opts and opts.connect_timeout_ms != None else None
+        opts_read_timeout = opts.read_timeout_ms / 1000.0 if opts and opts.read_timeout_ms != None else None
+        if not _request_timeout:
+            timeout = aiohttp.ClientTimeout(
+                total=opts_total_timeout if opts_total_timeout != None
+                    else self.timeout.total, 
+                connect=opts_connect_timeout if opts_connect_timeout != None
+                    else self.timeout.connect,
+                sock_read=opts_read_timeout if opts_read_timeout != None
+                    else self.timeout.sock_read)
+        elif isinstance(_request_timeout, aiohttp.ClientTimeout):
+            timeout = aiohttp.ClientTimeout(
+                total=opts_total_timeout if opts_total_timeout != None
+                    else _request_timeout.total if _request_timeout.total != None
+                        else self.timeout.total, 
+                connect=opts_connect_timeout if opts_connect_timeout != None
+                    else _request_timeout.connect if _request_timeout.connect != None
+                        else self.timeout.connect,
+                sock_read=opts_read_timeout if opts_read_timeout != None
+                    else _request_timeout.sock_read if _request_timeout.sock_read != None
+                        else self.timeout.sock_read)
+        elif isinstance(_request_timeout, (int, float)):
+            timeout = aiohttp.ClientTimeout(
+                total=opts_total_timeout if opts_total_timeout != None
+                    else _request_timeout, 
+                connect=opts_connect_timeout if opts_connect_timeout != None
+                    else self.timeout.connect, 
+                sock_read=opts_read_timeout if opts_read_timeout != None
+                    else self.timeout.sock_read)
+        else:
+            raise f"unexpected type '{type(_request_timeout)}' for _request_timeout"
 
         if 'Content-Type' not in headers:
             headers['Content-Type'] = 'application/json'
@@ -186,69 +227,78 @@ class RESTClientObject:
         return r
 
     async def get_request(self, url, headers=None, query_params=None,
-                  _preload_content=True, _request_timeout=None):
+                  _preload_content=True, _request_timeout=None, opts=None):
         return (await self.request("GET", url,
                                    headers=headers,
                                    _preload_content=_preload_content,
                                    _request_timeout=_request_timeout,
-                                   query_params=query_params))
+                                   query_params=query_params,
+                                   opts=opts))
 
     async def head_request(self, url, headers=None, query_params=None,
-                   _preload_content=True, _request_timeout=None):
+                   _preload_content=True, _request_timeout=None, opts=None):
         return (await self.request("HEAD", url,
                                    headers=headers,
                                    _preload_content=_preload_content,
                                    _request_timeout=_request_timeout,
-                                   query_params=query_params))
+                                   query_params=query_params,
+                                   opts=opts))
 
     async def options_request(self, url, headers=None, query_params=None,
                       post_params=None, body=None, _preload_content=True,
-                      _request_timeout=None):
+                      _request_timeout=None, opts=None):
         return (await self.request("OPTIONS", url,
                                    headers=headers,
                                    query_params=query_params,
                                    post_params=post_params,
                                    _preload_content=_preload_content,
                                    _request_timeout=_request_timeout,
-                                   body=body))
+                                   body=body,
+                                   opts=opts))
 
     async def delete_request(self, url, headers=None, query_params=None, body=None,
-                     _preload_content=True, _request_timeout=None):
+                     _preload_content=True, _request_timeout=None, 
+                     opts=None):
         return (await self.request("DELETE", url,
                                    headers=headers,
                                    query_params=query_params,
                                    _preload_content=_preload_content,
                                    _request_timeout=_request_timeout,
-                                   body=body))
+                                   body=body,
+                                   opts=opts))
 
     async def post_request(self, url, headers=None, query_params=None,
                    post_params=None, body=None, _preload_content=True,
-                   _request_timeout=None):
+                   _request_timeout=None, opts=None):
         return (await self.request("POST", url,
                                    headers=headers,
                                    query_params=query_params,
                                    post_params=post_params,
                                    _preload_content=_preload_content,
                                    _request_timeout=_request_timeout,
-                                   body=body))
+                                   body=body,
+                                   opts=opts))
 
     async def put_request(self, url, headers=None, query_params=None, post_params=None,
-                  body=None, _preload_content=True, _request_timeout=None):
+                  body=None, _preload_content=True, _request_timeout=None, 
+                  opts=None):
         return (await self.request("PUT", url,
                                    headers=headers,
                                    query_params=query_params,
                                    post_params=post_params,
                                    _preload_content=_preload_content,
                                    _request_timeout=_request_timeout,
-                                   body=body))
+                                   body=body,
+                                   opts=opts))
 
     async def patch_request(self, url, headers=None, query_params=None,
                     post_params=None, body=None, _preload_content=True,
-                    _request_timeout=None):
+                    _request_timeout=None, opts=None):
         return (await self.request("PATCH", url,
                                    headers=headers,
                                    query_params=query_params,
                                    post_params=post_params,
                                    _preload_content=_preload_content,
                                    _request_timeout=_request_timeout,
-                                   body=body))
+                                   body=body,
+                                   opts=opts))

{lusid_sdk-2.1.435.dist-info → lusid_sdk-2.1.449.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.435
+Version: 2.1.449
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -215,6 +215,7 @@ Class | Method | HTTP request | Description
 *DerivedTransactionPortfoliosApi* | [**delete_derived_portfolio_details**](docs/DerivedTransactionPortfoliosApi.md#delete_derived_portfolio_details) | **DELETE** /api/derivedtransactionportfolios/{scope}/{code}/details | [EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details
 *EntitiesApi* | [**get_custom_entity_by_entity_unique_id**](docs/EntitiesApi.md#get_custom_entity_by_entity_unique_id) | **GET** /api/entities/customentities/{entityUniqueId} | [EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId
 *EntitiesApi* | [**get_data_type_by_entity_unique_id**](docs/EntitiesApi.md#get_data_type_by_entity_unique_id) | **GET** /api/entities/datatypes/{entityUniqueId} | [EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId
+*EntitiesApi* | [**get_entity_history**](docs/EntitiesApi.md#get_entity_history) | **GET** /api/entities/{entityType}/{entityUniqueId}/history | [EXPERIMENTAL] GetEntityHistory: List an entity's history information
 *EntitiesApi* | [**get_instrument_by_entity_unique_id**](docs/EntitiesApi.md#get_instrument_by_entity_unique_id) | **GET** /api/entities/instruments/{entityUniqueId} | [EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId
 *EntitiesApi* | [**get_portfolio_by_entity_unique_id**](docs/EntitiesApi.md#get_portfolio_by_entity_unique_id) | **GET** /api/entities/portfolios/{entityUniqueId} | [EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId
 *EntitiesApi* | [**get_portfolio_changes**](docs/EntitiesApi.md#get_portfolio_changes) | **GET** /api/entities/changes/portfolios | GetPortfolioChanges: Get the next change to each portfolio in a scope.
@@ -233,6 +234,7 @@ Class | Method | HTTP request | Description
 *FundConfigurationApi* | [**delete_fund_configuration**](docs/FundConfigurationApi.md#delete_fund_configuration) | **DELETE** /api/fundconfigurations/{scope}/{code} | [EXPERIMENTAL] DeleteFundConfiguration: Delete a FundConfiguration.
 *FundConfigurationApi* | [**get_fund_configuration**](docs/FundConfigurationApi.md#get_fund_configuration) | **GET** /api/fundconfigurations/{scope}/{code} | [EXPERIMENTAL] GetFundConfiguration: Get FundConfiguration.
 *FundConfigurationApi* | [**list_fund_configurations**](docs/FundConfigurationApi.md#list_fund_configurations) | **GET** /api/fundconfigurations | [EXPERIMENTAL] ListFundConfigurations: List FundConfiguration.
+*FundConfigurationApi* | [**patch_fund_configuration**](docs/FundConfigurationApi.md#patch_fund_configuration) | **PATCH** /api/fundconfigurations/{scope}/{code} | [EXPERIMENTAL] PatchFundConfiguration: Patch Fund Configuration.
 *FundConfigurationApi* | [**upsert_fund_configuration_properties**](docs/FundConfigurationApi.md#upsert_fund_configuration_properties) | **POST** /api/fundconfigurations/{scope}/{code}/properties/$upsert | [EXPERIMENTAL] UpsertFundConfigurationProperties: Upsert FundConfiguration properties
 *FundsApi* | [**accept_estimate_valuation_point**](docs/FundsApi.md#accept_estimate_valuation_point) | **POST** /api/funds/{scope}/{code}/valuationpoints/$acceptestimate | [EXPERIMENTAL] AcceptEstimateValuationPoint: Accepts an Estimate Valuation Point.
 *FundsApi* | [**create_fee**](docs/FundsApi.md#create_fee) | **POST** /api/funds/{scope}/{code}/fees | [EXPERIMENTAL] CreateFee: Create a Fee.
@@ -701,6 +703,7 @@ Class | Method | HTTP request | Description
  - [BondCouponEvent](docs/BondCouponEvent.md)
  - [BondDefaultEvent](docs/BondDefaultEvent.md)
  - [BondPrincipalEvent](docs/BondPrincipalEvent.md)
+ - [BonusIssueEvent](docs/BonusIssueEvent.md)
  - [BookTransactionsRequest](docs/BookTransactionsRequest.md)
  - [BookTransactionsResponse](docs/BookTransactionsResponse.md)
  - [BoolComplianceParameter](docs/BoolComplianceParameter.md)
@@ -741,6 +744,7 @@ Class | Method | HTTP request | Description
  - [Change](docs/Change.md)
  - [ChangeHistory](docs/ChangeHistory.md)
  - [ChangeHistoryAction](docs/ChangeHistoryAction.md)
+ - [ChangeInterval](docs/ChangeInterval.md)
  - [ChangeIntervalWithOrderManagementDetail](docs/ChangeIntervalWithOrderManagementDetail.md)
  - [ChangeItem](docs/ChangeItem.md)
  - [ChartOfAccounts](docs/ChartOfAccounts.md)
@@ -909,6 +913,7 @@ Class | Method | HTTP request | Description
  - [EconomicDependencyType](docs/EconomicDependencyType.md)
  - [EconomicDependencyWithComplexMarketData](docs/EconomicDependencyWithComplexMarketData.md)
  - [EconomicDependencyWithQuote](docs/EconomicDependencyWithQuote.md)
+ - [EffectiveRange](docs/EffectiveRange.md)
  - [ElectionSpecification](docs/ElectionSpecification.md)
  - [EligibilityCalculation](docs/EligibilityCalculation.md)
  - [EmptyModelOptions](docs/EmptyModelOptions.md)
@@ -1098,6 +1103,7 @@ Class | Method | HTTP request | Description
  - [JournalEntryLine](docs/JournalEntryLine.md)
  - [JournalEntryLinesQueryParameters](docs/JournalEntryLinesQueryParameters.md)
  - [LabelValueSet](docs/LabelValueSet.md)
+ - [LapseElection](docs/LapseElection.md)
  - [LegDefinition](docs/LegDefinition.md)
  - [LegalEntity](docs/LegalEntity.md)
  - [LevelStep](docs/LevelStep.md)
@@ -1129,10 +1135,13 @@ Class | Method | HTTP request | Description
  - [MarketObservableType](docs/MarketObservableType.md)
  - [MarketOptions](docs/MarketOptions.md)
  - [MarketQuote](docs/MarketQuote.md)
+ - [MasteredInstrument](docs/MasteredInstrument.md)
  - [MatchCriterion](docs/MatchCriterion.md)
  - [MaturityEvent](docs/MaturityEvent.md)
  - [MbsCouponEvent](docs/MbsCouponEvent.md)
+ - [MbsInterestDeferralEvent](docs/MbsInterestDeferralEvent.md)
  - [MbsPrincipalEvent](docs/MbsPrincipalEvent.md)
+ - [MbsPrincipalWriteOffEvent](docs/MbsPrincipalWriteOffEvent.md)
  - [MergerEvent](docs/MergerEvent.md)
  - [MetricValue](docs/MetricValue.md)
  - [ModelOptions](docs/ModelOptions.md)
@@ -1397,6 +1406,7 @@ Class | Method | HTTP request | Description
  - [ResourceListOfCalendarDate](docs/ResourceListOfCalendarDate.md)
  - [ResourceListOfChange](docs/ResourceListOfChange.md)
  - [ResourceListOfChangeHistory](docs/ResourceListOfChangeHistory.md)
+ - [ResourceListOfChangeInterval](docs/ResourceListOfChangeInterval.md)
  - [ResourceListOfChangeIntervalWithOrderManagementDetail](docs/ResourceListOfChangeIntervalWithOrderManagementDetail.md)
  - [ResourceListOfComplianceBreachedOrderInfo](docs/ResourceListOfComplianceBreachedOrderInfo.md)
  - [ResourceListOfComplianceRule](docs/ResourceListOfComplianceRule.md)
@@ -1503,6 +1513,7 @@ Class | Method | HTTP request | Description
  - [SidesDefinitionRequest](docs/SidesDefinitionRequest.md)
  - [SimpleCashFlowLoan](docs/SimpleCashFlowLoan.md)
  - [SimpleInstrument](docs/SimpleInstrument.md)
+ - [SimpleRoundingConvention](docs/SimpleRoundingConvention.md)
  - [SortOrder](docs/SortOrder.md)
  - [SpecificHoldingPricingInfo](docs/SpecificHoldingPricingInfo.md)
  - [SpinOffEvent](docs/SpinOffEvent.md)