Skip to content

feat: Remove sma_periods default value for StarcBands #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LeeDongGeon1996 merged 3 commits into from
Jan 21, 2024
Merged

feat: Remove sma_periods default value for StarcBands #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
95d7566
Remove sma_periods default value for StarcBands
LeeDongGeon1996 Jan 18, 2024
55cbe1c
Add warning msg if sma_periods is null
LeeDongGeon1996 Jan 20, 2024
ba3666c
Merge branch 'main' into feature/remove-default-StarcBands
LeeDongGeon1996 Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion benchmarks/test_benchmark_indicators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ def test_benchmark_smma(benchmark, quotes):
benchmark(indicators.get_smma, quotes, 20)

def test_benchmark_starc_bands(benchmark, quotes):
benchmark(indicators.get_starc_bands, quotes)
benchmark(indicators.get_starc_bands, quotes, 10)

def test_benchmark_stc(benchmark, quotes):
benchmark(indicators.get_stc, quotes)
Expand Down
9 changes: 7 additions & 2 deletions stock_indicators/indicators/starc_bands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from typing import Iterable, Optional, TypeVar
from warnings import warn

from stock_indicators._cslib import CsIndicator
from stock_indicators._cstypes import List as CsList
Expand All @@ -7,7 +8,7 @@
from stock_indicators.indicators.common.quote import Quote


def get_starc_bands(quotes: Iterable[Quote], sma_periods: int = 20,
def get_starc_bands(quotes: Iterable[Quote], sma_periods: int = None,
multiplier: float = 2, atr_periods: int = 10):
"""Get STARC Bands calculated.

Expand All @@ -18,7 +19,7 @@ def get_starc_bands(quotes: Iterable[Quote], sma_periods: int = 20,
`quotes` : Iterable[Quote]
Historical price quotes.

`sma_periods` : int, defaults 20
`sma_periods` : int
Number of periods for the centerline SMA.

`multiplier` : float, defaults 2
Expand All @@ -35,6 +36,10 @@ def get_starc_bands(quotes: Iterable[Quote], sma_periods: int = 20,
- [STARC Bands Reference](https://python.stockindicators.dev/indicators/StarcBands/#content)
- [Helper Methods](https://python.stockindicators.dev/utilities/#content)
"""
if sma_periods is None:
warn('The default value of sma_periods will be removed in the next version. Pass sma_periods explicitly.', DeprecationWarning, stacklevel=2)
sma_periods = 20

results = CsIndicator.GetStarcBands[Quote](CsList(Quote, quotes), sma_periods,
multiplier, atr_periods)
return STARCBandsResults(results, STARCBandsResult)
Expand Down
4 changes: 2 additions & 2 deletions tests/test_starc_bands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ def test_bad_data(self, bad_quotes):
assert 502 == len(r)

def test_no_quotes(self, quotes):
r = indicators.get_starc_bands([])
r = indicators.get_starc_bands([], 10)
assert 0 == len(r)

r = indicators.get_starc_bands(quotes[:1])
r = indicators.get_starc_bands(quotes[:1], 10)
assert 1 == len(r)

def test_removed(self, quotes):
Expand Down