Module engine

Classes

class DividendFrequency (*args, **kwds)

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

  • attribute access:

Color.RED

  • value lookup:

Color(1)

  • name lookup:

Color['RED']

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Parent

  • enum.Enum

Class variables

var BIANNUALLY
var MONTHLY
var NO_DIVIDENDS
var QUARTERLY
var YEARLY

Static methods

def from_delta(days: float)
def nearest(value: float, available_values: numpy.ndarray) ‑> int

Get the nearest value in available_values. (Kinda like a custom round())

Args:

value: The value to approximate
available_values: The available values to approximate to

Returns:

The approximation (nearest value)