/
rsi.py
55 lines (41 loc) · 1.85 KB
/
rsi.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
from typing import Iterable, Optional, TypeVar
from stock_indicators._cslib import CsIndicator
from stock_indicators._cstypes import List as CsList
from stock_indicators.indicators.common.helpers import CondenseMixin, RemoveWarmupMixin
from stock_indicators.indicators.common.results import IndicatorResults, ResultBase
from stock_indicators.indicators.common.quote import Quote
def get_rsi(quotes: Iterable[Quote], lookback_periods: int = 14):
"""Get RSI calculated.
Relative Strength Index (RSI) measures strength of the winning/losing streak over N lookback periods
on a scale of 0 to 100, to depict overbought and oversold conditions.
Parameters:
`quotes` : Iterable[Quote]
Historical price quotes.
`lookback_periods` : int, defaults 14
Number of periods in the lookback window.
Returns:
`RSIResults[RSIResult]`
RSIResults is list of RSIResult with providing useful helper methods.
See more:
- [RSI Reference](https://python.stockindicators.dev/indicators/Rsi/#content)
- [Helper Methods](https://python.stockindicators.dev/utilities/#content)
"""
rsi_list = CsIndicator.GetRsi[Quote](CsList(Quote, quotes), lookback_periods)
return RSIResults(rsi_list, RSIResult)
class RSIResult(ResultBase):
"""
A wrapper class for a single unit of RSI results.
"""
@property
def rsi(self) -> Optional[float]:
return self._csdata.Rsi
@rsi.setter
def rsi(self, value):
self._csdata.Rsi = value
_T = TypeVar("_T", bound=RSIResult)
class RSIResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
"""
A wrapper class for the list of RSI(Relative Strength Index) results.
It is exactly same with built-in `list` except for that it provides
some useful helper methods written in CSharp implementation.
"""