Tidy up of the io doc strings and API page. Deprecate toplevel io namespace. #7537
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nabobalis
added
Documentation
nabobalis
changed the title
nabobalis
changed the title
wtbarnes
reviewed
Apr 8, 2024
wtbarnes
approved these changes
May 18, 2024
sunpy/io/tests/test_filetools.py
Outdated
| assert mock.call_args[0][0] == url | ||
| assert isinstance(hdulist, list) | ||
| assert len(hdulist) == 1 | ||
| assert len(hdulist[0]) == 2 | ||
| assert isinstance(hdulist[0][0], np.ndarray) | ||
| assert isinstance(hdulist[0][1], sunpy.io.header.FileHeader) | ||
| assert isinstance(hdulist[0][1], sunpy.io._header.FileHeader) |
There was a problem hiding this comment.
Won't this fail since you've removed import sunpy.io?
There was a problem hiding this comment.
I still import it no?!
There was a problem hiding this comment.
Why does that still work?!
It surely won't get it from import sunpy so?!
There was a problem hiding this comment.
I imported it for my sanity.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
wtbarnes
approved these changes
May 18, 2024
nabobalis
commented
May 19, 2024
sunpy/io/__init__.py
Outdated
Comment on lines
9
to
10
| warn_deprecated('The toplevel space of the io subpackage was never intended for public use and will be removed in the future.') | ||
| from sunpy.io._file_tools import read_file, write_file |
There was a problem hiding this comment.
I think this is wrong.
I get the message if I do:
In [3]: import sunpy.io._header
WARNING: SunpyDeprecationWarning: The toplevel space of the io subpackage was never intended for public use and will be removed in the future. [sunpy.io]I should not be raising this warning if someone does import that.
There was a problem hiding this comment.
Or even:
import sunpy.io.special.asdf
As it stands, we can't merge this till I fix this.
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
|
TODO: Fix CI |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog check will fail as I had to change other changelogs but I did add one.