Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Unconstrained forwarding of backend keyword arguments #10377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kmuehlbauer opened this issue May 30, 2025 · 0 comments
Open

Unconstrained forwarding of backend keyword arguments #10377

kmuehlbauer opened this issue May 30, 2025 · 0 comments

Comments

@kmuehlbauer
Copy link
Contributor

Is your feature request related to a problem?

Currently the backend keyword arguments have to be added to the signatures of open_dataset function of the respective BackendEntrypoint and to the open function of the respective Store. Every once in a while when a backend invents a new keyword argument xarray isn't capable to handle this out of the box and errors out.

There are requests/needs to add keyword arguments every once in a while (here only for netcdf4/h5netcdf backends):

There are other attempts to simplify the calling signature for coders:

Describe the solution you'd like

Consume all backend related keyword arguments in backend_kwargs. This is already part of the general api open_-functions. Instead of merging backend_kwargs with kwargs there, forward backend_kwargs to the backend and remove the backend related kwargs from the signature of those backend functions.

Instead check backend_kwargs for keywords known to the backend using the open_dataset_parameters class variable of the backend or similar. In case of yet unknown keywords issue a warning that this backend related keyword is currently not defined in the backend and the use is at own risk. Forward backend_kwargs to the respective backend open function.

Describe alternatives you've considered

  • Keep everything as is and deal with it when issues arise.

    Works, but has it's downsides. Users are restricted to keyword arguments already available in the calling signature. No straightforward testing, knowledge of backend code needed.

Additional context

Until now there wasn't a problem with having backend keyword arguments mixed with the other keyword arguments. But in ##9282/#10357 we get a naming clash which might not easily be resolved. Although this might be a one time solitary case, it introduces trouble.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant