xarray.backends.BackendEntrypoint (original) (raw)

class xarray.backends.BackendEntrypoint[source]#

BackendEntrypoint is a class container and it is the main interface for the backend plugins, see BackendEntrypoint subclassing. It shall implement:

• open_dataset method: it shall implement reading from file, variables decoding and it returns an instance of Dataset. It shall take in input at least filename_or_obj argument anddrop_variables keyword argument. For more details see open_dataset.
• guess_can_open method: it shall return True if the backend is able to openfilename_or_obj, False otherwise. The implementation of this method is not mandatory.
• open_datatree method: it shall implement reading from file, variables decoding and it returns an instance of DataTree. It shall take in input at least filename_or_obj argument. The implementation of this method is not mandatory. For more details see <reference to open_datatree documentation>.

open_dataset_parameters#

A list of open_dataset method parameters. The setting of this attribute is not mandatory.

Type:

tuple, default: None

description#

A short string describing the engine. The setting of this attribute is not mandatory.

Type:

str, default: ""

url#

A string with the URL to the backend’s documentation. The setting of this attribute is not mandatory.

Type:

str, default: ""

supports_groups#

Whether the backend supports opening groups (via open_datatree and open_groups_as_dict) or not.

Type:

bool, default: False

__init__()#

Methods

Attributes