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

Skip to content

Clean up FileIO type hints #25655

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

Merged
merged 1 commit into from
Apr 12, 2023
Merged

Clean up FileIO type hints #25655

merged 1 commit into from
Apr 12, 2023

Conversation

ksunden
Copy link
Member

@ksunden ksunden commented Apr 10, 2023

PR Summary

Turns out io.FileIO is not the ideal type hint, and excludes some common usage such as io.BytesIO.

This also ensures that the filename or file object type hints include pathlib.Path.

These were discovered by running typecheckers over some of our larger downstream users, such as xarray, seaborn, and plotnine.
(Note that there are a small handful of additional changes to type hints required for these libraries, but those will come in as PRs of only related ideas)

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@QuLogic QuLogic added this to the v3.8.0 milestone Apr 10, 2023
@tacaswell tacaswell closed this Apr 11, 2023
@tacaswell tacaswell reopened this Apr 11, 2023
@tacaswell
Copy link
Member

powercycled to restart CI. I assume these failures are the nbconvert issue that just went by?

@QuLogic QuLogic merged commit bff4681 into matplotlib:main Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants