Ensure Masked scalars print the same way as regular array scalars #15451
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
|
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
|
Who should review this? |
nstarman
reviewed
Oct 10, 2023
| return self.maybe_mask_string(self.format_function(x.unmasked[()]), x.mask) | ||
|
|
||
| @staticmethod | ||
| def maybe_mask_string(string, mask): |
There was a problem hiding this comment.
I wondered about separating it out at least if the function is used outside of the class, but looking at it again, realized I could just use the class, which for this bug-fix PR seems cleaner. So, this change is now reverted.
| # Override to change special treatment of array scalars, since the numpy | ||
| # code turns the masked array scalar into a regular array scalar. | ||
| if a.shape == () and a.dtype.names is None: | ||
| return MaskedFormat.maybe_mask_string(np.array_str(a.unmasked), a.mask) |
There was a problem hiding this comment.
that would follow through to here.
There was a problem hiding this comment.
I now use MaskedFormat explicitly, with np.array_str as the format function. That seems cleaner.
Eventually, I'd like to give the option of using different ways to indicate masked - in particular, with strikethrough! (but it is tricky since not all terminals support the utf-8 way of doing it; see line 965)
Comment on lines
1300
to
1310
| assert str(msa) == "[3.14159265 ———]" | ||
| assert str(msa[0]) == "3.141592653589793" == str(sa[0]) | ||
| assert str(msa[1]) == " ———" | ||
| with np.printoptions(precision=3, floatmode="fixed"): | ||
| assert str(msa) == "[3.142 ———]" | ||
| assert str(msa[0]) == "3.141592653589793" == str(sa[0]) | ||
| assert repr(msa) == "MaskedNDArray([3.14159265, ———])" |
There was a problem hiding this comment.
Suggested change
| assert str(msa) == "[3.14159265 ———]" | |
| assert str(msa[0]) == "3.141592653589793" == str(sa[0]) | |
| assert str(msa[1]) == " ———" | |
| with np.printoptions(precision=3, floatmode="fixed"): | |
| assert str(msa) == "[3.142 ———]" | |
| assert str(msa[0]) == "3.141592653589793" == str(sa[0]) | |
| assert repr(msa) == "MaskedNDArray([3.14159265, ———])" | |
| # Test masking the array works as expected, including truncating digits | |
| assert str(msa) == "[3.14159265 ———]" | |
| # Test the digits are kept | |
| assert str(msa[0]) == "3.141592653589793" == str(sa[0]) | |
| # Or appropriately masked | |
| assert str(msa[1]) == " ———" | |
| # Test the precision can be changed temporarily. | |
| with np.printoptions(precision=3, floatmode="fixed"): | |
| assert str(msa) == "[3.142 ———]" | |
| assert str(msa[0]) == "3.141592653589793" == str(sa[0]) | |
| assert repr(msa) == "MaskedNDArray([3.14159265, ———])" |
There was a problem hiding this comment.
Yes, good idea. Implemented.
mhvk
force-pushed
the
masked-scalar-str
branch
from
5e4510f
to
3dd8ada
Compare
nstarman
approved these changes
Oct 10, 2023
mhvk
force-pushed
the
masked-scalar-str
branch
from
3dd8ada
to
3e07dc6
Compare
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.
Description
This pull request is to ensured that
str(masked_array)looks likestr(unmasked_array)also for array scalars. Thus, like regular array scalars, the precision is ignored for float, and strings do not include extra quoting.Found in #15231
I think this should not be backported, since it is not nice if
str(anything)changes in a bug-fix release. But I do consider it more of a bug-fix than an API change (though happy to change it if need be).