Files
quantconnect--lean/Common/Python/DividendYieldModelPythonWrapper.cs
T
Jhonathan Abreu 2ddf40b8e9 PEP8 style algorithm API (#7909)
* feat: support snake-case style Python QCAlgorithm implementations

* feat: add unit tests and minor fixes

* feat: implement new BasePythonWrapper class for python wrappers.

Used to cache methods and contains invoke functionality

* feat: make python wrappers implement the new base class for pep8 style support

* feat: keep overriden methods in Algorithm Python Wrapper

* feat: add unit tests for custom models algorithms with PEP8 style

* Bump pythonnet version to 2.0.30

* fix bugs and address peer review

* Address peer review

* Minor revert

* feat: StubsIgnoreAttribute for ignoring members or classes by the stubs generator

* Minor fixes

* Minor fix

* Minor fix

* Bump pythonnet version to 2.0.31

* Added Greeks.Lambda_ alias of Lambda for python compatibility.

Remove unused method
2024-04-12 17:29:15 -03:00

62 lines
2.4 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 Python.Runtime;
using QuantConnect.Data;
namespace QuantConnect.Python
{
/// <summary>
/// Wraps a <see cref="PyObject"/> object that represents a dividend yield model
/// </summary>
public class DividendYieldModelPythonWrapper : BasePythonWrapper<IDividendYieldModel>, IDividendYieldModel
{
/// <summary>
/// Constructor for initializing the <see cref="DividendYieldModelPythonWrapper"/> class with wrapped <see cref="PyObject"/> object
/// </summary>
/// <param name="model">Represents a security's model of dividend yield</param>
public DividendYieldModelPythonWrapper(PyObject model)
: base(model)
{
}
/// <summary>
/// Get dividend yield by a given date of a given symbol
/// </summary>
/// <param name="date">The date</param>
/// <returns>Dividend yield on the given date of the given symbol</returns>
public decimal GetDividendYield(DateTime date)
{
return InvokeMethod<decimal>(nameof(GetDividendYield), date);
}
/// <summary>
/// Converts a <see cref="PyObject"/> object into a <see cref="IDividendYieldModel"/> object, wrapping it if necessary
/// </summary>
/// <param name="model">The Python model</param>
/// <returns>The converted <see cref="IDividendYieldModel"/> instance</returns>
public static IDividendYieldModel FromPyObject(PyObject model)
{
if (!model.TryConvert(out IDividendYieldModel dividendYieldModel))
{
dividendYieldModel = new DividendYieldModelPythonWrapper(model);
}
return dividendYieldModel;
}
}
}