Skip to content

csv_reader

Classes:

Name Description
CSVReader

Classes#

CSVReader #

Bases: DataReader

Uses pandas and xarray functions to read a csv file and extract its contents into an xarray Dataset object. Two parameters are supported: read_csv_kwargs and from_dataframe_kwargs, whose contents are passed as keyword arguments to pandas.read_csv() and xarray.Dataset.from_dataframe() respectively.

Classes:

Name Description
Parameters

Methods:

Name Description
read

Attributes:

Name Type Description
parameters Parameters

Attributes#

parameters class-attribute instance-attribute #
parameters: Parameters = Parameters()

Classes#

Parameters #

Bases: BaseModel

Attributes:

Name Type Description
from_dataframe_kwargs Dict[str, Any]
read_csv_kwargs Dict[str, Any]
Attributes#
from_dataframe_kwargs class-attribute instance-attribute # 
from_dataframe_kwargs: Dict[str, Any] = {}
read_csv_kwargs class-attribute instance-attribute # 
read_csv_kwargs: Dict[str, Any] = {}

Functions#

read #
read(input_key: str) -> xr.Dataset
Source code in tsdat/io/readers/csv_reader.py 
25
26
27
def read(self, input_key: str) -> xr.Dataset:
    df: pd.DataFrame = pd.read_csv(input_key, **self.parameters.read_csv_kwargs)  # type: ignore
    return xr.Dataset.from_dataframe(df, **self.parameters.from_dataframe_kwargs)