Coverage for source/indicators/indicator_base.py: 100%

5 statements  

« prev     ^ index     » next       coverage.py v7.8.0, created at 2025-05-30 15:13 +0000

1# indicators/indicator_base.py 

2 

3import pandas as pd 

4import numpy as np 

5 

6class IndicatorHandlerBase(): 

7 """ 

8 Base class for indicators. Enforces certain functions to be implemented 

9 in derivative classes. 

10 """ 

11 

12 def __init__(self, *args) -> None: 

13 """ 

14 Class constructor. Parameters are specified in derivative classes. 

15 """ 

16 

17 raise NotImplementedError 

18 

19 def calculate(self, data: pd.DataFrame) -> pd.DataFrame: 

20 """ 

21 Calculates indicator values for given data. 

22 

23 Parameters: 

24 data (pd.DataFrame): Data frame with input data. 

25 

26 Returns: 

27 (pd.DataFrame): Output data with calculated values for certain indicator. 

28 """ 

29 

30 raise NotImplementedError 

31