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.

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

Type hints for xr.open_dataset #5382

Closed
adamjstewart opened this issue May 26, 2021 · 4 comments · Fixed by #6612
Closed

Type hints for xr.open_dataset #5382

adamjstewart opened this issue May 26, 2021 · 4 comments · Fixed by #6612

Comments

@adamjstewart
Copy link

I've noticed that xarray has partial type hinting support. What's the timeline for full type hinting support? In particular, I'm seeing:

error: Call to untyped function "open_dataset" in typed context

because xr.open_dataset does not yet have type hints.

@shoyer
Copy link
Member

shoyer commented May 26, 2021

There's no timeline for complete type hinting -- or most other features in xarray, for that matter. Xarray is mostly a volunteer run project that depends on user contributions.

We would certainly welcome the addition of type hints for open_dataset(). At the very least, we could clarify that open_dataset() return an xarray.Dataset object.

@adamjstewart
Copy link
Author

Good to know, I'll try to add type hints and submit a PR if I get the chance.

@krishnaap
Copy link

@shoyer how can I contribute to type hinting?

@max-sixty
Copy link
Collaborator

@krishnaap we'd welcome a Pull Request!

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

Successfully merging a pull request may close this issue.

5 participants