data_io_registration

Data Io registration convenience functions.

Note

The [call-arg] type error would be raised since the base methods doesn’t have a **kwargs argument, but we rather ignore this error here, than adding **kwargs to the base method and causing an [override] type error in the plugins implementation.

Functions

Summary

data_io_plugin_table

Return registered data io plugins and which functions they support as markdown table.

get_data_io

Retrieve a data io plugin from the data_io registry.

get_dataloader

Retrieve implementation of the read_dataset functionality for the format 'format_name'.

get_datasaver

Retrieve implementation of the save_dataset functionality for the format 'format_name'.

is_known_data_format

Check if a data format is in the data_io registry.

known_data_formats

Names of the registered data io plugins.

load_dataset

Read data from a file to xarray.Dataset or xarray.DataArray.

register_data_io

Register data io plugins to one or more formats.

save_dataset

Save data from xarray.Dataset or xarray.DataArray to a file.

set_data_plugin

Set the plugin used for a specific data format.

show_data_io_method_help

Show help for the implementation of data io plugin methods.

supported_file_extensions_data_io

Get data io formats that support all methods in method_names.