-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add missing multiperiod fields fundamental properties (#7536)
- Loading branch information
1 parent
f8b258d
commit 2e2136f
Showing
24 changed files
with
2,382 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
Common/Data/Fundamental/Generated/AuditorReportStatus.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /* | ||
| * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals. | ||
| * Lean Algorithmic Trading Engine v2.0. Copyright 2023 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.Linq; | ||
| using Python.Runtime; | ||
| using Newtonsoft.Json; | ||
| using System.Collections.Generic; | ||
| using QuantConnect.Data.UniverseSelection; | ||
|
|
||
| namespace QuantConnect.Data.Fundamental | ||
| { | ||
| /// <summary> | ||
| /// Auditor opinion code will be one of the following for each annual period: Code Meaning UQ Unqualified Opinion UE Unqualified Opinion with Explanation QM Qualified - Due to change in accounting method QL Qualified - Due to litigation OT Qualified Opinion - Other AO Adverse Opinion DS Disclaim an opinion UA Unaudited | ||
| /// </summary> | ||
| public class AuditorReportStatus : MultiPeriodField<string> | ||
| { | ||
| /// <summary> | ||
| /// The default period | ||
| /// </summary> | ||
| protected override string DefaultPeriod => "TwelveMonths"; | ||
|
|
||
| /// <summary> | ||
| /// Gets/sets the OneMonth period value for the field | ||
| /// </summary> | ||
| [JsonProperty("1M")] | ||
| public string OneMonth => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_OneMonth); | ||
|
|
||
| /// <summary> | ||
| /// Gets/sets the TwoMonths period value for the field | ||
| /// </summary> | ||
| [JsonProperty("2M")] | ||
| public string TwoMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwoMonths); | ||
|
|
||
| /// <summary> | ||
| /// Gets/sets the ThreeMonths period value for the field | ||
| /// </summary> | ||
| [JsonProperty("3M")] | ||
| public string ThreeMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_ThreeMonths); | ||
|
|
||
| /// <summary> | ||
| /// Gets/sets the SixMonths period value for the field | ||
| /// </summary> | ||
| [JsonProperty("6M")] | ||
| public string SixMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_SixMonths); | ||
|
|
||
| /// <summary> | ||
| /// Gets/sets the NineMonths period value for the field | ||
| /// </summary> | ||
| [JsonProperty("9M")] | ||
| public string NineMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_NineMonths); | ||
|
|
||
| /// <summary> | ||
| /// Gets/sets the TwelveMonths period value for the field | ||
| /// </summary> | ||
| [JsonProperty("12M")] | ||
| public string TwelveMonths => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwelveMonths); | ||
|
|
||
| /// <summary> | ||
| /// Returns true if the field contains a value for the default period | ||
| /// </summary> | ||
| public override bool HasValue => !BaseFundamentalDataProvider.IsNone(typeof(string), FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwelveMonths)); | ||
|
|
||
| /// <summary> | ||
| /// Returns the default value for the field | ||
| /// </summary> | ||
| public override string Value | ||
| { | ||
| get | ||
| { | ||
| var defaultValue = FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, FundamentalProperty.FinancialStatements_AuditorReportStatus_TwelveMonths); | ||
| if (!BaseFundamentalDataProvider.IsNone(typeof(string), defaultValue)) | ||
| { | ||
| return defaultValue; | ||
| } | ||
| return base.Value; | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets a dictionary of period names and values for the field | ||
| /// </summary> | ||
| /// <returns>The dictionary of period names and values</returns> | ||
| public override IReadOnlyDictionary<string, string> GetPeriodValues() | ||
| { | ||
| var result = new Dictionary<string, string>(); | ||
| foreach (var kvp in new[] { new Tuple<string, string>("1M", OneMonth), new Tuple<string, string>("2M", TwoMonths), new Tuple<string, string>("3M", ThreeMonths), new Tuple<string, string>("6M", SixMonths), new Tuple<string, string>("9M", NineMonths), new Tuple<string, string>("12M", TwelveMonths) }) | ||
| { | ||
| if (!BaseFundamentalDataProvider.IsNone(typeof(string), kvp.Item2)) | ||
| { | ||
| result[kvp.Item1] = kvp.Item2; | ||
| } | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the value of the field for the requested period | ||
| /// </summary> | ||
| /// <param name="period">The requested period</param> | ||
| /// <returns>The value for the period</returns> | ||
| public override string GetPeriodValue(string period) => FundamentalService.Get<string>(TimeProvider.GetUtcNow(), SecurityIdentifier, Enum.Parse<FundamentalProperty>($"FinancialStatements_AuditorReportStatus_{ConvertPeriod(period)}")); | ||
|
|
||
| /// <summary> | ||
| /// Creates a new empty instance | ||
| /// </summary> | ||
| public AuditorReportStatus() | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Creates a new instance for the given time and security | ||
| /// </summary> | ||
| public AuditorReportStatus(ITimeProvider timeProvider, SecurityIdentifier securityIdentifier) : base(timeProvider, securityIdentifier) | ||
| { | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.