lusid-sdk 1.1.257__py3-none-any.whl → 2.0.430__py3-none-any.whl

lusid/models/yield_curve_data_all_of.py

@@ -1,313 +0,0 @@
-# coding: utf-8
-
-"""
-    LUSID API
-
-    FINBOURNE Technology  # noqa: E501
-
-    The version of the OpenAPI document: 1.1.257
-    Contact: info@finbourne.com
-    Generated by: https://openapi-generator.tech
-"""
-
-
-try:
-    from inspect import getfullargspec
-except ImportError:
-    from inspect import getargspec as getfullargspec
-import pprint
-import re  # noqa: F401
-import six
-
-from lusid.configuration import Configuration
-
-
-class YieldCurveDataAllOf(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
-
-    """
-    Attributes:
-      openapi_types (dict): The key is attribute name
-                            and the value is attribute type.
-      attribute_map (dict): The key is attribute name
-                            and the value is json key in definition.
-      required_map (dict): The key is attribute name
-                           and the value is whether it is 'required' or 'optional'.
-    """
-    openapi_types = {
-        'base_date': 'datetime',
-        'instruments': 'list[LusidInstrument]',
-        'quotes': 'list[MarketQuote]',
-        'lineage': 'str',
-        'market_data_options': 'MarketDataOptions',
-        'market_data_type': 'str'
-    }
-
-    attribute_map = {
-        'base_date': 'baseDate',
-        'instruments': 'instruments',
-        'quotes': 'quotes',
-        'lineage': 'lineage',
-        'market_data_options': 'marketDataOptions',
-        'market_data_type': 'marketDataType'
-    }
-
-    required_map = {
-        'base_date': 'required',
-        'instruments': 'required',
-        'quotes': 'required',
-        'lineage': 'optional',
-        'market_data_options': 'optional',
-        'market_data_type': 'required'
-    }
-
-    def __init__(self, base_date=None, instruments=None, quotes=None, lineage=None, market_data_options=None, market_data_type=None, local_vars_configuration=None):  # noqa: E501
-        """YieldCurveDataAllOf - a model defined in OpenAPI"
-        
-        :param base_date:  Base date (required)
-        :type base_date: datetime
-        :param instruments:  The set of instruments that define the curve. (required)
-        :type instruments: list[lusid.LusidInstrument]
-        :param quotes:  The market quotes corresponding to the the instruments used to define the curve (required)
-        :type quotes: list[lusid.MarketQuote]
-        :param lineage:  Description of the complex market data's lineage e.g. 'FundAccountant_GreenQuality'.
-        :type lineage: str
-        :param market_data_options: 
-        :type market_data_options: lusid.MarketDataOptions
-        :param market_data_type:  The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface (required)
-        :type market_data_type: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._base_date = None
-        self._instruments = None
-        self._quotes = None
-        self._lineage = None
-        self._market_data_options = None
-        self._market_data_type = None
-        self.discriminator = None
-
-        self.base_date = base_date
-        self.instruments = instruments
-        self.quotes = quotes
-        self.lineage = lineage
-        if market_data_options is not None:
-            self.market_data_options = market_data_options
-        self.market_data_type = market_data_type
-
-    @property
-    def base_date(self):
-        """Gets the base_date of this YieldCurveDataAllOf.  # noqa: E501
-
-        Base date  # noqa: E501
-
-        :return: The base_date of this YieldCurveDataAllOf.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._base_date
-
-    @base_date.setter
-    def base_date(self, base_date):
-        """Sets the base_date of this YieldCurveDataAllOf.
-
-        Base date  # noqa: E501
-
-        :param base_date: The base_date of this YieldCurveDataAllOf.  # noqa: E501
-        :type base_date: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and base_date is None:  # noqa: E501
-            raise ValueError("Invalid value for `base_date`, must not be `None`")  # noqa: E501
-
-        self._base_date = base_date
-
-    @property
-    def instruments(self):
-        """Gets the instruments of this YieldCurveDataAllOf.  # noqa: E501
-
-        The set of instruments that define the curve.  # noqa: E501
-
-        :return: The instruments of this YieldCurveDataAllOf.  # noqa: E501
-        :rtype: list[lusid.LusidInstrument]
-        """
-        return self._instruments
-
-    @instruments.setter
-    def instruments(self, instruments):
-        """Sets the instruments of this YieldCurveDataAllOf.
-
-        The set of instruments that define the curve.  # noqa: E501
-
-        :param instruments: The instruments of this YieldCurveDataAllOf.  # noqa: E501
-        :type instruments: list[lusid.LusidInstrument]
-        """
-        if self.local_vars_configuration.client_side_validation and instruments is None:  # noqa: E501
-            raise ValueError("Invalid value for `instruments`, must not be `None`")  # noqa: E501
-
-        self._instruments = instruments
-
-    @property
-    def quotes(self):
-        """Gets the quotes of this YieldCurveDataAllOf.  # noqa: E501
-
-        The market quotes corresponding to the the instruments used to define the curve  # noqa: E501
-
-        :return: The quotes of this YieldCurveDataAllOf.  # noqa: E501
-        :rtype: list[lusid.MarketQuote]
-        """
-        return self._quotes
-
-    @quotes.setter
-    def quotes(self, quotes):
-        """Sets the quotes of this YieldCurveDataAllOf.
-
-        The market quotes corresponding to the the instruments used to define the curve  # noqa: E501
-
-        :param quotes: The quotes of this YieldCurveDataAllOf.  # noqa: E501
-        :type quotes: list[lusid.MarketQuote]
-        """
-        if self.local_vars_configuration.client_side_validation and quotes is None:  # noqa: E501
-            raise ValueError("Invalid value for `quotes`, must not be `None`")  # noqa: E501
-
-        self._quotes = quotes
-
-    @property
-    def lineage(self):
-        """Gets the lineage of this YieldCurveDataAllOf.  # noqa: E501
-
-        Description of the complex market data's lineage e.g. 'FundAccountant_GreenQuality'.  # noqa: E501
-
-        :return: The lineage of this YieldCurveDataAllOf.  # noqa: E501
-        :rtype: str
-        """
-        return self._lineage
-
-    @lineage.setter
-    def lineage(self, lineage):
-        """Sets the lineage of this YieldCurveDataAllOf.
-
-        Description of the complex market data's lineage e.g. 'FundAccountant_GreenQuality'.  # noqa: E501
-
-        :param lineage: The lineage of this YieldCurveDataAllOf.  # noqa: E501
-        :type lineage: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                lineage is not None and len(lineage) > 1024):
-            raise ValueError("Invalid value for `lineage`, length must be less than or equal to `1024`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                lineage is not None and len(lineage) < 0):
-            raise ValueError("Invalid value for `lineage`, length must be greater than or equal to `0`")  # noqa: E501
-
-        self._lineage = lineage
-
-    @property
-    def market_data_options(self):
-        """Gets the market_data_options of this YieldCurveDataAllOf.  # noqa: E501
-
-
-        :return: The market_data_options of this YieldCurveDataAllOf.  # noqa: E501
-        :rtype: lusid.MarketDataOptions
-        """
-        return self._market_data_options
-
-    @market_data_options.setter
-    def market_data_options(self, market_data_options):
-        """Sets the market_data_options of this YieldCurveDataAllOf.
-
-
-        :param market_data_options: The market_data_options of this YieldCurveDataAllOf.  # noqa: E501
-        :type market_data_options: lusid.MarketDataOptions
-        """
-
-        self._market_data_options = market_data_options
-
-    @property
-    def market_data_type(self):
-        """Gets the market_data_type of this YieldCurveDataAllOf.  # noqa: E501
-
-        The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface  # noqa: E501
-
-        :return: The market_data_type of this YieldCurveDataAllOf.  # noqa: E501
-        :rtype: str
-        """
-        return self._market_data_type
-
-    @market_data_type.setter
-    def market_data_type(self, market_data_type):
-        """Sets the market_data_type of this YieldCurveDataAllOf.
-
-        The available values are: DiscountFactorCurveData, EquityVolSurfaceData, FxVolSurfaceData, IrVolCubeData, OpaqueMarketData, YieldCurveData, FxForwardCurveData, FxForwardPipsCurveData, FxForwardTenorCurveData, FxForwardTenorPipsCurveData, FxForwardCurveByQuoteReference, CreditSpreadCurveData, EquityCurveByPricesData, ConstantVolatilitySurface  # noqa: E501
-
-        :param market_data_type: The market_data_type of this YieldCurveDataAllOf.  # noqa: E501
-        :type market_data_type: str
-        """
-        if self.local_vars_configuration.client_side_validation and market_data_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `market_data_type`, must not be `None`")  # noqa: E501
-        allowed_values = ["DiscountFactorCurveData", "EquityVolSurfaceData", "FxVolSurfaceData", "IrVolCubeData", "OpaqueMarketData", "YieldCurveData", "FxForwardCurveData", "FxForwardPipsCurveData", "FxForwardTenorCurveData", "FxForwardTenorPipsCurveData", "FxForwardCurveByQuoteReference", "CreditSpreadCurveData", "EquityCurveByPricesData", "ConstantVolatilitySurface"]  # noqa: E501
-        if self.local_vars_configuration.client_side_validation and market_data_type not in allowed_values:  # noqa: E501
-            raise ValueError(
-                "Invalid value for `market_data_type` ({0}), must be one of {1}"  # noqa: E501
-                .format(market_data_type, allowed_values)
-            )
-
-        self._market_data_type = market_data_type
-
-    def to_dict(self, serialize=False):
-        """Returns the model properties as a dict"""
-        result = {}
-
-        def convert(x):
-            if hasattr(x, "to_dict"):
-                args = getfullargspec(x.to_dict).args
-                if len(args) == 1:
-                    return x.to_dict()
-                else:
-                    return x.to_dict(serialize)
-            else:
-                return x
-
-        for attr, _ in six.iteritems(self.openapi_types):
-            value = getattr(self, attr)
-            attr = self.attribute_map.get(attr, attr) if serialize else attr
-            if isinstance(value, list):
-                result[attr] = list(map(
-                    lambda x: convert(x),
-                    value
-                ))
-            elif isinstance(value, dict):
-                result[attr] = dict(map(
-                    lambda item: (item[0], convert(item[1])),
-                    value.items()
-                ))
-            else:
-                result[attr] = convert(value)
-
-        return result
-
-    def to_str(self):
-        """Returns the string representation of the model"""
-        return pprint.pformat(self.to_dict())
-
-    def __repr__(self):
-        """For `print` and `pprint`"""
-        return self.to_str()
-
-    def __eq__(self, other):
-        """Returns true if both objects are equal"""
-        if not isinstance(other, YieldCurveDataAllOf):
-            return False
-
-        return self.to_dict() == other.to_dict()
-
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, YieldCurveDataAllOf):
-            return True
-
-        return self.to_dict() != other.to_dict()

lusid/tcp/__init__.py

@@ -1 +0,0 @@
-from lusid.tcp.tcp_keep_alive_probes import TCPKeepAlivePoolManager, TCPKeepAliveProxyManager

lusid/tcp/tcp_keep_alive_probes.py

@@ -1,110 +0,0 @@
-from urllib3 import HTTPSConnectionPool, HTTPConnectionPool, PoolManager, ProxyManager
-import socket
-import sys
-
-# The content to send on Mac OS in the TCP Keep Alive probe
-TCP_KEEPALIVE = 0x10
-# The maximum time to keep the connection idle before sending probes
-TCP_KEEP_IDLE = 60
-# The interval between probes
-TCP_KEEPALIVE_INTERVAL = 60
-# The maximum number of failed probes before terminating the connection
-TCP_KEEP_CNT = 3
-
-
-class TCPKeepAliveValidationMethods:
-    """
-    This class contains a single method whose sole purpose is to set up TCP Keep Alive probes on the socket for a
-    connection. This is necessary for long running requests which will be silently terminated by the AWS Network Load
-    Balancer which kills a connection if it is idle for more then 350 seconds.
-    """
-    @staticmethod
-    def adjust_connection_socket(conn, protocol: str = "https"):
-        """
-        Adjusts the socket settings so that the client sends a TCP keep alive probe over the connection. This is only
-        applied where possible, if the ability to set the socket options is not available, for example using Anaconda,
-        then the settings will be left as is.
-
-        :param conn: The connection to update the socket settings for
-        :param str protocol: The protocol of the connection
-
-        :return: None
-        """
-
-        if protocol == "http":
-            # It isn't clear how to set this up over HTTP, it seems to differ from HTTPs
-            return
-
-        # TCP Keep Alive Probes for different platforms
-        platform = sys.platform
-        # TCP Keep Alive Probes for Linux
-        if (platform == 'linux' and hasattr(conn.sock, "setsockopt") and hasattr(socket, "SO_KEEPALIVE") and
-                hasattr(socket, "TCP_KEEPIDLE") and hasattr(socket, "TCP_KEEPINTVL") and hasattr(socket, "TCP_KEEPCNT")):
-            conn.sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
-            conn.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, TCP_KEEP_IDLE)
-            conn.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, TCP_KEEPALIVE_INTERVAL)
-            conn.sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, TCP_KEEP_CNT)
-
-        # TCP Keep Alive Probes for Windows OS
-        elif platform == 'win32' and hasattr(socket, "SIO_KEEPALIVE_VALS") and getattr(conn.sock, "ioctl", None) is not None:
-            conn.sock.ioctl(socket.SIO_KEEPALIVE_VALS, (1, TCP_KEEP_IDLE * 1000, TCP_KEEPALIVE_INTERVAL * 1000))
-
-        # TCP Keep Alive Probes for Mac OS
-        elif platform == 'darwin' and getattr(conn.sock, "setsockopt", None) is not None:
-            conn.sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
-            conn.sock.setsockopt(socket.IPPROTO_TCP, TCP_KEEPALIVE, TCP_KEEPALIVE_INTERVAL)
-
-
-class TCPKeepAliveHTTPSConnectionPool(HTTPSConnectionPool):
-    """
-    This class overrides the _validate_conn method in the HTTPSConnectionPool class. This is the entry point to use
-    for modifying the socket as it is called after the socket is created and before the request is made.
-    """
-    def _validate_conn(self, conn):
-        """
-        Called right before a request is made, after the socket is created.
-        """
-        # Call the method on the base class
-        super()._validate_conn(conn)
-
-        # Set up TCP Keep Alive probes, this is the only line added to this function
-        TCPKeepAliveValidationMethods.adjust_connection_socket(conn, "https")
-
-
-class TCPKeepAliveHTTPConnectionPool(HTTPConnectionPool):
-    """
-    This class overrides the _validate_conn method in the HTTPSConnectionPool class. This is the entry point to use
-    for modifying the socket as it is called after the socket is created and before the request is made.
-
-    In the base class this method is passed completely.
-    """
-
-    def _validate_conn(self, conn):
-        """
-        Called right before a request is made, after the socket is created.
-        """
-        # Call the method on the base class
-        super()._validate_conn(conn)
-
-        # Set up TCP Keep Alive probes, this is the only line added to this function
-        TCPKeepAliveValidationMethods.adjust_connection_socket(conn, "http")
-
-
-class TCPKeepAlivePoolManager(PoolManager):
-    """
-    This Pool Manager has only had the pool_classes_by_scheme variable changed. This now points at the TCPKeepAlive
-    connection pools rather than the default connection pools.
-    """
-    def __init__(self, num_pools=10, headers=None, **connection_pool_kw):
-        super().__init__(num_pools=num_pools, headers=headers, **connection_pool_kw)
-        self.pool_classes_by_scheme = {"http": TCPKeepAliveHTTPConnectionPool, "https": TCPKeepAliveHTTPSConnectionPool}
-
-
-class TCPKeepAliveProxyManager(ProxyManager):
-    """
-    This Proxy Manager has only had the pool_classes_by_scheme variable changed. This now points at the TCPKeepAlive
-    connection pools rather than the default connection pools.
-    """
-    def __init__(self, proxy_url, num_pools=10, headers=None, proxy_headers=None, **connection_pool_kw):
-        super().__init__(proxy_url=proxy_url, num_pools=num_pools, headers=headers, proxy_headers=proxy_headers, **connection_pool_kw)
-        self.pool_classes_by_scheme = {"http": TCPKeepAliveHTTPConnectionPool, "https": TCPKeepAliveHTTPSConnectionPool}

lusid/utilities/__init__.py

@@ -1,8 +0,0 @@
-from lusid.utilities.api_client_builder import ApiClientBuilder
-from lusid.utilities.api_configuration_loader import ApiConfigurationLoader
-from lusid.utilities.refreshing_token import RefreshingToken
-from lusid.utilities.api_client_factory import ApiClientFactory
-from lusid.utilities.lusid_retry import lusidretry
-from lusid.utilities.proxy_config import ProxyConfig
-from lusid.utilities.api_configuration import ApiConfiguration
-from lusid.utilities.config_keys import ConfigKeys

lusid/utilities/api_client_builder.py

@@ -1,145 +0,0 @@
-import os
-
-from urllib3 import make_headers
-
-from lusid import Configuration, ApiClient
-from .api_configuration_loader import ApiConfigurationLoader
-from .refreshing_token import RefreshingToken
-
-
-class ApiClientBuilder:
-    """
-    The ApiClientBuilder is responsible for building a lusid.ApiClient. This includes obtaining an access token from
-    Okta or using the provided token.
-
-    Any validation on the inputs required to build a lusid.ApiClient is the responsibility of this ApiClientBuilder.
-    """
-
-    @staticmethod
-    def __check_required_fields(object_to_check, fields):
-        """
-        This function checks that the provided fields on an object are populated with values other than None
-
-        :param object_to_check: The object to check the fields (a.k.a attributes) of
-        :param list[str] fields: The fields to check on the object
-
-        :return: None
-        """
-        # Check for fields which have a value of None
-        missing_fields = [field for field in fields if getattr(object_to_check, field) is None]
-
-        # Raise an error if any fields have a value of None
-        if len(missing_fields) > 0:
-            raise ValueError(
-                f"The fields {str(missing_fields)} on the {object_to_check.__class__.__name__} are set to None, "
-                f"please ensure that you have provided them directly, via a secrets file or environment "
-                f"variables")
-
-    @classmethod
-    def resolve_api_token(cls, token=None, configuration=None, id_provider_response_handler=None):
-
-        """
-        Description:
-        This method uses a PAT (Personal Access Token) or secrets to return an API token.
-        The method uses the following conditional logic in order of precedence to resolve an
-        authentication path:
-
-            1. Use PAT passed into the function
-            2. Use secrets files passed into the function
-            3. Use environment variables
-
-        PAT are used in preference to supplied credentials.
-        secrets files are used in preference to environment variables.
-
-        :param str token: The pre-populated access token to use instead of asking Okta for a token
-        :param ApiConfiguration configuration: configuration object containing secrets loaded from env vars
-        :param typing.callable id_provider_response_handler: An optional function to handle the Okta response
-
-        :return: str api_token
-        """
-
-        # If token is passed in by user, then use that token
-        if token is not None:
-            cls.__check_required_fields(configuration, ["api_url"])
-            api_token = token
-
-        # If there is a token provided use it
-        elif configuration.access_token is not None:
-            # Check that there is an api_url available
-            cls.__check_required_fields(configuration, ["api_url"])
-            api_token = configuration.access_token
-
-        # Otherwise generate an access token from Okta and use a RefreshingToken going forward
-        else:
-            # Check that all the required fields for generating a token exist
-            cls.__check_required_fields(configuration, [
-                "api_url",
-                "password",
-                "username",
-                "client_id",
-                "client_secret",
-                "token_url"])
-
-            # Generate an access token
-            api_token = RefreshingToken(
-                api_configuration=configuration,
-                id_provider_response_handler=id_provider_response_handler
-            )
-
-        return api_token
-
-    @classmethod
-    def build(cls, api_secrets_filename=None, id_provider_response_handler=None, api_configuration=None,
-              token=None, correlation_id=None, tcp_keep_alive=False):
-        """
-        :param str api_secrets_filename: The full path to the JSON file containing the API credentials and optional proxy details
-        :param typing.callable id_provider_response_handler: An optional function to handle the Okta response
-        :param lusid.utilities.ApiConfiguration api_configuration: A pre-populated ApiConfiguration
-        :param str token: The pre-populated access token to use instead of asking Okta for a token
-        :param str correlation_id: Correlation id for all calls made from the returned ApiClient instance, added as a header to each request
-        :param bool tcp_keep_alive: A flag that controls if the API client uses tcp keep-alive probes
-
-        :return: lusid.ApiClient: The configured LUSID ApiClient
-        """
-
-        # Load the configuration
-        configuration = ApiConfigurationLoader.load(api_secrets_filename)
-
-        # If an api_configuration has been provided override the loaded configuration
-        # with any properties that it has
-        if api_configuration is not None:
-            for key, value in vars(api_configuration).items():
-                if value is not None:
-                    setattr(configuration, key, value)
-
-        api_token = cls.resolve_api_token(token, configuration, id_provider_response_handler)
-
-        # Initialise the API client using the token so that it can be included in all future requests
-        config = Configuration(tcp_keep_alive=tcp_keep_alive)
-        config.access_token = api_token
-        config.host = configuration.api_url
-
-        # Set the certificate from the configuration
-        config.ssl_ca_cert = configuration.certificate_filename
-
-        # Set the proxy for LUSID if needed
-        if configuration.proxy_config is not None:
-            config.proxy = configuration.proxy_config.address
-            if configuration.proxy_config.username is not None and configuration.proxy_config.password is not None:
-                config.proxy_headers = make_headers(
-                    proxy_basic_auth=f"{configuration.proxy_config.username}:{configuration.proxy_config.password}"
-                )
-
-        # Create and return the ApiClient
-        api_client = ApiClient(configuration=config)
-
-        # set the application name if specified
-        if configuration.app_name is not None:
-            api_client.set_default_header("X-LUSID-Application", configuration.app_name)
-
-        # set a correlation id for all requests initiated with this ApiClient
-        corr_id = correlation_id or os.getenv("FBN_CORRELATION_ID")
-        if corr_id is not None:
-            api_client.set_default_header("CorrelationId", corr_id)
-
-        return api_client