Coverage for src/jquantstats/_utils/_protocol.py: 100%

1"""Protocols describing the minimal interfaces required by the _utils subpackage.""" 

2 

3from __future__ import annotations 

4 

5from typing import Protocol, runtime_checkable 

6 

7from jquantstats._protocol import DataLike 

8 

9 

10@runtime_checkable 

11class PortfolioLike(Protocol): # pragma: no cover 

12 """Structural interface required by `PortfolioUtils`. 

13 

14 Any object satisfying this protocol can be passed as ``portfolio`` without a 

15 concrete dependency on `Portfolio`. 

16 """ 

17 

18 @property 

19 def data(self) -> DataLike: 

20 """Bridge to the Data analytics object for this portfolio.""" 

21 ... 

22 

23 @property 

24 def assets(self) -> list[str]: 

25 """Asset column names.""" 

26 ...