Security.cs

/*
 * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
 * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/
 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Dynamic;
using System.Reflection;
using System.Globalization;
 
using QuantConnect.Data;
using QuantConnect.Orders.Fees;
using QuantConnect.Orders.Fills;
using QuantConnect.Orders.Slippage;
using QuantConnect.Securities.Equity;
using QuantConnect.Securities.Forex;
using QuantConnect.Securities.Interfaces;
using QuantConnect.Data.Market;
using QuantConnect.Python;
using Python.Runtime;
using QuantConnect.Data.Fundamental;
using QuantConnect.Data.UniverseSelection;
using QuantConnect.Interfaces;
using QuantConnect.Data.Shortable;
 
namespace QuantConnect.Securities
{
    /// <summary>
    /// A base vehicle properties class for providing a common interface to all assets in QuantConnect.
    /// </summary>
    /// <remarks>
    /// Security object is intended to hold properties of the specific security asset. These properties can include trade start-stop dates,
    /// price, market hours, resolution of the security, the holdings information for this security and the specific fill model.
    /// </remarks>
    public class Security : DynamicObject, ISecurityPrice
    {
        private LocalTimeKeeper _localTimeKeeper;
 
        /// <summary>
        /// Collection of SubscriptionDataConfigs for this security.
        /// Uses concurrent bag to avoid list enumeration threading issues
        /// </summary>
        /// <remarks>Just use a list + lock, not concurrent bag, avoid garbage it creates for features we don't need here. See https://github.com/dotnet/runtime/issues/23103</remarks>
        private readonly List<SubscriptionDataConfig> _subscriptionsBag;
 
        /// <summary>
        /// This securities <see cref="IShortableProvider"/>
        /// </summary>
        public IShortableProvider ShortableProvider { get; private set; }
 
        /// <summary>
        /// A null security leverage value
        /// </summary>
        /// <remarks>This value is used to determine when the
        /// <see cref="SecurityInitializer"/> leverage is used</remarks>
        public const decimal NullLeverage = 0;
 
        /// <summary>
        /// Gets all the subscriptions for this security
        /// </summary>
        public IEnumerable<SubscriptionDataConfig> Subscriptions
        {
            get
            {
                lock (_subscriptionsBag)
                {
                    return _subscriptionsBag.ToList();
                }
            }
        }
 
        /// <summary>
        /// <see cref="Symbol"/> for the asset.
        /// </summary>
        public Symbol Symbol { get; }
 
        /// <summary>
        /// Gets the Cash object used for converting the quote currency to the account currency
        /// </summary>
        public Cash QuoteCurrency
        {
            get;
        }
 
        /// <summary>
        /// Gets the symbol properties for this security
        /// </summary>
        public SymbolProperties SymbolProperties
        {
            get;
            protected set;
        }
 
        /// <summary>
        /// Type of the security.
        /// </summary>
        /// <remarks>
        /// QuantConnect currently only supports Equities and Forex
        /// </remarks>
        public SecurityType Type => Symbol.ID.SecurityType;
 
        /// <summary>
        /// Resolution of data requested for this security.
        /// </summary>
        /// <remarks>Tick, second or minute resolution for QuantConnect assets.</remarks>
        [Obsolete("This property is obsolete. Use the 'SubscriptionDataConfig' exposed by 'SubscriptionManager'")]
        public Resolution Resolution { get; private set; }
 
        /// <summary>
        /// Indicates the data will use previous bars when there was no trading in this time period. This was a configurable datastream setting set in initialization.
        /// </summary>
        [Obsolete("This property is obsolete. Use the 'SubscriptionDataConfig' exposed by 'SubscriptionManager'")]
        public bool IsFillDataForward { get; private set; }
 
        /// <summary>
        /// Indicates the security will continue feeding data after the primary market hours have closed. This was a configurable setting set in initialization.
        /// </summary>
        [Obsolete("This property is obsolete. Use the 'SubscriptionDataConfig' exposed by 'SubscriptionManager'")]
        public bool IsExtendedMarketHours { get; private set; }
 
        /// <summary>
        /// Gets the data normalization mode used for this security
        /// </summary>
        [Obsolete("This property is obsolete. Use the 'SubscriptionDataConfig' exposed by 'SubscriptionManager'")]
        public DataNormalizationMode DataNormalizationMode { get; private set; }
 
        /// <summary>
        /// Gets the subscription configuration for this security
        /// </summary>
        [Obsolete("This property returns only the first subscription. Use the 'Subscriptions' property for all of this security's subscriptions.")]
        public SubscriptionDataConfig SubscriptionDataConfig
        {
            get
            {
                lock (_subscriptionsBag)
                {
                    return _subscriptionsBag.FirstOrDefault();
                }
            }
        }
 
        /// <summary>
        /// There has been at least one datapoint since our algorithm started running for us to determine price.
        /// </summary>
        public bool HasData => GetLastData() != null;
 
        /// <summary>
        /// Gets or sets whether or not this security should be considered tradable
        /// </summary>
        public virtual bool IsTradable
        {
            get; set;
        }
 
        /// <summary>
        /// True if the security has been delisted from exchanges and is no longer tradable
        /// </summary>
        public bool IsDelisted { get; set; }
 
        /// <summary>
        /// Data cache for the security to store previous price information.
        /// </summary>
        /// <seealso cref="EquityCache"/>
        /// <seealso cref="ForexCache"/>
        public SecurityCache Cache
        {
            get; set;
        }
 
        /// <summary>
        /// Holdings class contains the portfolio, cash and processes order fills.
        /// </summary>
        /// <seealso cref="EquityHolding"/>
        /// <seealso cref="ForexHolding"/>
        public SecurityHolding Holdings
        {
            get;
            set;
        }
 
        /// <summary>
        /// Exchange class contains the market opening hours, along with pre-post market hours.
        /// </summary>
        /// <seealso cref="EquityExchange"/>
        /// <seealso cref="ForexExchange"/>
        public SecurityExchange Exchange
        {
            get;
            set;
        }
 
        /// <summary>
        /// Fee model used to compute order fees for this security
        /// </summary>
        public IFeeModel FeeModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Fill model used to produce fill events for this security
        /// </summary>
        public IFillModel FillModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Slippage model use to compute slippage of market orders
        /// </summary>
        public ISlippageModel SlippageModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Gets the portfolio model used by this security
        /// </summary>
        public ISecurityPortfolioModel PortfolioModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Gets the buying power model used for this security
        /// </summary>
        public IBuyingPowerModel BuyingPowerModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Gets the buying power model used for this security, an alias for <see cref="BuyingPowerModel"/>
        /// </summary>
        public IBuyingPowerModel MarginModel
        {
            get { return BuyingPowerModel; }
            set { BuyingPowerModel = value; }
        }
 
        /// <summary>
        /// Gets or sets the margin interest rate model
        /// </summary>
        public IMarginInterestRateModel MarginInterestRateModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Gets the settlement model used for this security
        /// </summary>
        public ISettlementModel SettlementModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Gets the volatility model used for this security
        /// </summary>
        public IVolatilityModel VolatilityModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Customizable data filter to filter outlier ticks before they are passed into user event handlers.
        /// By default all ticks are passed into the user algorithms.
        /// </summary>
        /// <remarks>TradeBars (seconds and minute bars) are prefiltered to ensure the ticks which build the bars are realistically tradeable</remarks>
        /// <seealso cref="EquityDataFilter"/>
        /// <seealso cref="ForexDataFilter"/>
        public ISecurityDataFilter DataFilter
        {
            get;
            set;
        }
 
        /// <summary>
        /// Customizable price variation model used to define the minimum price variation of this security.
        /// By default minimum price variation is a constant find in the symbol-properties-database.
        /// </summary>
        /// <seealso cref="AdjustedPriceVariationModel"/>
        /// <seealso cref="SecurityPriceVariationModel"/>
        /// <seealso cref="EquityPriceVariationModel"/>
        public IPriceVariationModel PriceVariationModel
        {
            get;
            set;
        }
 
        /// <summary>
        /// Provides dynamic access to data in the cache
        /// </summary>
        public dynamic Data
        {
            get;
        }
 
        /// <summary>
        /// Construct a new security vehicle based on the user options.
        /// </summary>
        public Security(SecurityExchangeHours exchangeHours,
            SubscriptionDataConfig config,
            Cash quoteCurrency,
            SymbolProperties symbolProperties,
            ICurrencyConverter currencyConverter,
            IRegisteredSecurityDataTypesProvider registeredTypesProvider,
            SecurityCache cache
            )
            : this(config,
                quoteCurrency,
                symbolProperties,
                new SecurityExchange(exchangeHours),
                cache,
                new SecurityPortfolioModel(),
                new ImmediateFillModel(),
                new InteractiveBrokersFeeModel(),
                NullSlippageModel.Instance,
                new ImmediateSettlementModel(),
                Securities.VolatilityModel.Null,
                new SecurityMarginModel(),
                new SecurityDataFilter(),
                new SecurityPriceVariationModel(),
                currencyConverter,
                registeredTypesProvider,
                Securities.MarginInterestRateModel.Null
                )
        {
        }
 
        /// <summary>
        /// Construct a new security vehicle based on the user options.
        /// </summary>
        public Security(Symbol symbol,
            SecurityExchangeHours exchangeHours,
            Cash quoteCurrency,
            SymbolProperties symbolProperties,
            ICurrencyConverter currencyConverter,
            IRegisteredSecurityDataTypesProvider registeredTypesProvider,
            SecurityCache cache
            )
            : this(symbol,
                quoteCurrency,
                symbolProperties,
                new SecurityExchange(exchangeHours),
                cache,
                new SecurityPortfolioModel(),
                new ImmediateFillModel(),
                new InteractiveBrokersFeeModel(),
                NullSlippageModel.Instance,
                new ImmediateSettlementModel(),
                Securities.VolatilityModel.Null,
                new SecurityMarginModel(),
                new SecurityDataFilter(),
                new SecurityPriceVariationModel(),
                currencyConverter,
                registeredTypesProvider,
                Securities.MarginInterestRateModel.Null
                )
        {
        }
 
        /// <summary>
        /// Construct a new security vehicle based on the user options.
        /// </summary>
        protected Security(Symbol symbol,
            Cash quoteCurrency,
            SymbolProperties symbolProperties,
            SecurityExchange exchange,
            SecurityCache cache,
            ISecurityPortfolioModel portfolioModel,
            IFillModel fillModel,
            IFeeModel feeModel,
            ISlippageModel slippageModel,
            ISettlementModel settlementModel,
            IVolatilityModel volatilityModel,
            IBuyingPowerModel buyingPowerModel,
            ISecurityDataFilter dataFilter,
            IPriceVariationModel priceVariationModel,
            ICurrencyConverter currencyConverter,
            IRegisteredSecurityDataTypesProvider registeredTypesProvider,
            IMarginInterestRateModel marginInterestRateModel
            )
        {
            if (symbolProperties == null)
            {
                throw new ArgumentNullException(nameof(symbolProperties), Messages.Security.ValidSymbolPropertiesInstanceRequired);
            }
 
            if (symbolProperties.QuoteCurrency != quoteCurrency.Symbol)
            {
                throw new ArgumentException(Messages.Security.UnmatchingQuoteCurrencies);
            }
 
            Symbol = symbol;
            _subscriptionsBag = new ();
            QuoteCurrency = quoteCurrency;
            SymbolProperties = symbolProperties;
            IsTradable = true;
            Cache = cache;
            Exchange = exchange;
            DataFilter = dataFilter;
            PriceVariationModel = priceVariationModel;
            PortfolioModel = portfolioModel;
            BuyingPowerModel = buyingPowerModel;
            FillModel = fillModel;
            FeeModel = feeModel;
            SlippageModel = slippageModel;
            SettlementModel = settlementModel;
            VolatilityModel = volatilityModel;
            MarginInterestRateModel = marginInterestRateModel;
            Holdings = new SecurityHolding(this, currencyConverter);
            Data = new DynamicSecurityData(registeredTypesProvider, Cache);
            ShortableProvider = NullShortableProvider.Instance;
 
            UpdateSubscriptionProperties();
        }
 
 
        /// <summary>
        /// Temporary convenience constructor
        /// </summary>
        protected Security(SubscriptionDataConfig config,
            Cash quoteCurrency,
            SymbolProperties symbolProperties,
            SecurityExchange exchange,
            SecurityCache cache,
            ISecurityPortfolioModel portfolioModel,
            IFillModel fillModel,
            IFeeModel feeModel,
            ISlippageModel slippageModel,
            ISettlementModel settlementModel,
            IVolatilityModel volatilityModel,
            IBuyingPowerModel buyingPowerModel,
            ISecurityDataFilter dataFilter,
            IPriceVariationModel priceVariationModel,
            ICurrencyConverter currencyConverter,
            IRegisteredSecurityDataTypesProvider registeredTypesProvider,
            IMarginInterestRateModel marginInterestRateModel
            )
            : this(config.Symbol,
                quoteCurrency,
                symbolProperties,
                exchange,
                cache,
                portfolioModel,
                fillModel,
                feeModel,
                slippageModel,
                settlementModel,
                volatilityModel,
                buyingPowerModel,
                dataFilter,
                priceVariationModel,
                currencyConverter,
                registeredTypesProvider,
                marginInterestRateModel
                )
        {
            _subscriptionsBag.Add(config);
            UpdateSubscriptionProperties();
        }
 
        /// <summary>
        /// Read only property that checks if we currently own stock in the company.
        /// </summary>
        public virtual bool HoldStock => Holdings.HoldStock;
 
        /// <summary>
        /// Alias for HoldStock - Do we have any of this security
        /// </summary>
        public virtual bool Invested => HoldStock;
 
        /// <summary>
        /// Local time for this market
        /// </summary>
        public virtual DateTime LocalTime
        {
            get
            {
                if (_localTimeKeeper == null)
                {
                    throw new InvalidOperationException(Messages.Security.SetLocalTimeKeeperMustBeCalledBeforeUsingLocalTime);
                }
 
                return _localTimeKeeper.LocalTime;
            }
        }
 
        /// <summary>
        /// Get the current value of the security.
        /// </summary>
        public virtual decimal Price => Cache.Price;
 
        /// <summary>
        /// Leverage for this Security.
        /// </summary>
        public virtual decimal Leverage => Holdings.Leverage;
 
        /// <summary>
        /// If this uses tradebar data, return the most recent high.
        /// </summary>
        public virtual decimal High => Cache.High == 0 ? Price : Cache.High;
 
        /// <summary>
        /// If this uses tradebar data, return the most recent low.
        /// </summary>
        public virtual decimal Low => Cache.Low == 0 ? Price : Cache.Low;
 
        /// <summary>
        /// If this uses tradebar data, return the most recent close.
        /// </summary>
        public virtual decimal Close => Cache.Close == 0 ? Price : Cache.Close;
 
        /// <summary>
        /// If this uses tradebar data, return the most recent open.
        /// </summary>
        public virtual decimal Open => Cache.Open == 0 ? Price : Cache.Open;
 
        /// <summary>
        /// Access to the volume of the equity today
        /// </summary>
        public virtual decimal Volume => Cache.Volume;
 
        /// <summary>
        /// Gets the most recent bid price if available
        /// </summary>
        public virtual decimal BidPrice => Cache.BidPrice == 0 ? Price : Cache.BidPrice;
 
        /// <summary>
        /// Gets the most recent bid size if available
        /// </summary>
        public virtual decimal BidSize => Cache.BidSize;
 
        /// <summary>
        /// Gets the most recent ask price if available
        /// </summary>
        public virtual decimal AskPrice => Cache.AskPrice == 0 ? Price : Cache.AskPrice;
 
        /// <summary>
        /// Gets the most recent ask size if available
        /// </summary>
        public virtual decimal AskSize => Cache.AskSize;
 
        /// <summary>
        /// Access to the open interest of the security today
        /// </summary>
        public virtual long OpenInterest => Cache.OpenInterest;
 
        /// <summary>
        /// Gets the fundamental data associated with the security if there is any, otherwise null.
        /// </summary>
        public Fundamental Fundamentals
        {
            get
            {
                return new Fundamental(LocalTime, Symbol);
            }
        }
 
        /// <summary>
        /// Get the last price update set to the security if any else null
        /// </summary>
        /// <returns>BaseData object for this security</returns>
        public BaseData GetLastData() => Cache.GetData();
 
        /// <summary>
        /// Sets the <see cref="LocalTimeKeeper"/> to be used for this <see cref="Security"/>.
        /// This is the source of this instance's time.
        /// </summary>
        /// <param name="localTimeKeeper">The source of this <see cref="Security"/>'s time.</param>
        public virtual void SetLocalTimeKeeper(LocalTimeKeeper localTimeKeeper)
        {
            _localTimeKeeper = localTimeKeeper;
            Exchange.SetLocalDateTimeFrontierProvider(localTimeKeeper);
        }
 
        /// <summary>
        /// Update any security properties based on the latest market data and time
        /// </summary>
        /// <param name="data">New data packet from LEAN</param>
        public void SetMarketPrice(BaseData data)
        {
            //Add new point to cache:
            if (data == null) return;
            Cache.AddData(data);
 
            UpdateMarketPrice(data);
        }
 
        /// <summary>
        /// Updates all of the security properties, such as price/OHLCV/bid/ask based
        /// on the data provided. Data is also stored into the security's data cache
        /// </summary>
        /// <param name="data">The security update data</param>
        /// <param name="dataType">The data type</param>
        /// <param name="containsFillForwardData">Flag indicating whether
        /// <paramref name="data"/> contains any fill forward bar or not</param>
        public void Update(IReadOnlyList<BaseData> data, Type dataType, bool? containsFillForwardData = null)
        {
            Cache.AddDataList(data, dataType, containsFillForwardData);
 
            UpdateMarketPrice(data[data.Count - 1]);
        }
 
        /// <summary>
        /// Returns true if the security contains at least one subscription that represents custom data
        /// </summary>
        [Obsolete("This method is obsolete. Use the 'SubscriptionDataConfig' exposed by" +
            " 'SubscriptionManager' and the 'IsCustomData()' extension method")]
        public bool IsCustomData()
        {
            if (Subscriptions == null || !Subscriptions.Any())
            {
                return false;
            }
 
            return Subscriptions.Any(x => x.IsCustomData);
        }
 
        /// <summary>
        /// Set the leverage parameter for this security
        /// </summary>
        /// <param name="leverage">Leverage for this asset</param>
        public void SetLeverage(decimal leverage)
        {
            if (Symbol.ID.SecurityType == SecurityType.Future || Symbol.ID.SecurityType.IsOption())
            {
                return;
            }
 
            BuyingPowerModel.SetLeverage(this, leverage);
        }
 
        /// <summary>
        /// Sets the data normalization mode to be used by this security
        /// </summary>
        [Obsolete("This method is obsolete. Use the 'SubscriptionDataConfig' exposed by" +
            " 'SubscriptionManager' and the 'SetDataNormalizationMode()' extension method")]
        public virtual void SetDataNormalizationMode(DataNormalizationMode mode)
        {
            lock (_subscriptionsBag)
            {
                foreach (var subscription in _subscriptionsBag)
                {
                    subscription.DataNormalizationMode = mode;
                }
                UpdateSubscriptionProperties();
            }
        }
 
        /// <summary>
        /// This method will refresh the value of the <see cref="DataNormalizationMode"/> property.
        /// This is required for backward-compatibility.
        /// TODO: to be deleted with the DataNormalizationMode property
        /// </summary>
        public void RefreshDataNormalizationModeProperty()
        {
            lock (_subscriptionsBag)
            {
                DataNormalizationMode = _subscriptionsBag
                    .Select(x => x.DataNormalizationMode)
                    .DefaultIfEmpty(DataNormalizationMode.Adjusted)
                    .FirstOrDefault();
            }
        }
 
        /// <summary>
        /// Sets the fee model
        /// </summary>
        /// <param name="feelModel">Model that represents a fee model</param>
        public void SetFeeModel(IFeeModel feelModel)
        {
            FeeModel = feelModel;
        }
 
        /// <summary>
        /// Sets the fee model
        /// </summary>
        /// <param name="feelModel">Model that represents a fee model</param>
        public void SetFeeModel(PyObject feelModel)
        {
            FeeModel = new FeeModelPythonWrapper(feelModel);
        }
 
        /// <summary>
        /// Sets the fill model
        /// </summary>
        /// <param name="fillModel">Model that represents a fill model</param>
        public void SetFillModel(IFillModel fillModel)
        {
            FillModel = fillModel;
        }
 
        /// <summary>
        /// Sets the fill model
        /// </summary>
        /// <param name="fillModel">Model that represents a fill model</param>
        public void SetFillModel(PyObject fillModel)
        {
            FillModel = new FillModelPythonWrapper(fillModel);
        }
 
        /// <summary>
        /// Sets the settlement model
        /// </summary>
        /// <param name="settlementModel"> Model that represents a settlement model</param>
        public void SetSettlementModel(ISettlementModel settlementModel)
        {
            SettlementModel = settlementModel;
        }
 
        /// <summary>
        /// Sets the settlement model
        /// </summary>
        /// <param name="settlementModel">Model that represents a settlement model</param>
        public void SetSettlementModel(PyObject settlementModel)
        {
            SettlementModel = new SettlementModelPythonWrapper(settlementModel);
        }
 
        /// <summary>
        /// Sets the slippage model
        /// </summary>
        /// <param name="slippageModel">Model that represents a slippage model</param>
        public void SetSlippageModel(ISlippageModel slippageModel)
        {
            SlippageModel = slippageModel;
        }
 
        /// <summary>
        /// Sets the slippage model
        /// </summary>
        /// <param name="slippageModel">Model that represents a slippage model</param>
        public void SetSlippageModel(PyObject slippageModel)
        {
            SlippageModel = new SlippageModelPythonWrapper(slippageModel);
        }
 
        /// <summary>
        /// Sets the volatility model
        /// </summary>
        /// <param name="volatilityModel">Model that represents a volatility model</param>
        public void SetVolatilityModel(IVolatilityModel volatilityModel)
        {
            VolatilityModel = volatilityModel;
        }
 
        /// <summary>
        /// Sets the volatility model
        /// </summary>
        /// <param name="volatilityModel">Model that represents a volatility model</param>
        public void SetVolatilityModel(PyObject volatilityModel)
        {
            VolatilityModel = new VolatilityModelPythonWrapper(volatilityModel);
        }
 
        /// <summary>
        /// Sets the buying power model
        /// </summary>
        /// <param name="buyingPowerModel">Model that represents a security's model of buying power</param>
        public void SetBuyingPowerModel(IBuyingPowerModel buyingPowerModel)
        {
            BuyingPowerModel = buyingPowerModel;
        }
 
        /// <summary>
        /// Sets the buying power model
        /// </summary>
        /// <param name="pyObject">Model that represents a security's model of buying power</param>
        public void SetBuyingPowerModel(PyObject pyObject)
        {
            SetBuyingPowerModel(new BuyingPowerModelPythonWrapper(pyObject));
        }
 
        /// <summary>
        /// Sets the margin interests rate model
        /// </summary>
        /// <param name="marginInterestRateModel">Model that represents a security's model of margin interest rate</param>
        public void SetMarginInterestRateModel(IMarginInterestRateModel marginInterestRateModel)
        {
            MarginInterestRateModel = marginInterestRateModel;
        }
 
        /// <summary>
        /// Sets the margin interests rate model
        /// </summary>
        /// <param name="pyObject">Model that represents a security's model of margin interest rate</param>
        public void SetMarginInterestRateModel(PyObject pyObject)
        {
            SetMarginInterestRateModel(new MarginInterestRateModelPythonWrapper(pyObject));
        }
 
        /// <summary>
        /// Sets the margin model
        /// </summary>
        /// <param name="marginModel">Model that represents a security's model of buying power</param>
        public void SetMarginModel(IBuyingPowerModel marginModel)
        {
            MarginModel = marginModel;
        }
 
        /// <summary>
        /// Sets the margin model
        /// </summary>
        /// <param name="pyObject">Model that represents a security's model of buying power</param>
        public void SetMarginModel(PyObject pyObject)
        {
            SetMarginModel(new BuyingPowerModelPythonWrapper(pyObject));
        }
 
        /// <summary>
        /// Set Python Shortable Provider for this <see cref="Security"/>
        /// </summary>
        /// <param name="pyObject">Python class that represents a custom shortable provider</param>
        public void SetShortableProvider(PyObject pyObject)
        {
            if (pyObject.TryConvert<IShortableProvider>(out var shortableProvider))
            {
                SetShortableProvider(shortableProvider);
            }
            else if (Extensions.TryConvert<IShortableProvider>(pyObject, out _, allowPythonDerivative: true))
            {
                SetShortableProvider(new ShortableProviderPythonWrapper(pyObject));
            }
            else
            {
                using (Py.GIL())
                {
                    throw new Exception($"SetShortableProvider: {pyObject.Repr()} is not a valid argument");
                }
            }
        }
 
        /// <summary>
        /// Set Shortable Provider for this <see cref="Security"/>
        /// </summary>
        /// <param name="shortableProvider">Provider to use</param>
        public void SetShortableProvider(IShortableProvider shortableProvider)
        {
            ShortableProvider = shortableProvider;
        }
 
        /// <summary>
        /// Set Security Data Filter
        /// </summary>
        /// <param name="pyObject">Python class that represents a custom Security Data Filter</param>
        /// <exception cref="ArgumentException"></exception>
        public void SetDataFilter(PyObject pyObject)
        {
            if (pyObject.TryConvert<ISecurityDataFilter>(out var dataFilter))
            {
                SetDataFilter(dataFilter);
            }
            else if (Extensions.TryConvert<ISecurityDataFilter>(pyObject, out _, allowPythonDerivative: true))
            {
                SetDataFilter(new SecurityDataFilterPythonWrapper(pyObject));
            }
            else
            {
                using (Py.GIL())
                {
                    throw new ArgumentException($"SetDataFilter: {pyObject.Repr()} is not a valid argument");
                }
            }
        }
 
        /// <summary>
        /// Set Security Data Filter
        /// </summary>
        /// <param name="dataFilter">Security Data Filter</param>
        public void SetDataFilter(ISecurityDataFilter dataFilter)
        {
            DataFilter = dataFilter;
        }
 
        #region DynamicObject Overrides and Helper Methods
 
        /// <summary>
        /// This is a <see cref="DynamicObject"/> override. Not meant for external use.
        /// </summary>
        public override bool TryGetMember(GetMemberBinder binder, out object result)
        {
            return Cache.Properties.TryGetValue(binder.Name, out result);
        }
 
        /// <summary>
        /// This is a <see cref="DynamicObject"/> override. Not meant for external use.
        /// </summary>
        public override bool TrySetMember(SetMemberBinder binder, object value)
        {
            Cache.Properties[binder.Name] = value;
            return true;
        }
 
        /// <summary>
        /// This is a <see cref="DynamicObject"/> override. Not meant for external use.
        /// </summary>
        public override bool TryInvokeMember(InvokeMemberBinder binder, object[] args, out object result)
        {
            try
            {
                result = Cache.Properties.GetType().InvokeMember(binder.Name, BindingFlags.InvokeMethod, null, Cache.Properties, args,
                    CultureInfo.InvariantCulture);
                return true;
            }
            catch
            {
                result = null;
                return false;
            }
        }
 
        /// <summary>
        /// Adds the specified custom property.
        /// This allows us to use the security object as a dynamic object for quick storage.
        /// </summary>
        /// <param name="key">The property key</param>
        /// <param name="value">The property value</param>
        public void Add(string key, object value)
        {
            Cache.Properties[key] = value;
        }
 
        /// <summary>
        /// Gets the specified custom property
        /// </summary>
        /// <param name="key">The property key</param>
        /// <param name="value">The property value</param>
        /// <returns>True if the property is found.</returns>
        /// <exception cref="InvalidCastException">If the property is found but its value cannot be casted to the speficied type</exception>
        public bool TryGet<T>(string key, out T value)
        {
            if (Cache.Properties.TryGetValue(key, out var obj))
            {
                value = CastDynamicPropertyValue<T>(obj);
                return true;
            }
            value = default;
            return false;
        }
 
        /// <summary>
        /// Gets the specified custom property
        /// </summary>
        /// <param name="key">The property key</param>
        /// <returns>The property value is found</returns>
        /// <exception cref="KeyNotFoundException">If the property is not found</exception>
        public T Get<T>(string key)
        {
            return CastDynamicPropertyValue<T>(Cache.Properties[key]);
        }
 
        /// <summary>
        /// Removes a custom property.
        /// </summary>
        /// <param name="key">The property key</param>
        /// <returns>True if the property is successfully removed</returns>
        public bool Remove(string key)
        {
            return Cache.Properties.Remove(key);
        }
 
        /// <summary>
        /// Removes a custom property.
        /// </summary>
        /// <param name="key">The property key</param>
        /// <param name="value">The removed property value</param>
        /// <returns>True if the property is successfully removed</returns>
        public bool Remove<T>(string key, out T value)
        {
            value = default;
            var result = Cache.Properties.Remove(key, out object objectValue);
            if (result)
            {
                value = CastDynamicPropertyValue<T>(objectValue);
            }
            return result;
        }
 
        /// <summary>
        /// Removes every custom property that had been set.
        /// </summary>
        public void Clear()
        {
            Cache.Properties.Clear();
        }
 
        /// <summary>
        /// Gets or sets the specified custom property through the indexer.
        /// This is a wrapper around the <see cref="Get{T}(string)"/> and <see cref="Add(string,object)"/> methods.
        /// </summary>
        /// <param name="key">The property key</param>
        public object this[string key]
        {
            get
            {
                return Get<object>(key);
            }
            set
            {
                Add(key, value);
            }
        }
 
        #endregion
 
        /// <summary>
        /// Returns a string that represents the current object.
        /// </summary>
        /// <returns>
        /// A string that represents the current object.
        /// </returns>
        /// <filterpriority>2</filterpriority>
        public override string ToString()
        {
            return Symbol.ToString();
        }
 
        /// <summary>
        /// Adds the specified data subscription to this security.
        /// </summary>
        /// <param name="subscription">The subscription configuration to add. The Symbol and ExchangeTimeZone properties must match the existing Security object</param>
        internal void AddData(SubscriptionDataConfig subscription)
        {
            lock (_subscriptionsBag)
            {
                if (subscription.Symbol != Symbol)
                {
                    throw new ArgumentException(Messages.Security.UnmatchingSymbols, $"{nameof(subscription)}.{nameof(subscription.Symbol)}");
                }
                if (!subscription.ExchangeTimeZone.Equals(Exchange.TimeZone))
                {
                    throw new ArgumentException(Messages.Security.UnmatchingExchangeTimeZones, $"{nameof(subscription)}.{nameof(subscription.ExchangeTimeZone)}");
                }
                _subscriptionsBag.Add(subscription);
                UpdateSubscriptionProperties();
            }
        }
 
        /// <summary>
        /// Adds the specified data subscriptions to this security.
        /// </summary>
        /// <param name="subscriptions">The subscription configuration to add. The Symbol and ExchangeTimeZone properties must match the existing Security object</param>
        internal void AddData(SubscriptionDataConfigList subscriptions)
        {
            lock (_subscriptionsBag)
            {
                foreach (var subscription in subscriptions)
                {
                    if (subscription.Symbol != Symbol)
                    {
                        throw new ArgumentException(Messages.Security.UnmatchingSymbols, $"{nameof(subscription)}.{nameof(subscription.Symbol)}");
                    }
                    if (!subscription.ExchangeTimeZone.Equals(Exchange.TimeZone))
                    {
                         throw new ArgumentException(Messages.Security.UnmatchingExchangeTimeZones, $"{nameof(subscription)}.{nameof(subscription.ExchangeTimeZone)}");
                    }
                    _subscriptionsBag.Add(subscription);
                }
                UpdateSubscriptionProperties();
            }
        }
 
        /// <summary>
        /// Update market price of this Security
        /// </summary>
        /// <param name="data">Data to pull price from</param>
        protected virtual void UpdateConsumersMarketPrice(BaseData data)
        {
            if (data is OpenInterest || data.Price == 0m) return;
            Holdings.UpdateMarketPrice(Price);
            VolatilityModel.Update(this, data);
        }
 
        /// <summary>
        /// Caller should hold the lock on '_subscriptionsBag'
        /// </summary>
        private void UpdateSubscriptionProperties()
        {
            Resolution = _subscriptionsBag.Select(x => x.Resolution).DefaultIfEmpty(Resolution.Daily).Min();
            IsFillDataForward = _subscriptionsBag.Any(x => x.FillDataForward);
            IsExtendedMarketHours = _subscriptionsBag.Any(x => x.ExtendedMarketHours);
            RefreshDataNormalizationModeProperty();
        }
 
        /// <summary>
        /// Updates consumers market price. It will do nothing if the passed data type is auxiliary.
        /// </summary>
        private void UpdateMarketPrice(BaseData data)
        {
            if (data.DataType != MarketDataType.Auxiliary)
            {
                UpdateConsumersMarketPrice(data);
            }
        }
 
        /// <summary>
        /// Casts a dynamic property value to the specified type.
        /// Useful for cases where the property value is a PyObject and we want to cast it to the underlying type.
        /// </summary>
        private static T CastDynamicPropertyValue<T>(object obj)
        {
            T value;
            var pyObj = obj as PyObject;
            if (pyObj != null)
            {
                using (Py.GIL())
                {
                    value = pyObj.As<T>();
                }
            }
            else
            {
                value = (T)obj;
            }
 
            return value;
        }
 
        /// <summary>
        /// Applies the split to the security
        /// </summary>
        internal void ApplySplit(Split split)
        {
            Cache.ApplySplit(split);
            UpdateMarketPrice(Cache.GetData());
        }
 
        /// <summary>
        /// Updates the symbol properties of this security
        /// </summary>
        internal virtual void UpdateSymbolProperties(SymbolProperties symbolProperties)
        {
            if (symbolProperties != null)
            {
                SymbolProperties = symbolProperties;
            }
        }
    }
}