Files
quantconnect--lean/Common/Python/RiskFreeInterestRateModelPythonWrapper.cs
T
Jhonathan Abreu f8ca85cb5d Risk-Free Interest Rate Model (#7594)
* Implement risk free interest rate as an algorithm model

* Use risk free insterest rate model in Sharpe Ratio indicator

* Address peer review

Also added python wrapper

* Take pyobject as interest rate model in Sharpe Ratio indicator

* Minor fix

* Minor fix

* Address peer review
2023-11-22 16:17:34 -04:00

65 lines
2.6 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 System;
using Python.Runtime;
using QuantConnect.Data;
namespace QuantConnect.Python
{
/// <summary>
/// Wraps a <see cref="PyObject"/> object that represents a risk-free interest rate model
/// </summary>
public class RiskFreeInterestRateModelPythonWrapper : IRiskFreeInterestRateModel
{
private readonly dynamic _model;
/// <summary>
/// Constructor for initializing the <see cref="RiskFreeInterestRateModelPythonWrapper"/> class with wrapped <see cref="PyObject"/> object
/// </summary>
/// <param name="model">Represents a security's model of buying power</param>
public RiskFreeInterestRateModelPythonWrapper(PyObject model)
{
_model = model.ValidateImplementationOf<IRiskFreeInterestRateModel>();
}
/// <summary>
/// Get interest rate by a given date
/// </summary>
/// <param name="date">The date</param>
/// <returns>Interest rate on the given date</returns>
public decimal GetInterestRate(DateTime date)
{
using var _ = Py.GIL();
return (_model.GetInterestRate(date) as PyObject).GetAndDispose<decimal>();
}
/// <summary>
/// Converts a <see cref="PyObject"/> object into a <see cref="IRiskFreeInterestRateModel"/> object, wrapping it if necessary
/// </summary>
/// <param name="model">The Python model</param>
/// <returns>The converted <see cref="IRiskFreeInterestRateModel"/> instance</returns>
public static IRiskFreeInterestRateModel FromPyObject(PyObject model)
{
if (!model.TryConvert(out IRiskFreeInterestRateModel riskFreeInterestRateModel))
{
riskFreeInterestRateModel = new RiskFreeInterestRateModelPythonWrapper(model);
}
return riskFreeInterestRateModel;
}
}
}