feat: Add condense() on all supported indicators (#377)

pyproject.toml

@@ -29,7 +29,7 @@ classifiers = [
 requires-python = ">=3.8"
 dependencies = [
     "pythonnet>=3.0.0",
-    "typing_extensions>=4.0.0"
+    "typing_extensions>=4.4.0"
 ]
 keywords = [
 "Stock Indicators", "Technical Indicators", "Market", "Technical Analysis", "Algorithmic", "Trading", "Trade",

requirements.txt

@@ -1,3 +1,3 @@
 # _cslib
 pythonnet>=3.0.0
-typing_extensions>=4.0.0
+typing_extensions>=4.4.0

stock_indicators/_cslib/__init__.py

@@ -30,6 +30,7 @@
 from System import Decimal as CsDecimal
 from System import Enum as CsEnum
 from System.Globalization import CultureInfo
+from System.Collections.Generic import IEnumerable as CsIEnumerable
 from System.Collections.Generic import List as CsList
 
 # Classes
@@ -38,6 +39,7 @@
 from Skender.Stock.Indicators import Quote as CsQuote
 from Skender.Stock.Indicators import QuoteUtility as CsQuoteUtility
 from Skender.Stock.Indicators import ResultBase as CsResultBase
+from Skender.Stock.Indicators import ResultUtility as CsResultUtility
 
 # Enums
 from Skender.Stock.Indicators import BetaType as CsBetaType

stock_indicators/indicators/adl.py

@@ -2,6 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
+from stock_indicators.indicators.common.helpers import CondenseMixin
 from stock_indicators.indicators.common.results import IndicatorResults, ResultBase
 from stock_indicators.indicators.common.quote import Quote
 
@@ -69,7 +70,7 @@ def adl_sma(self, value):
 
 
 _T = TypeVar("_T", bound=ADLResult)
-class ADLResults(IndicatorResults[_T]):
+class ADLResults(CondenseMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of ADL(Accumulation/Distribution Line) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/adx.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -71,7 +71,7 @@ def adxr(self, value):
 
 
 _T = TypeVar("_T", bound=ADXResult)
-class ADXResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class ADXResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of ADX(Average Directional Movement Index) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/alligator.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -85,7 +85,7 @@ def lips(self, value):
 
 
 _T = TypeVar("_T", bound=AlligatorResult)
-class AlligatorResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class AlligatorResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Williams Alligator results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/alma.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+from stock_indicators.indicators.common.helpers import CondenseMixin, RemoveWarmupMixin
 from stock_indicators.indicators.common.quote import Quote
 from stock_indicators.indicators.common.results import IndicatorResults, ResultBase
 
@@ -53,7 +53,7 @@ def alma(self, value):
 
 
 _T = TypeVar("_T", bound=ALMAResult)
-class ALMAResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class ALMAResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of ALMA(Arnaud Legoux Moving Average) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/aroon.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -62,7 +62,7 @@ def oscillator(self, value):
 
 
 _T = TypeVar("_T", bound=AroonResult)
-class AroonResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class AroonResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Aroon results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/atr.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -62,7 +62,7 @@ def atrp(self, value):
 
 
 _T = TypeVar("_T", bound=ATRResult)
-class ATRResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class ATRResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of ATR(Average True Range) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/atr_stop.py

@@ -6,7 +6,7 @@
 from stock_indicators._cstypes import Decimal as CsDecimal
 from stock_indicators._cstypes import to_pydecimal
 from stock_indicators.indicators.common.enums import EndType
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -75,7 +75,7 @@ def sell_stop(self, value):
 
 
 _T = TypeVar("_T", bound=AtrStopResult)
-class AtrStopResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class AtrStopResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of ATR Trailing Stop results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/awesome.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -58,7 +58,7 @@ def normalized(self, value):
 
 
 _T = TypeVar("_T", bound=AwesomeResult)
-class AwesomeResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class AwesomeResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Awesome Oscillator (aka Super AO) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/beta.py

@@ -3,7 +3,7 @@
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
 from stock_indicators.indicators.common.enums import BetaType
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -106,7 +106,7 @@ def returns_mrkt(self, value):
 _T = TypeVar("_T", bound=BetaResult)
 
 
-class BetaResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class BetaResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Beta results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/bollinger_bands.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -90,7 +90,7 @@ def width(self, value):
 
 
 _T = TypeVar("_T", bound=BollingerBandsResult)
-class BollingerBandsResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class BollingerBandsResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Bollinger Bands results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/bop.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -48,7 +48,7 @@ def bop(self, value):
 
 
 _T = TypeVar("_T", bound=BOPResult)
-class BOPResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class BOPResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Balance of Power (aka Balance of Market Power) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/cci.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -47,7 +47,7 @@ def cci(self, value):
 
 
 _T = TypeVar("_T", bound=CCIResult)
-class CCIResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class CCIResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Commodity Channel Index (CCI) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/chaikin_oscillator.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -74,7 +74,7 @@ def oscillator(self, value):
 
 
 _T = TypeVar("_T", bound=ChaikinOscResult)
-class ChaikinOscResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class ChaikinOscResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Chaikin Oscillator results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/chandelier.py

@@ -3,7 +3,7 @@
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
 from stock_indicators.indicators.common.enums import ChandelierType
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -56,7 +56,7 @@ def chandelier_exit(self, value):
 
 
 _T = TypeVar("_T", bound=ChandelierResult)
-class ChandelierResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class ChandelierResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Chandelier Exit results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/chop.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -47,7 +47,7 @@ def chop(self, value):
 
 
 _T = TypeVar("_T", bound=ChopResult)
-class ChopResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class ChopResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Choppiness Index (CHOP) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/cmf.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -63,7 +63,7 @@ def cmf(self, value):
 
 
 _T = TypeVar("_T", bound=CMFResult)
-class CMFResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class CMFResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Chaikin Money Flow (CMF) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/cmo.py

@@ -2,7 +2,7 @@
 
 from stock_indicators._cslib import CsIndicator
 from stock_indicators._cstypes import List as CsList
-from stock_indicators.indicators.common.helpers import RemoveWarmupMixin
+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
 
@@ -47,7 +47,7 @@ def cmo(self, value):
 
 
 _T = TypeVar("_T", bound=CMOResult)
-class CMOResults(RemoveWarmupMixin, IndicatorResults[_T]):
+class CMOResults(CondenseMixin, RemoveWarmupMixin, IndicatorResults[_T]):
     """
     A wrapper class for the list of Chande Momentum Oscillator (CMO) results.
     It is exactly same with built-in `list` except for that it provides

stock_indicators/indicators/common/candles.py

@@ -1,27 +1,17 @@
 from decimal import Decimal
 from typing import Optional, TypeVar
-
-from typing_extensions import Self
+from typing_extensions import override
 
 from stock_indicators._cslib import CsCandleProperties
 from stock_indicators._cstypes import Decimal as CsDecimal
 from stock_indicators._cstypes import to_pydecimal
 from stock_indicators.indicators.common._contrib.type_resolver import generate_cs_inherited_class
 from stock_indicators.indicators.common.enums import Match
+from stock_indicators.indicators.common.helpers import CondenseMixin
 from stock_indicators.indicators.common.quote import _Quote
 from stock_indicators.indicators.common.results import IndicatorResults, ResultBase
 
 
-class CondenseMixin:
-    """Mixin for condense()."""
-    @IndicatorResults._verify_data
-    def condense(self) -> Self:
-        """
-        Remove results which have no match, so it only returns meaningful data records.
-        """
-        return self.__class__(filter(lambda x: x.match != Match.NONE, self), self._wrapper_class)
-
-
 class _CandleProperties(_Quote):
     @property
     def size(self) -> Optional[Decimal]:
@@ -115,3 +105,7 @@ class CandleResults(CondenseMixin, IndicatorResults[_T]):
     It is exactly same with built-in `list` except for that it provides
     some useful helper methods written in CSharp implementation.
     """
+
+    @override
+    def condense(self):
+        return self.__class__(filter(lambda x: x.match != Match.NONE, self), self._wrapper_class)