Files
quantconnect--lean/Common/Python/VolatilityModelPythonWrapper.cs
T
AlexCatarino dd14821e75 Enables custom volatility models in python algorithms
Creates a python wrapper for volatility models created in python algorithms and adds a method to the Security object to set such models.
Adds an algorithm to show how volatility models can be implemented.
2018-01-31 12:17:24 +00:00

79 lines
2.9 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;
using QuantConnect.Securities;
using System;
using System.Collections.Generic;
namespace QuantConnect.Python
{
/// <summary>
/// Provides a volatility model that wraps a <see cref="PyObject"/> object that represents a model that computes the volatility of a security
/// </summary>
public class VolatilityModelPythonWrapper : IVolatilityModel
{
private readonly dynamic _model;
/// <summary>
/// Constructor for initialising the <see cref="VolatilityModelPythonWrapper"/> class with wrapped <see cref="PyObject"/> object
/// </summary>
/// <param name="model"> Represents a model that computes the volatility of a security</param>
public VolatilityModelPythonWrapper(PyObject model)
{
_model = model;
}
/// <summary>
/// Gets the volatility of the security as a percentage
/// </summary>
public decimal Volatility
{
get
{
return _model.Volatility;
}
}
/// <summary>
/// Updates this model using the new price information in
/// the specified security instance
/// </summary>
/// <param name="security">The security to calculate volatility for</param>
/// <param name="data">The new data used to update the model</param>
public void Update(Security security, BaseData data)
{
using (Py.GIL())
{
_model.Update(security, data);
}
}
/// <summary>
/// Returns history requirements for the volatility model expressed in the form of history request
/// </summary>
/// <param name="security">The security of the request</param>
/// <param name="utcTime">The date/time of the request</param>
/// <returns>History request object list, or empty if no requirements</returns>
public IEnumerable<HistoryRequest> GetHistoryRequirements(Security security, DateTime utcTime)
{
using (Py.GIL())
{
return _model.GetHistoryRequirements(security, utcTime);
}
}
}
}