timeseries_shaper.filter.boolean_filter

 1import pandas as pd
 2from ..base import Base
 3
 4class IsDeltaFilter(Base):
 5    """
 6    Provides class methods for filtering is_delta columns in a pandas DataFrame.
 7    """
 8
 9    @classmethod
10    def filter_is_delta_true(cls, dataframe: pd.DataFrame, column_name: str = 'is_delta') -> pd.DataFrame:
11        """Filters rows where 'is_delta' is True."""
12        # No need for instance, working directly on class level
13        return dataframe[dataframe[column_name] == True]
14
15    @classmethod
16    def filter_is_delta_false(cls, dataframe: pd.DataFrame, column_name: str = 'is_delta') -> pd.DataFrame:
17        """Filters rows where 'is_delta' is False."""
18        return dataframe[dataframe[column_name] == False]
19
20
21class BooleanFilter(Base):
22    """
23    Provides class methods for filtering boolean columns in a pandas DataFrame,
24    particularly focusing on status changes.
25    """
26    
27    @classmethod
28    def filter_falling_value_bool(cls, dataframe: pd.DataFrame, column_name: str = 'value_bool') -> pd.DataFrame:
29        """Filters rows where 'value_bool' changes from True to False."""
30        dataframe['previous_value_bool'] = dataframe[column_name].shift(1)
31        return dataframe[(dataframe['previous_value_bool'] == True) & (dataframe[column_name] == False)]
32
33    @classmethod
34    def filter_raising_value_bool(cls, dataframe: pd.DataFrame, column_name: str = 'value_bool') -> pd.DataFrame:
35        """Filters rows where 'value_bool' changes from False to True."""
36        dataframe['previous_value_bool'] = dataframe[column_name].shift(1)
37        return dataframe[(dataframe['previous_value_bool'] == False) & (dataframe[column_name] == True)]