/*
* 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.Data.Market;
using QuantConnect.Indicators;
using QuantConnect.Util;
using System;
using System.Collections.Generic;
using System.Linq;
namespace QuantConnect.Python
{
///
/// Collection of methods that converts lists of objects in pandas.DataFrame
///
public class PandasConverter
{
private static dynamic _pandas;
private static PyObject _concat;
///
/// Creates an instance of .
///
public PandasConverter()
{
if (_pandas == null)
{
using (Py.GIL())
{
var pandas = Py.Import("pandas");
_pandas = pandas;
// keep it so we don't need to ask for it each time
_concat = pandas.GetAttr("concat");
}
}
}
///
/// Converts an enumerable of in a pandas.DataFrame
///
/// Enumerable of
/// Optional type of bars to add to the data frame
/// containing a pandas.DataFrame
public PyObject GetDataFrame(IEnumerable data, Type dataType = null)
{
var maxLevels = 0;
var sliceDataDict = new Dictionary();
// if no data type is requested we check all
var requestedTick = dataType == null || dataType == typeof(Tick) || dataType == typeof(OpenInterest);
var requestedTradeBar = dataType == null || dataType == typeof(TradeBar);
var requestedQuoteBar = dataType == null || dataType == typeof(QuoteBar);
foreach (var slice in data)
{
AddSliceDataTypeDataToDict(slice, requestedTick, requestedTradeBar, requestedQuoteBar, sliceDataDict, ref maxLevels, dataType);
}
using (Py.GIL())
{
if (sliceDataDict.Count == 0)
{
return _pandas.DataFrame();
}
using var dataFrames = sliceDataDict.Select(x => x.Value.ToPandasDataFrame(maxLevels)).ToPyListUnSafe();
using var sortDic = Py.kw("sort", true);
var result = _concat.Invoke(new[] { dataFrames }, sortDic);
foreach (var df in dataFrames)
{
df.Dispose();
}
return result;
}
}
///
/// Converts an enumerable of in a pandas.DataFrame
///
/// Enumerable of
/// containing a pandas.DataFrame
/// Helper method for testing
public PyObject GetDataFrame(IEnumerable data)
where T : IBaseData
{
PandasData sliceData = null;
foreach (var datum in data)
{
if (sliceData == null)
{
sliceData = new PandasData(datum);
}
sliceData.Add(datum);
}
using (Py.GIL())
{
// If sliceData is still null, data is an empty enumerable
// returns an empty pandas.DataFrame
if (sliceData == null)
{
return _pandas.DataFrame();
}
return sliceData.ToPandasDataFrame();
}
}
///
/// Converts a dictionary with a list of in a pandas.DataFrame
///
/// Dictionary with a list of
/// containing a pandas.DataFrame
public PyObject GetIndicatorDataFrame(IEnumerable>> data)
{
using (Py.GIL())
{
var pyDict = new PyDict();
foreach (var kvp in data)
{
AddSeriesToPyDict(kvp.Key, kvp.Value, pyDict);
}
return MakeIndicatorDataFrame(pyDict);
}
}
///
/// Converts a dictionary with a list of in a pandas.DataFrame
///
/// that should be a dictionary (convertible to PyDict) of string to list of
/// containing a pandas.DataFrame
public PyObject GetIndicatorDataFrame(PyObject data)
{
using (Py.GIL())
{
using var inputPythonType = data.GetPythonType();
var inputTypeStr = inputPythonType.ToString();
var targetTypeStr = nameof(PyDict);
PyObject currentKvp = null;
try
{
using var pyDictData = new PyDict(data);
using var seriesPyDict = new PyDict();
targetTypeStr = $"{nameof(String)}: {nameof(List)}";
foreach (var kvp in pyDictData.Items())
{
currentKvp = kvp;
AddSeriesToPyDict(kvp[0].As(), kvp[1].As>(), seriesPyDict);
}
return MakeIndicatorDataFrame(seriesPyDict);
}
catch (Exception e)
{
if (currentKvp != null)
{
inputTypeStr = $"{currentKvp[0].GetPythonType()}: {currentKvp[1].GetPythonType()}";
}
throw new ArgumentException(Messages.PandasConverter.ConvertToDictionaryFailed(inputTypeStr, targetTypeStr, e.Message), e);
}
}
}
///
/// Returns a string that represent the current object
///
///
public override string ToString()
{
return _pandas == null
? Messages.PandasConverter.PandasModuleNotImported
: _pandas.Repr();
}
///
/// Creates a series from a list of and adds it to the
/// as the value of the given
///
/// Key to insert in the
/// List of that will make up the resulting series
/// where the resulting key-value pair will be inserted into
private void AddSeriesToPyDict(string key, List points, PyDict pyDict)
{
var index = new List();
var values = new List();
foreach (var point in points)
{
index.Add(point.EndTime);
values.Add((double) point.Value);
}
pyDict.SetItem(key.ToLowerInvariant(), _pandas.Series(values, index));
}
///
/// Converts a of string to pandas.Series in a pandas.DataFrame
///
/// of string to pandas.Series
/// containing a pandas.DataFrame
private PyObject MakeIndicatorDataFrame(PyDict pyDict)
{
return _pandas.DataFrame(pyDict, columns: pyDict.Keys().Select(x => x.As().ToLowerInvariant()).OrderBy(x => x));
}
///
/// Gets the for the given symbol if it exists in the dictionary, otherwise it creates a new instance with the
/// given base data and adds it to the dictionary
///
private PandasData GetPandasDataValue(IDictionary sliceDataDict, Symbol symbol, object data, ref int maxLevels)
{
PandasData value;
if (!sliceDataDict.TryGetValue(symbol.ID, out value))
{
sliceDataDict[symbol.ID] = value = new PandasData(data);
maxLevels = Math.Max(maxLevels, value.Levels);
}
return value;
}
///
/// Adds each slice data corresponding to the requested data type to the pandas data dictionary
///
private void AddSliceDataTypeDataToDict(Slice slice, bool requestedTick, bool requestedTradeBar, bool requestedQuoteBar, IDictionary sliceDataDict, ref int maxLevels, Type dataType = null)
{
HashSet _addedData = null;
for (int i = 0; i < slice.AllData.Count; i++)
{
var baseData = slice.AllData[i];
var value = GetPandasDataValue(sliceDataDict, baseData.Symbol, baseData, ref maxLevels);
if (value.IsCustomData)
{
value.Add(baseData);
}
else
{
var tick = requestedTick ? baseData as Tick : null;
if(tick == null)
{
if (!requestedTradeBar && !requestedQuoteBar && dataType != null && baseData.GetType().IsAssignableTo(dataType))
{
// support for auxiliary data history requests
value.Add(baseData);
continue;
}
// we add both quote and trade bars for each symbol at the same time, because they share the row in the data frame else it will generate 2 rows per series
if (requestedTradeBar && requestedQuoteBar)
{
_addedData ??= new();
if (!_addedData.Add(baseData.Symbol.ID))
{
continue;
}
}
// the slice already has the data organized by symbol so let's take advantage of it using Bars/QuoteBars collections
QuoteBar quoteBar = null;
var tradeBar = requestedTradeBar ? baseData as TradeBar : null;
if (tradeBar != null)
{
slice.QuoteBars.TryGetValue(tradeBar.Symbol, out quoteBar);
}
else
{
quoteBar = requestedQuoteBar ? baseData as QuoteBar : null;
if (quoteBar != null)
{
slice.Bars.TryGetValue(quoteBar.Symbol, out tradeBar);
}
}
value.Add(tradeBar, quoteBar);
}
else
{
value.AddTick(tick);
}
}
}
}
}
}