Dtype field ordering for NumPy 1.14 #1837
Merged
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.
As reported in #1274, the fields are ordered "by position" instead of "by field name" as of NumPy 1.14. This PR sorts the fields by position before registering the dtype.
Perhaps it's worth debating if this goes against what the user wanted. An alternative approach would be to throw a more meaningful exception for Numpy >= 1.14, since we know the expected field order (e.g. "NumPy: Invalid field order while registering dtype, expecting: ..."). This would force the user to correctly order the fields without pybind doing it in the background. But the user would also have to be aware of that change in NumPy 1.14. IMHO the user mostly wants to just register the dtype and the proposed solution will do it across current versions.