Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add xarray.show_backends alias #9821

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add xarray.show_backends alias #9821

wants to merge 2 commits into from

Conversation

VeckoTheGecko
Copy link
Contributor

@VeckoTheGecko VeckoTheGecko commented Nov 25, 2024 •
edited
Loading

  • Closes ENH: list_engines function #6577
  • Tests added
  • User visible changes (including notable bug fixes) are documented in whats-new.rst
  • New functions/methods are listed in api.rst

Implemented according to #6577 (comment)

headtr1ck
headtr1ck approved these changes Dec 24, 2024
View reviewed changes
Copy link
Collaborator

@headtr1ck headtr1ck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Certainly would improve discoverability if top level API.

Not sure on the name, maybe backend is better than engine, but whether list or show....
Does anyone have a stronger preference on this?

xarray/backends/plugins.py
@@ -132,6 +132,19 @@ def list_engines() -> dict[str, BackendEntrypoint]:
return build_engines(entrypoints)


def show_backends() -> dict[str, BackendEntrypoint]:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
def show_backends() -> dict[str, BackendEntrypoint]:
show_backends = list_engines

Would be easier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@headtr1ck headtr1ck headtr1ck approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ENH: list_engines function
3 participants
@VeckoTheGecko @headtr1ck @dcherian