Files
quantconnect--lean/Algorithm.Framework/Risk/RiskManagementModelPythonWrapper.cs
T
2018-05-07 16:14:13 -04:00

82 lines
3.3 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.Data.UniverseSelection;
using System;
using System.Collections.Generic;
using QuantConnect.Algorithm.Framework.Portfolio;
namespace QuantConnect.Algorithm.Framework.Risk
{
/// <summary>
/// Provides an implementation of <see cref="IRiskManagementModel"/> that wraps a <see cref="PyObject"/> object
/// </summary>
public class RiskManagementModelPythonWrapper : IRiskManagementModel
{
private readonly dynamic _model;
/// <summary>
/// Constructor for initialising the <see cref="IRiskManagementModel"/> class with wrapped <see cref="PyObject"/> object
/// </summary>
/// <param name="model">Model defining how risk is managed</param>
public RiskManagementModelPythonWrapper(PyObject model)
{
using (Py.GIL())
{
foreach (var attributeName in new[] { "ManageRisk", "OnSecuritiesChanged" })
{
if (!model.HasAttr(attributeName))
{
throw new NotImplementedException($"IRiskManagementModel.{attributeName} must be implemented. Please implement this missing method on {model.GetPythonType()}");
}
}
}
_model = model;
}
/// <summary>
/// Manages the algorithm's risk at each time step
/// </summary>
/// <param name="algorithm">The algorithm instance</param>
/// <param name="targets">The current portfolio targets to be assessed for risk</param>
public virtual IEnumerable<IPortfolioTarget> ManageRisk(QCAlgorithmFramework algorithm, IPortfolioTarget[] targets)
{
using (Py.GIL())
{
var riskTargetOverrides = _model.ManageRisk(algorithm, targets) as PyObject;
foreach (PyObject target in riskTargetOverrides)
{
yield return target.AsManagedObject(typeof(IPortfolioTarget)) as IPortfolioTarget;
}
riskTargetOverrides.Destroy();
}
}
/// <summary>
/// Event fired each time the we add/remove securities from the data feed
/// </summary>
/// <param name="algorithm">The algorithm instance that experienced the change in securities</param>
/// <param name="changes">The security additions and removals from the algorithm</param>
public virtual void OnSecuritiesChanged(QCAlgorithmFramework algorithm, SecurityChanges changes)
{
using (Py.GIL())
{
_model.OnSecuritiesChanged(algorithm, changes);
}
}
}
}