tsdat.io.filehandlers.file_handlers

Classes

AbstractFileHandler	Abstract class to define methods required by all FileHandlers. Classes
FileHandler	Class to provide methods to read and write files with a variety of

class tsdat.io.filehandlers.file_handlers.AbstractFileHandler(parameters: Union[Dict, None] = None)

Abstract class to define methods required by all FileHandlers. Classes derived from AbstractFileHandler should implement one or more of the following methods:

write(ds: xr.Dataset, filename: str, config: Config, **kwargs)

read(filename: str, **kwargs) -> xr.Dataset

Parameters

parameters (Dict, optional) – Parameters that were passed to the FileHandler when it was registered in the storage config file, defaults to {}.

Class Methods

read	Reads in the given file and converts it into an Xarray dataset for
write	Saves the given dataset to a file.

Method Descriptions

read(self, filename: str, **kwargs) → xarray.Dataset

Reads in the given file and converts it into an Xarray dataset for use in the pipeline.

Parameters

filename (str) – The path to the file to read in.

Returns

A xr.Dataset object.

Return type

xr.Dataset

write(self, ds: xarray.Dataset, filename: str, config: tsdat.config.Config = None, **kwargs) → None

Saves the given dataset to a file.

Parameters

• ds (xr.Dataset) – The dataset to save.

• filename (str) – The path to where the file should be written to.

• config (Config, optional) – Optional Config object, defaults to None

class tsdat.io.filehandlers.file_handlers.FileHandler

Class to provide methods to read and write files with a variety of extensions.

FILEREADERS :Dict[str, AbstractFileHandler]

FILEWRITERS :Dict[str, AbstractFileHandler]

Class Methods

read	Reads in the given file and converts it into an xarray dataset object using the
register_file_handler	Method to register a FileHandler for reading from or writing to files matching one or
write	Calls the appropriate FileHandler to write the dataset to the provided filename.

Method Descriptions

read(self, filename: str, **kwargs) → xarray.Dataset

Reads in the given file and converts it into an xarray dataset object using the registered FileHandler for the provided filepath.

Parameters

filename (str) – The path to the file to read in.

Returns

The raw file as an Xarray.Dataset object.

Return type

xr.Dataset

register_file_handler(self, method: Literal[read, write], patterns: Union[str, List[str]], handler: AbstractFileHandler)

Method to register a FileHandler for reading from or writing to files matching one or more provided file patterns.

Parameters

• method ("Literal") – The method the FileHandler should call if the pattern is

• Must be one of (matched.) – “read”, “write”.

• patterns (Union[str, List[str]]) – The file pattern(s) that determine if this

• should be run on a given filepath. (FileHandler) –

• handler (AbstractFileHandler) – The AbstractFileHandler to register.

write(self, ds: xarray.Dataset, filename: str, config: tsdat.config.Config = None, **kwargs) → None

Calls the appropriate FileHandler to write the dataset to the provided filename.

Parameters

• ds (xr.Dataset) – The dataset to save.

• filename (str) – The path to the file where the dataset should be written.

• config (Config, optional) – Optional Config object. Defaults to None.