Skip to content

dataframe

PtDataFrame

Bases: AbstractPtDataFrame

A class representing a Pandas DataFrame with additional functionality.

Parameters:

Name Type Description Default
df pd.DataFrame

The Pandas DataFrame to be encapsulated. Defaults to an empty DataFrame.

 pd.DataFrame()
Source code in pypdtools\core\dataframe.py 
 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
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
class PtDataFrame(AbstractPtDataFrame):
    """
    A class representing a Pandas DataFrame with additional functionality.

    Args:
        df (pd.DataFrame, optional): The Pandas DataFrame to be encapsulated. Defaults to an empty DataFrame.
    """

    def __init__(self, df: pd.DataFrame = pd.DataFrame()) -> None:
        """
        Initialize the PtDataFrame.

        Args:
            df (pd.DataFrame, optional): The Pandas DataFrame to be encapsulated. Defaults to an empty DataFrame.
        """
        self._df = df
        self._iterator = self._df.itertuples(index=False)
        self._lock = Lock()

    @property
    def df(self) -> pd.DataFrame:
        """
        Get the encapsulated Pandas DataFrame.

        Returns:
            pd.DataFrame: The encapsulated Pandas DataFrame.
        """
        return self._df

    def __repr__(self) -> str:
        """
        Return a string representation of the PtDataFrame.

        Returns:
            str: A string representation of the PtDataFrame.
        """
        return self._df.__repr__()

    def __str__(self) -> str:
        """
        Return a string representation of the PtDataFrame.

        Returns:
            str: A string representation of the PtDataFrame.
        """
        return self._df.__str__()

    def __await__(self) -> Awaitable:
        """
        Awaitable support for the PtDataFrame.

        Returns:
            Awaitable: An awaitable object.
        """
        return sleep(0.0001).__await__()

    def __enter__(self) -> pd.DataFrame:
        """
        Enter the context manager and return the encapsulated Pandas DataFrame.

        Returns:
            pd.DataFrame: The encapsulated Pandas DataFrame.
        """
        return self._df

    async def __aenter__(self) -> pd.DataFrame:
        """
        Asynchronous version of __enter__(). Enter the context manager and return the encapsulated Pandas DataFrame.

        Returns:
            pd.DataFrame: The encapsulated Pandas DataFrame.
        """
        return self._df

    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
        """
        Exit the context manager.

        Args:
            exc_type (type): The exception type, if any.
            exc_val (Exception): The exception instance, if any.
            exc_tb (traceback): The traceback, if any.
        """
        return None

    async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
        """
        Asynchronous version of __exit__(). Exit the context manager.

        Args:
            exc_type (type): The exception type, if any.
            exc_val (Exception): The exception instance, if any.
            exc_tb (traceback): The traceback, if any.
        """
        return None

    def __aiter__(self) -> Iterator:
        """
        Asynchronous iterator support for the PtDataFrame.

        Returns:
            Iterator: An asynchronous iterator.
        """
        self._iterator = self._df.itertuples(index=False)

        async def _aiter() -> Iterator:
            """
            Asynchronous iterator helper function.

            Yields:
                Iterator: An item from the PtDataFrame.
            """
            while True:
                try:
                    yield self._iterator.__next__()
                except StopIteration:
                    break

        return _aiter()

    def __iter__(self) -> Iterator:
        """
               Iterator

        support for the PtDataFrame.

               Returns:
                   Iterator: An iterator.
        """
        self._iterator = self._df.itertuples(index=False)

        return (it for it in self._iterator)

    def __len__(self) -> int:
        """
        Return the length of the PtDataFrame.

        Returns:
            int: The length of the PtDataFrame.
        """
        return len(self._df)

    async def __anext__(self) -> Awaitable:
        """
        Asynchronous iterator support for the PtDataFrame.

        Returns:
            Awaitable: An awaitable object.
        """
        async with self._lock:
            try:
                return self._iterator.__next__()
            except StopIteration:
                raise StopAsyncIteration

    def __next__(self) -> Any:
        """
        Iterator support for the PtDataFrame.

        Returns:
            Any: An item from the PtDataFrame.
        """
        return self._iterator.__next__()

    def __add__(self, other) -> "PtDataFrame":
        """
        Concatenate the PtDataFrame with another PtDataFrame.

        Args:
            other (PtDataFrame): The PtDataFrame to concatenate.

        Returns:
            PtDataFrame: The concatenated PtDataFrame.
        """
        concat = pd.concat([self._df, other._df], ignore_index=True)
        return PtDataFrame(concat)

    def __iadd__(self, other) -> "PtDataFrame":
        """
        In-place concatenation of the PtDataFrame with another PtDataFrame.

        Args:
            other (PtDataFrame): The PtDataFrame to concatenate.

        Returns:
            PtDataFrame: The concatenated PtDataFrame.
        """
        self._df = pd.concat([self._df, other._df], ignore_index=True)
        return self

    @classmethod
    def reduce(cls, df_list) -> "PtDataFrame":
        """
        Reduce a list of PtDataFrame objects into a single PtDataFrame.

        Args:
            df_list (List[PtDataFrame]): The list of PtDataFrame objects to reduce.

        Returns:
            PtDataFrame: The reduced PtDataFrame.
        """
        return PtDataFrame(reduce(lambda x, y: x + y, df_list).df)

    def col_to_list(self, col_name, drop_duplicates=True) -> List:
        """
        Extract a column as a list from the PtDataFrame.

        Args:
            col_name (str): The name of the column to extract.
            drop_duplicates (bool, optional): Whether to drop duplicate values. Defaults to True.

        Returns:
            List: The column values as a list.
        """
        if drop_duplicates:
            return self._df[col_name].drop_duplicates().tolist()
        return self._df[col_name].tolist()

df: pd.DataFrame property

Get the encapsulated Pandas DataFrame.

Returns:

Type Description
pd.DataFrame

pd.DataFrame: The encapsulated Pandas DataFrame.

__add__(other)

Concatenate the PtDataFrame with another PtDataFrame.

Parameters:

Name Type Description Default
other PtDataFrame

The PtDataFrame to concatenate.

 required

Returns:

Name Type Description
PtDataFrame PtDataFrame

The concatenated PtDataFrame.
Source code in pypdtools\core\dataframe.py 
174
175
176
177
178
179
180
181
182
183
184
185
def __add__(self, other) -> "PtDataFrame":
    """
    Concatenate the PtDataFrame with another PtDataFrame.

    Args:
        other (PtDataFrame): The PtDataFrame to concatenate.

    Returns:
        PtDataFrame: The concatenated PtDataFrame.
    """
    concat = pd.concat([self._df, other._df], ignore_index=True)
    return PtDataFrame(concat)

__aenter__() async

Asynchronous version of enter(). Enter the context manager and return the encapsulated Pandas DataFrame.

Returns:

Type Description
pd.DataFrame

pd.DataFrame: The encapsulated Pandas DataFrame.
Source code in pypdtools\core\dataframe.py 
75
76
77
78
79
80
81
82
async def __aenter__(self) -> pd.DataFrame:
    """
    Asynchronous version of __enter__(). Enter the context manager and return the encapsulated Pandas DataFrame.

    Returns:
        pd.DataFrame: The encapsulated Pandas DataFrame.
    """
    return self._df

__aexit__(exc_type, exc_val, exc_tb) async

Asynchronous version of exit(). Exit the context manager.

Parameters:

Name Type Description Default
exc_type type

The exception type, if any.

 required
exc_val Exception

The exception instance, if any.

 required
exc_tb traceback

The traceback, if any.

 required
Source code in pypdtools\core\dataframe.py 
 95
 96
 97
 98
 99
100
101
102
103
104
async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
    """
    Asynchronous version of __exit__(). Exit the context manager.

    Args:
        exc_type (type): The exception type, if any.
        exc_val (Exception): The exception instance, if any.
        exc_tb (traceback): The traceback, if any.
    """
    return None

__aiter__()

Asynchronous iterator support for the PtDataFrame.

Returns:

Name Type Description
Iterator Iterator

An asynchronous iterator.
Source code in pypdtools\core\dataframe.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def __aiter__(self) -> Iterator:
    """
    Asynchronous iterator support for the PtDataFrame.

    Returns:
        Iterator: An asynchronous iterator.
    """
    self._iterator = self._df.itertuples(index=False)

    async def _aiter() -> Iterator:
        """
        Asynchronous iterator helper function.

        Yields:
            Iterator: An item from the PtDataFrame.
        """
        while True:
            try:
                yield self._iterator.__next__()
            except StopIteration:
                break

    return _aiter()

__anext__() async

Asynchronous iterator support for the PtDataFrame.

Returns:

Name Type Description
Awaitable Awaitable

An awaitable object.
Source code in pypdtools\core\dataframe.py 
152
153
154
155
156
157
158
159
160
161
162
163
async def __anext__(self) -> Awaitable:
    """
    Asynchronous iterator support for the PtDataFrame.

    Returns:
        Awaitable: An awaitable object.
    """
    async with self._lock:
        try:
            return self._iterator.__next__()
        except StopIteration:
            raise StopAsyncIteration

__await__()

Awaitable support for the PtDataFrame.

Returns:

Name Type Description
Awaitable Awaitable

An awaitable object.
Source code in pypdtools\core\dataframe.py 
57
58
59
60
61
62
63
64
def __await__(self) -> Awaitable:
    """
    Awaitable support for the PtDataFrame.

    Returns:
        Awaitable: An awaitable object.
    """
    return sleep(0.0001).__await__()

__enter__()

Enter the context manager and return the encapsulated Pandas DataFrame.

Returns:

Type Description
pd.DataFrame

pd.DataFrame: The encapsulated Pandas DataFrame.
Source code in pypdtools\core\dataframe.py 
66
67
68
69
70
71
72
73
def __enter__(self) -> pd.DataFrame:
    """
    Enter the context manager and return the encapsulated Pandas DataFrame.

    Returns:
        pd.DataFrame: The encapsulated Pandas DataFrame.
    """
    return self._df

__exit__(exc_type, exc_val, exc_tb)

Exit the context manager.

Parameters:

Name Type Description Default
exc_type type

The exception type, if any.

 required
exc_val Exception

The exception instance, if any.

 required
exc_tb traceback

The traceback, if any.

 required
Source code in pypdtools\core\dataframe.py 
84
85
86
87
88
89
90
91
92
93
def __exit__(self, exc_type, exc_val, exc_tb) -> None:
    """
    Exit the context manager.

    Args:
        exc_type (type): The exception type, if any.
        exc_val (Exception): The exception instance, if any.
        exc_tb (traceback): The traceback, if any.
    """
    return None

__iadd__(other)

In-place concatenation of the PtDataFrame with another PtDataFrame.

Parameters:

Name Type Description Default
other PtDataFrame

The PtDataFrame to concatenate.

 required

Returns:

Name Type Description
PtDataFrame PtDataFrame

The concatenated PtDataFrame.
Source code in pypdtools\core\dataframe.py 
187
188
189
190
191
192
193
194
195
196
197
198
def __iadd__(self, other) -> "PtDataFrame":
    """
    In-place concatenation of the PtDataFrame with another PtDataFrame.

    Args:
        other (PtDataFrame): The PtDataFrame to concatenate.

    Returns:
        PtDataFrame: The concatenated PtDataFrame.
    """
    self._df = pd.concat([self._df, other._df], ignore_index=True)
    return self

__init__(df=pd.DataFrame())

Initialize the PtDataFrame.

Parameters:

Name Type Description Default
df pd.DataFrame

The Pandas DataFrame to be encapsulated. Defaults to an empty DataFrame.

 pd.DataFrame()
Source code in pypdtools\core\dataframe.py 
18
19
20
21
22
23
24
25
26
27
def __init__(self, df: pd.DataFrame = pd.DataFrame()) -> None:
    """
    Initialize the PtDataFrame.

    Args:
        df (pd.DataFrame, optional): The Pandas DataFrame to be encapsulated. Defaults to an empty DataFrame.
    """
    self._df = df
    self._iterator = self._df.itertuples(index=False)
    self._lock = Lock()

__iter__() 

   Iterator

support for the PtDataFrame.

   Returns:
       Iterator: An iterator.
Source code in pypdtools\core\dataframe.py 
130
131
132
133
134
135
136
137
138
139
140
141
def __iter__(self) -> Iterator:
    """
           Iterator

    support for the PtDataFrame.

           Returns:
               Iterator: An iterator.
    """
    self._iterator = self._df.itertuples(index=False)

    return (it for it in self._iterator)

__len__()

Return the length of the PtDataFrame.

Returns:

Name Type Description
int int

The length of the PtDataFrame.
Source code in pypdtools\core\dataframe.py 
143
144
145
146
147
148
149
150
def __len__(self) -> int:
    """
    Return the length of the PtDataFrame.

    Returns:
        int: The length of the PtDataFrame.
    """
    return len(self._df)

__next__()

Iterator support for the PtDataFrame.

Returns:

Name Type Description
Any Any

An item from the PtDataFrame.
Source code in pypdtools\core\dataframe.py 
165
166
167
168
169
170
171
172
def __next__(self) -> Any:
    """
    Iterator support for the PtDataFrame.

    Returns:
        Any: An item from the PtDataFrame.
    """
    return self._iterator.__next__()

__repr__()

Return a string representation of the PtDataFrame.

Returns:

Name Type Description
str str

A string representation of the PtDataFrame.
Source code in pypdtools\core\dataframe.py 
39
40
41
42
43
44
45
46
def __repr__(self) -> str:
    """
    Return a string representation of the PtDataFrame.

    Returns:
        str: A string representation of the PtDataFrame.
    """
    return self._df.__repr__()

__str__()

Return a string representation of the PtDataFrame.

Returns:

Name Type Description
str str

A string representation of the PtDataFrame.
Source code in pypdtools\core\dataframe.py 
48
49
50
51
52
53
54
55
def __str__(self) -> str:
    """
    Return a string representation of the PtDataFrame.

    Returns:
        str: A string representation of the PtDataFrame.
    """
    return self._df.__str__()

col_to_list(col_name, drop_duplicates=True)

Extract a column as a list from the PtDataFrame.

Parameters:

Name Type Description Default
col_name str

The name of the column to extract.

 required
drop_duplicates bool

Whether to drop duplicate values. Defaults to True.

 True

Returns:

Name Type Description
List List

The column values as a list.
Source code in pypdtools\core\dataframe.py 
213
214
215
216
217
218
219
220
221
222
223
224
225
226
def col_to_list(self, col_name, drop_duplicates=True) -> List:
    """
    Extract a column as a list from the PtDataFrame.

    Args:
        col_name (str): The name of the column to extract.
        drop_duplicates (bool, optional): Whether to drop duplicate values. Defaults to True.

    Returns:
        List: The column values as a list.
    """
    if drop_duplicates:
        return self._df[col_name].drop_duplicates().tolist()
    return self._df[col_name].tolist()

reduce(df_list) classmethod

Reduce a list of PtDataFrame objects into a single PtDataFrame.

Parameters:

Name Type Description Default
df_list List[PtDataFrame]

The list of PtDataFrame objects to reduce.

 required

Returns:

Name Type Description
PtDataFrame PtDataFrame

The reduced PtDataFrame.
Source code in pypdtools\core\dataframe.py 
200
201
202
203
204
205
206
207
208
209
210
211
@classmethod
def reduce(cls, df_list) -> "PtDataFrame":
    """
    Reduce a list of PtDataFrame objects into a single PtDataFrame.

    Args:
        df_list (List[PtDataFrame]): The list of PtDataFrame objects to reduce.

    Returns:
        PtDataFrame: The reduced PtDataFrame.
    """
    return PtDataFrame(reduce(lambda x, y: x + y, df_list).df)