Skip to content

Commit

Permalink
Fix TimeRules time zone issues
Browse files Browse the repository at this point in the history
- `ITimeRules` are expected to yield time date in UTC, fixing `Noon`,
`Midnight` and `Every`
- `ScheduledUniverseSelectionModel` will use UTC time zone by default
since that is the default expected time zone `ITimeRule` provides
- Adding regression test
  • Loading branch information
Martin-Molinero committed Nov 4, 2019
1 parent aaf81ef commit 98ae5cd
Show file tree
Hide file tree
Showing 5 changed files with 157 additions and 10 deletions.
1 change: 1 addition & 0 deletions Algorithm.CSharp/QuantConnect.Algorithm.CSharp.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@
<Compile Include="ConfidenceWeightedFrameworkAlgorithm.cs" />
<Compile Include="FreePortfolioValueRegressionAlgorithm.cs" />
<Compile Include="MarginRemainingRegressionAlgorithm.cs" />
<Compile Include="TimeRulesDefaultTimeZoneRegressionAlgorithm.cs" />
<Compile Include="SmartInsiderDataAlgorithm.cs" />
<Compile Include="BasicTemplateAlgorithm.cs" />
<Compile Include="Benchmarks\StatefulCoarseUniverseSelectionBenchmark.cs" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
namespace QuantConnect.Algorithm.CSharp
{
/// <summary>
/// Regression algortihm for testing <see cref="ScheduledUniverseSelectionModel"/> scheduling functions
/// Regression algorithm for testing <see cref="ScheduledUniverseSelectionModel"/> scheduling functions
/// </summary>
public class ScheduledUniverseSelectionModelRegressionAlgorithm : QCAlgorithm, IRegressionAlgorithmDefinition
{
Expand All @@ -37,7 +37,7 @@ public override void Initialize()
SetStartDate(2017, 01, 01);
SetEndDate(2017, 02, 01);

// selection will run on mon/tues/thurs at 00:00/06:00/12:00/18:00
// selection will run on mon/tues/thurs at 00:00/12:00
SetUniverseSelection(new ScheduledUniverseSelectionModel(
DateRules.Every(DayOfWeek.Monday, DayOfWeek.Tuesday, DayOfWeek.Thursday),
TimeRules.Every(TimeSpan.FromHours(12)),
Expand All @@ -50,6 +50,7 @@ public override void Initialize()

private IEnumerable<Symbol> SelectSymbols(DateTime dateTime)
{
Log($"SelectSymbols() {Time}");
if (dateTime.DayOfWeek == DayOfWeek.Monday || dateTime.DayOfWeek == DayOfWeek.Tuesday)
{
yield return QuantConnect.Symbol.Create("SPY", SecurityType.Equity, Market.USA);
Expand Down Expand Up @@ -194,7 +195,7 @@ private void ExpectRemovals(SecurityChanges changes, params string[] tickers)
{"Total Trades", "52"},
{"Average Win", "0.27%"},
{"Average Loss", "-0.17%"},
{"Compounding Annual Return", "43.400%"},
{"Compounding Annual Return", "42.607%"},
{"Drawdown", "1.000%"},
{"Expectancy", "0.770"},
{"Net Profit", "3.211%"},
Expand All @@ -216,7 +217,7 @@ private void ExpectRemovals(SecurityChanges changes, params string[] tickers)
{"Long Insight Count", "54"},
{"Short Insight Count", "0"},
{"Long/Short Ratio", "100%"},
{"Estimated Monthly Alpha Value", "$530336.0642"},
{"Estimated Monthly Alpha Value", "$522229.0161"},
{"Total Accumulated Estimated Alpha Value", "$569374.6912"},
{"Mean Population Estimated Insight Value", "$10949.5133"},
{"Mean Population Direction", "59.6154%"},
Expand Down
143 changes: 143 additions & 0 deletions Algorithm.CSharp/TimeRulesDefaultTimeZoneRegressionAlgorithm.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
/*
* 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 System.Collections.Generic;
using QuantConnect.Algorithm.Framework.Selection;
using QuantConnect.Interfaces;

namespace QuantConnect.Algorithm.CSharp
{
/// <summary>
/// Regression algorithm which reproduces GH issue 3740.
/// We assert the methods are triggered at the correct algorithm time
/// </summary>
public class TimeRulesDefaultTimeZoneRegressionAlgorithm : QCAlgorithm, IRegressionAlgorithmDefinition
{
private int _scheduleEventEveryCallCount;
private int _scheduleEventNoonCallCount;
private int _scheduleEventMidnightCallCount;
private int _selectionMethodCallCount;

public override void Initialize()
{
SetStartDate(2017, 01, 01);
SetEndDate(2017, 02, 01);

SetUniverseSelection(new ScheduledUniverseSelectionModel(
DateRules.EveryDay(),
TimeRules.At(9, 31),
SelectSymbolsAt
));

Schedule.On(DateRules.EveryDay(), TimeRules.Every(TimeSpan.FromHours(6)), () =>
{
_scheduleEventEveryCallCount++;
if (Time.Hour != 0
&& Time.Hour != 6
&& Time.Hour != 12
&& Time.Hour != 18)
{
throw new Exception($"Unexpected every 6 hours scheduled event time: {Time}");
}
});

Schedule.On(DateRules.EveryDay(), TimeRules.Noon, () =>
{
_scheduleEventNoonCallCount++;
if (Time.Hour != 12)
{
throw new Exception($"Unexpected Noon scheduled event time: {Time}");
}
});

Schedule.On(DateRules.EveryDay(), TimeRules.Midnight, () =>
{
_scheduleEventMidnightCallCount++;
if (Time.Hour != 0)
{
throw new Exception($"Unexpected Midnight scheduled event time: {Time}");
}
});
}

private IEnumerable<Symbol> SelectSymbolsAt(DateTime dateTime)
{
_selectionMethodCallCount++;
Log($"SelectSymbolsAt {Time}");
if (Time.TimeOfDay != new TimeSpan(9, 31, 0))
{
throw new Exception($"Expected 'SelectSymbolsAt' to be called at 9:31 algorithm time: {Time}");
}
yield break;
}

public override void OnEndOfAlgorithm()
{
if (_selectionMethodCallCount != 32)
{
throw new Exception($"Unexpected universe selection call count: {_selectionMethodCallCount}");
}
if (_scheduleEventEveryCallCount != 130)
{
throw new Exception($"Unexpected scheduled event call count: {_scheduleEventEveryCallCount}");
}
if (_scheduleEventNoonCallCount != 32)
{
throw new Exception($"Unexpected scheduled event call count: {_scheduleEventNoonCallCount}");
}
if (_scheduleEventMidnightCallCount != 33)
{
throw new Exception($"Unexpected scheduled event call count: {_scheduleEventMidnightCallCount}");
}
}

/// <summary>
/// This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.
/// </summary>
public bool CanRunLocally { get; } = true;

/// <summary>
/// This is used by the regression test system to indicate which languages this algorithm is written in.
/// </summary>
public Language[] Languages { get; } = { Language.CSharp };

/// <summary>
/// This is used by the regression test system to indicate what the expected statistics are from running the algorithm
/// </summary>
public Dictionary<string, string> ExpectedStatistics => new Dictionary<string, string>
{
{"Total Trades", "0"},
{"Average Win", "0%"},
{"Average Loss", "0%"},
{"Compounding Annual Return", "0%"},
{"Drawdown", "0%"},
{"Expectancy", "0"},
{"Net Profit", "0%"},
{"Sharpe Ratio", "0"},
{"Loss Rate", "0%"},
{"Win Rate", "0%"},
{"Profit-Loss Ratio", "0"},
{"Alpha", "0"},
{"Beta", "0"},
{"Annual Standard Deviation", "0"},
{"Annual Variance", "0"},
{"Information Ratio", "0"},
{"Tracking Error", "0"},
{"Treynor Ratio", "0"},
{"Total Fees", "$0.00"}
};
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@ public ScheduledUniverseSelectionModel(DateTimeZone timeZone, IDateRule dateRule
public override IEnumerable<Universe> CreateUniverses(QCAlgorithm algorithm)
{
yield return new ScheduledUniverse(
_timeZone ?? algorithm.TimeZone,
// by default ITimeRule yields in UTC
_timeZone ?? TimeZones.Utc,
_dateRule,
_timeRule,
_selector,
Expand Down
11 changes: 6 additions & 5 deletions Common/Scheduling/TimeRules.cs
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ public void SetDefaultTimeZone(DateTimeZone timeZone)
/// <summary>
/// Convenience property for running a scheduled event at midnight in the algorithm time zone
/// </summary>
public ITimeRule Midnight => new FuncTimeRule("Midnight", dates => dates.Select(date => date.ConvertFromUtc(_timeZone).Date));
public ITimeRule Midnight => new FuncTimeRule("Midnight", dates => dates.Select(date => date.ConvertToUtc(_timeZone)));

/// <summary>
/// Convenience property for running a scheduled event at noon in the algorithm time zone
/// </summary>
public ITimeRule Noon => new FuncTimeRule("Noon", dates => dates.Select(date => date.ConvertFromUtc(_timeZone).Date.AddHours(12)));
public ITimeRule Noon => new FuncTimeRule("Noon", dates => dates.Select(date => date.ConvertToUtc(_timeZone).AddHours(12)));

/// <summary>
/// Specifies an event should fire at the specified time of day in the algorithm's time zone
Expand Down Expand Up @@ -144,7 +144,7 @@ public ITimeRule Every(TimeSpan interval)
throw new ArgumentException("TimeRules.Every(): time span interval can not be zero or less");
}
var name = Invariant($"Every {interval.TotalMinutes:0.##} min");
Func<IEnumerable<DateTime>, IEnumerable<DateTime>> applicator = dates => EveryIntervalIterator(dates, interval);
Func<IEnumerable<DateTime>, IEnumerable<DateTime>> applicator = dates => EveryIntervalIterator(dates, interval, _timeZone);
return new FuncTimeRule(name, applicator);
}

Expand Down Expand Up @@ -215,7 +215,8 @@ private Security GetSecurity(Symbol symbol)
/// </summary>
/// <param name="dates">The dates for which we want to create the different intervals</param>
/// <param name="interval">The interval value to use, can not be zero or less</param>
private static IEnumerable<DateTime> EveryIntervalIterator(IEnumerable<DateTime> dates, TimeSpan interval)
/// <param name="timeZone">The time zone the date time is expressed in</param>
private static IEnumerable<DateTime> EveryIntervalIterator(IEnumerable<DateTime> dates, TimeSpan interval, DateTimeZone timeZone)
{
if (interval <= TimeSpan.Zero)
{
Expand All @@ -225,7 +226,7 @@ private static IEnumerable<DateTime> EveryIntervalIterator(IEnumerable<DateTime>
{
for (var time = TimeSpan.Zero; time < Time.OneDay; time += interval)
{
yield return date + time;
yield return (date + time).ConvertToUtc(timeZone);
}
}
}
Expand Down

0 comments on commit 98ae5cd

Please sign in to comment.