Coverage for source/environment/reward_validator_base.py: 78%

1# environment/reward_validator_base.py 

2 

3# global imports 

4from abc import ABC, abstractmethod 

5 

6# local imports 

7from source.environment import Order 

8 

9class RewardValidatorBase(ABC): 

10 """ 

11 Awards reward for successful or failure order basing on approach defined in 

12 derivative class. 

13 """ 

14 

15 @abstractmethod 

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

17 """ 

18 Class constructor. Parameters are specified in derivative classes. 

19 """ 

20 

21 pass 

22 

23 @abstractmethod 

24 def validate_orders(self, orders: list[Order]) -> float: 

25 """ 

26 Calculates number of points to be rewarded for list of closed trades. 

27 

28 Parameters: 

29 orders (list[Order]): Orders to be validated. 

30 

31 Returns: 

32 (float): Calcualted reward. 

33 """ 

34 

35 pass