.. _l-staticmethods:

Static Methods
==============

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| staticmethod                                                                                  | class parent       | truncated documentation                                                                                                             |
+===============================================================================================+====================+=====================================================================================================================================+
| :py:meth:`_process_kwargs <pandas_streaming.df.dataframe.StreamingDataFrame._process_kwargs>` | StreamingDataFrame | Filters out parameters for the constructor of this class.                                                                           |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_process_kwargs <pandas_streaming.df.dataframe.StreamingSeries._process_kwargs>`    | StreamingSeries    | Filters out parameters for the constructor of this class.                                                                           |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_csv <pandas_streaming.df.dataframe.StreamingDataFrame.read_csv>`                  | StreamingDataFrame | Reads a :epkg:`csv` file or buffer as an iterator on :epkg:`DataFrame`. The signature is the same as :epkg:`pandas:read_csv`. ...   |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_csv <pandas_streaming.df.dataframe.StreamingSeries.read_csv>`                     | StreamingSeries    | Reads a :epkg:`csv` file or buffer as an iterator on :epkg:`DataFrame`. The signature is the same as :epkg:`pandas:read_csv`. ...   |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_df <pandas_streaming.df.dataframe.StreamingDataFrame.read_df>`                    | StreamingDataFrame | Splits a :epkg:`DataFrame` into small chunks mostly for unit testing purposes.                                                      |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_df <pandas_streaming.df.dataframe.StreamingSeries.read_df>`                       | StreamingSeries    | Splits a :epkg:`DataFrame` into small chunks mostly for unit testing purposes.                                                      |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_json <pandas_streaming.df.dataframe.StreamingDataFrame.read_json>`                | StreamingDataFrame | Reads a :epkg:`json` file or buffer as an iterator on :epkg:`DataFrame`. The signature is the same as :epkg:`pandas:read_json`. ... |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_json <pandas_streaming.df.dataframe.StreamingSeries.read_json>`                   | StreamingSeries    | Reads a :epkg:`json` file or buffer as an iterator on :epkg:`DataFrame`. The signature is the same as :epkg:`pandas:read_json`. ... |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_str <pandas_streaming.df.dataframe.StreamingDataFrame.read_str>`                  | StreamingDataFrame | Reads a :epkg:`DataFrame` as an iterator on :epkg:`DataFrame`. The signature is the same as :epkg:`pandas:read_csv`. ...            |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_str <pandas_streaming.df.dataframe.StreamingSeries.read_str>`                     | StreamingSeries    | Reads a :epkg:`DataFrame` as an iterator on :epkg:`DataFrame`. The signature is the same as :epkg:`pandas:read_csv`. ...            |
+-----------------------------------------------------------------------------------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+