Files
quantconnect--lean/Tests/Python/DataConsolidatorPythonWrapperTests.cs
2026-07-13 13:02:50 +08:00

464 lines
20 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 NUnit.Framework;
using Python.Runtime;
using System.Collections.Generic;
using System.Linq;
using QuantConnect.Data;
using QuantConnect.Data.Consolidators;
using QuantConnect.Data.Market;
using QuantConnect.Python;
using QuantConnect.Algorithm;
using QuantConnect.Tests.Engine.DataFeeds;
using QuantConnect.Statistics;
using QuantConnect.Tests.Common.Data;
namespace QuantConnect.Tests.Python
{
[TestFixture]
public class DataConsolidatorPythonWrapperTests: BaseConsolidatorTests
{
[Test]
public void UpdatePyConsolidator()
{
using (Py.GIL())
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"class CustomConsolidator(PythonConsolidator):\n" +
" def __init__(self):\n" +
" self.update_was_called = False\n" +
" self.input_type = QuoteBar\n" +
" self.output_type = QuoteBar\n" +
" self.consolidated = None\n" +
" self.working_data = None\n" +
" def update(self, data):\n" +
" self.update_was_called = True\n" +
" def scan(self, time):\n" +
" pass\n");
var customConsolidator = module.GetAttr("CustomConsolidator").Invoke();
using var wrapper = new DataConsolidatorPythonWrapper(customConsolidator);
var time = DateTime.Today;
var period = TimeSpan.FromMinutes(1);
var bar1 = new QuoteBar
{
Time = time,
Symbol = Symbols.SPY,
Bid = new Bar(1, 2, 0.75m, 1.25m),
LastBidSize = 3,
Ask = null,
LastAskSize = 0,
Value = 1,
Period = period
};
wrapper.Update(bar1);
bool called;
customConsolidator.GetAttr("update_was_called").TryConvert(out called);
Assert.True(called);
}
}
[Test]
public void ScanPyConsolidator()
{
using (Py.GIL())
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"class CustomConsolidator(PythonConsolidator):\n" +
" def __init__(self):\n" +
" self.scan_was_called = False\n" +
" self.input_type = QuoteBar\n" +
" self.output_type = QuoteBar\n" +
" self.consolidated = None\n" +
" self.working_data = None\n" +
" def update(self, data):\n" +
" pass\n" +
" def scan(self, time):\n" +
" self.scan_was_called = True\n");
var customConsolidator = module.GetAttr("CustomConsolidator").Invoke();
using var wrapper = new DataConsolidatorPythonWrapper(customConsolidator);
var time = DateTime.Today;
var period = TimeSpan.FromMinutes(1);
wrapper.Scan(DateTime.Now);
bool called;
customConsolidator.GetAttr("scan_was_called").TryConvert(out called);
Assert.True(called);
}
}
[Test]
public void InputTypePyConsolidator()
{
using (Py.GIL())
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"class CustomConsolidator(PythonConsolidator):\n" +
" def __init__(self):\n" +
" self.input_type = QuoteBar\n" +
" self.output_type = QuoteBar\n" +
" self.consolidated = None\n" +
" self.working_data = None\n" +
" def update(self, data):\n" +
" pass\n" +
" def scan(self, time):\n" +
" pass\n");
var customConsolidator = module.GetAttr("CustomConsolidator").Invoke();
using var wrapper = new DataConsolidatorPythonWrapper(customConsolidator);
var time = DateTime.Today;
var period = TimeSpan.FromMinutes(1);
var type = wrapper.InputType;
Assert.True(type == typeof(QuoteBar));
}
}
[Test]
public void OutputTypePyConsolidator()
{
using (Py.GIL())
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"class CustomConsolidator(PythonConsolidator):\n" +
" def __init__(self):\n" +
" self.input_type = QuoteBar\n" +
" self.output_type = QuoteBar\n" +
" self.consolidated = None\n" +
" self.working_data = None\n" +
" def update(self, data):\n" +
" pass\n" +
" def scan(self, time):\n" +
" pass\n");
var customConsolidator = module.GetAttr("CustomConsolidator").Invoke();
using var wrapper = new DataConsolidatorPythonWrapper(customConsolidator);
var time = DateTime.Today;
var period = TimeSpan.FromMinutes(1);
var type = wrapper.OutputType;
Assert.True(type == typeof(QuoteBar));
}
}
[Test]
public void RunRegressionAlgorithm()
{
var parameter = new RegressionTests.AlgorithmStatisticsTestParameters("CustomConsolidatorRegressionAlgorithm",
new Dictionary<string, string> {
{PerformanceMetrics.TotalOrders, "15"},
{"Average Win", "0.42%"},
{"Average Loss", "-0.03%"},
{"Compounding Annual Return", "76.673%"},
{"Drawdown", "0.200%"},
{"Expectancy", "4.239"},
{"Net Profit", "1.203%"},
{"Sharpe Ratio", "7.908"},
{"Probabilistic Sharpe Ratio", "94.373%"},
{"Loss Rate", "62%"},
{"Win Rate", "38%"},
{"Profit-Loss Ratio", "12.97"},
{"Alpha", "0.408"},
{"Beta", "0.35"},
{"Annual Standard Deviation", "0.067"},
{"Annual Variance", "0.005"},
{"Information Ratio", "1.484"},
{"Tracking Error", "0.117"},
{"Treynor Ratio", "1.526"},
{"Total Fees", "$24.34"}
},
Language.Python,
AlgorithmStatus.Completed);
AlgorithmRunner.RunLocalBacktest(parameter.Algorithm,
parameter.Statistics,
parameter.Language,
parameter.ExpectedFinalStatus);
}
[Test]
public void WindowIsPopulatedOnConsolidation()
{
using (Py.GIL())
{
using var wrapper = CreateFedPythonWrapper(1);
Assert.AreEqual(1, wrapper.Window.Count);
Assert.IsNotNull(wrapper.Consolidated);
Assert.AreEqual(wrapper.Consolidated, wrapper[0]);
}
}
[Test]
public void WindowKeepsPreviousConsolidatedBar()
{
using (Py.GIL())
{
using var wrapper = CreateFedPythonWrapper(1);
var firstConsolidated = wrapper.Consolidated;
FeedConsolidation(wrapper, 1);
Assert.AreEqual(2, wrapper.Window.Count);
Assert.AreNotEqual(firstConsolidated, wrapper[0]);
Assert.AreEqual(firstConsolidated, wrapper[1]);
Assert.AreEqual(firstConsolidated, wrapper.Previous);
}
}
[Test]
public void CanIterateOverConsolidatedBars()
{
using (Py.GIL())
{
using var wrapper = CreateFedPythonWrapper(2);
var bars = wrapper.ToList();
Assert.AreEqual(2, bars.Count);
Assert.AreEqual(wrapper[0], bars[0]);
Assert.AreEqual(wrapper[1], bars[1]);
}
}
[Test]
public void ResetClearsWindow()
{
using (Py.GIL())
{
using var wrapper = CreateFedPythonWrapper(1);
wrapper.Reset();
Assert.AreEqual(0, wrapper.Window.Count);
Assert.IsNull(wrapper.Consolidated);
}
}
private static DataConsolidatorPythonWrapper CreateFedPythonWrapper(int consolidations)
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"class CustomConsolidator(QuoteBarConsolidator):\n" +
" def __init__(self):\n" +
" super().__init__(timedelta(minutes=2))\n");
var wrapper = new DataConsolidatorPythonWrapper(module.GetAttr("CustomConsolidator").Invoke());
FeedConsolidation(wrapper, consolidations);
return wrapper;
}
private static void FeedConsolidation(DataConsolidatorPythonWrapper wrapper, int consolidations)
{
var offset = wrapper.Window.Count * 2;
var time = DateTime.Today;
for (var i = 0; i < consolidations; i++)
{
var bar = new QuoteBar { Time = time.AddMinutes(offset + i * 2), Symbol = Symbols.SPY, Bid = new Bar(1, 2, 0.75m, 1.25m), LastBidSize = 3, Value = 1, Period = TimeSpan.FromMinutes(1) };
wrapper.Update(bar);
wrapper.Scan(time.AddMinutes(offset + (i + 1) * 2));
}
}
[Test]
public void PythonConsolidatorSubclassExposesWindow()
{
// custom consolidators that inherit PythonConsolidator (the documented path) must expose the
// rolling window just like the C# consolidators, not only the ones routed through the wrapper
using (Py.GIL())
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"class CustomConsolidator(PythonConsolidator):\n" +
" def __init__(self):\n" +
" self.input_type = QuoteBar\n" +
" self.output_type = QuoteBar\n" +
" self.consolidated = None\n" +
" self.working_data = None\n" +
" def update(self, data):\n" +
" pass\n" +
" def scan(self, time):\n" +
" pass\n");
var customConsolidator = module.GetAttr("CustomConsolidator").Invoke();
var consolidator = customConsolidator.As<PythonConsolidator>();
var time = DateTime.Today;
var bar1 = new QuoteBar { Time = time, Symbol = Symbols.SPY, Bid = new Bar(1, 2, 0.75m, 1.25m), Value = 1, Period = TimeSpan.FromMinutes(1) };
var bar2 = new QuoteBar { Time = time.AddMinutes(1), Symbol = Symbols.SPY, Bid = new Bar(1, 2, 0.75m, 1.25m), Value = 2, Period = TimeSpan.FromMinutes(1) };
consolidator.OnDataConsolidated(customConsolidator, bar1);
consolidator.OnDataConsolidated(customConsolidator, bar2);
Assert.AreEqual(2, consolidator.Window.Count);
Assert.AreEqual(bar2, consolidator[0]);
Assert.AreEqual(bar1, consolidator.Previous);
consolidator.Reset();
Assert.AreEqual(0, consolidator.Window.Count);
}
}
[Test]
public void AttachAndTriggerEvent()
{
using (Py.GIL())
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"class ImplementingClass():\n" +
" def __init__(self):\n" +
" self.EventCalled = False\n" +
" self.Consolidator = CustomConsolidator(timedelta(minutes=2))\n" +
" self.Consolidator.DataConsolidated += self.ConsolidatorEvent\n" +
" def ConsolidatorEvent(self, sender, bar):\n" +
" self.EventCalled = True\n" +
"class CustomConsolidator(QuoteBarConsolidator):\n" +
" def __init__(self,span):\n" +
" super().__init__(span)\n" +
" self.Span = span\n");
var implementingClass = module.GetAttr("ImplementingClass").Invoke();
var customConsolidator = implementingClass.GetAttr("Consolidator");
using var wrapper = new DataConsolidatorPythonWrapper(customConsolidator);
bool called;
implementingClass.GetAttr("EventCalled").TryConvert(out called);
Assert.False(called);
var time = DateTime.Today;
var period = TimeSpan.FromMinutes(1);
var bar1 = new QuoteBar
{
Time = time,
Symbol = Symbols.SPY,
Bid = new Bar(1, 2, 0.75m, 1.25m),
LastBidSize = 3,
Ask = null,
LastAskSize = 0,
Value = 1,
Period = period
};
wrapper.Update(bar1);
wrapper.Scan(time.AddMinutes(2));
implementingClass.GetAttr("EventCalled").TryConvert(out called);
Assert.True(called);
}
}
[Test]
public void SubscriptionManagedDoesNotWrapCSharpConsolidators()
{
//Setup algorithm and Equity
var algorithm = new QCAlgorithm();
algorithm.SubscriptionManager.SetDataManager(new DataManagerStub(algorithm));
var spy = algorithm.AddEquity("SPY").Symbol;
using (Py.GIL())
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"consolidator = QuoteBarConsolidator(timedelta(5))");
var pyConsolidator = module.GetAttr("consolidator");
algorithm.SubscriptionManager.AddConsolidator(spy, pyConsolidator);
pyConsolidator.TryConvert(out IDataConsolidator consolidator);
algorithm.SubscriptionManager.RemoveConsolidator(spy, consolidator);
var count = algorithm.SubscriptionManager
.SubscriptionDataConfigService
.GetSubscriptionDataConfigs(spy)
.Sum(x => x.Consolidators.Count);
Assert.AreEqual(0, count);
consolidator.Dispose();
}
}
protected override IEnumerable<IBaseData> GetTestValues()
{
var time = DateTime.Today;
return new List<QuoteBar>()
{
new QuoteBar(){Time = time, Symbol = Symbols.SPY, Bid = new Bar(1, 2, 0.5m, 1.75m), Ask = new Bar(2.2m, 4.4m, 3.3m, 3.3m), LastBidSize = 10, LastAskSize = 0 },
new QuoteBar(){Time = time, Symbol = Symbols.SPY, Bid = new Bar(0, 4, 0.4m, 3.75m), Ask = new Bar(2.3m, 9.4m, 2.3m, 4.5m), LastBidSize = 5, LastAskSize = 4 },
new QuoteBar(){Time = time, Symbol = Symbols.SPY, Bid = new Bar(2, 2, 0.9m, 1.45m), Ask = new Bar(2.7m, 8.4m, 3.6m, 3.6m), LastBidSize = 8, LastAskSize = 4 },
new QuoteBar(){Time = time, Symbol = Symbols.SPY, Bid = new Bar(2, 6, 2.5m, 5.55m), Ask = new Bar(3.2m, 6.4m, 2.3m, 5.3m), LastBidSize = 9, LastAskSize = 4 },
new QuoteBar(){Time = time, Symbol = Symbols.SPY, Bid = new Bar(1, 2, 1.5m, 0.34m), Ask = new Bar(3.6m, 9.4m, 3.7m, 3.8m), LastBidSize = 5, LastAskSize = 8 },
new QuoteBar(){Time = time, Symbol = Symbols.SPY, Bid = new Bar(1, 2, 1.1m, 0.75m), Ask = new Bar(3.8m, 8.4m, 7.3m, 5.3m), LastBidSize = 9, LastAskSize = 5 },
new QuoteBar(){Time = time, Symbol = Symbols.SPY, Bid = new Bar(3, 3, 2.2m, 1.12m), Ask = new Bar(4.5m, 7.2m, 7.1m, 6.1m), LastBidSize = 6, LastAskSize = 3 },
};
}
protected override void AssertConsolidator(IDataConsolidator consolidator)
{
base.AssertConsolidator(consolidator);
using (Py.GIL())
{
var pythonConsolidator = consolidator as TestDataConsolidatorPythonWrapper;
pythonConsolidator.RawIndicator.GetAttr("update_was_called").TryConvert(out bool pythonConsolidatorUpdateWasCalled);
Assert.IsFalse(pythonConsolidatorUpdateWasCalled);
}
}
protected override IDataConsolidator CreateConsolidator()
{
using (Py.GIL())
{
var module = PyModule.FromString(Guid.NewGuid().ToString(),
"from AlgorithmImports import *\n" +
"class CustomConsolidator(PythonConsolidator):\n" +
" def __init__(self):\n" +
" self.update_was_called = False\n" +
" self.input_type = QuoteBar\n" +
" self.output_type = QuoteBar\n" +
" self.consolidated = None\n" +
" self.working_data = None\n" +
" def update(self, data):\n" +
" self.update_was_called = True\n" +
" def scan(self, time):\n" +
" pass\n" +
" def reset(self):\n" +
" self.update_was_called = False\n");
var customConsolidator = module.GetAttr("CustomConsolidator").Invoke();
return new TestDataConsolidatorPythonWrapper(customConsolidator);
}
}
public class TestDataConsolidatorPythonWrapper : DataConsolidatorPythonWrapper
{
public PyObject RawIndicator { get; set; }
public TestDataConsolidatorPythonWrapper(PyObject consolidator) : base(consolidator)
{
RawIndicator = consolidator;
}
}
}
}