Files
quantconnect--lean/Common/Python/SettlementModelPythonWrapper.cs
T
Jhonathan Abreu 98a3fd4306 Delayed Settlement Cash Not Freed for Removed Assets (#7727)
* Delay security removal when there are pending settlements

* Add unit test

* Minor fixes

* Minor fix

* Replace HasUnsettledFunds method with UnsettledCash in ISettlementModel

* Minor fix

* Minor fix

* Address peer review

Replace ISettlementModel UnsettledCash property with GetUnsettledCash method that returns a CashAmount instead of a decimal to include the currency

* Minor fix

* Address peer review
2024-02-05 15:12:51 -03:00

79 lines
2.7 KiB
C#

/*
* 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 Python.Runtime;
using QuantConnect.Securities;
namespace QuantConnect.Python
{
/// <summary>
/// Provides an implementation of <see cref="ISettlementModel"/> that wraps a <see cref="PyObject"/> object
/// </summary>
public class SettlementModelPythonWrapper : ISettlementModel
{
private readonly dynamic _model;
/// Constructor for initialising the <see cref="SettlementModelPythonWrapper"/> class with wrapped <see cref="PyObject"/> object
/// </summary>
/// <param name="model">Settlement Python Model</param>
public SettlementModelPythonWrapper(PyObject model)
{
_model = model.ValidateImplementationOf<ISettlementModel>();
}
/// <summary>
/// Applies cash settlement rules using the method defined in the Python class
/// </summary>
/// <param name="applyFundsParameters">The funds application parameters</param>
public void ApplyFunds(ApplyFundsSettlementModelParameters applyFundsParameters)
{
using (Py.GIL())
{
_model.ApplyFunds(applyFundsParameters);
}
}
/// <summary>
/// Scan for pending settlements using the method defined in the Python class
/// </summary>
/// <param name="settlementParameters">The settlement parameters</param>
public void Scan(ScanSettlementModelParameters settlementParameters)
{
using (Py.GIL())
{
_model.Scan(settlementParameters);
}
}
/// <summary>
/// Gets the unsettled cash amount for the security
/// </summary>
public CashAmount GetUnsettledCash()
{
using (Py.GIL())
{
var result = _model.GetUnsettledCash();
if (result == null)
{
return default;
}
return result;
}
}
}
}