-
Notifications
You must be signed in to change notification settings - Fork 12
Fix EnumSerializer.write to accept numpy scalars from NDArray of records #285
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
Open
SAY-5
wants to merge
1
commit into
microsoft:main
Choose a base branch
from
SAY-5:say5-fix-enum-numpy-ndarray
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+56
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Copyright (c) Microsoft Corporation. | ||
| # Licensed under the MIT License. | ||
|
|
||
| """Regression test for #284: EnumSerializer.write must accept numpy scalars | ||
| extracted from a structured NDArray of records with enum fields.""" | ||
|
|
||
| import io | ||
| import sys | ||
| from pathlib import Path | ||
|
|
||
| import numpy as np | ||
| import pytest | ||
|
|
||
| sys.path.insert(0, str(Path(__file__).resolve().parents[1])) | ||
|
|
||
| from test_model import _binary, basic_types # noqa: E402 | ||
| from test_model.binary import RecordWithEnumsSerializer # noqa: E402 | ||
|
|
||
|
|
||
| def test_record_with_enums_write_numpy_does_not_raise(): | ||
| """Writing an NDArray whose elements are records containing enum fields | ||
| must not raise AttributeError when EnumSerializer.write receives a raw | ||
| numpy scalar (e.g. np.uint64) extracted via value['fieldname'].""" | ||
| ser = RecordWithEnumsSerializer() | ||
| arr = np.zeros((1,), dtype=ser.overall_dtype()) | ||
| buf = io.BytesIO() | ||
| stream = _binary.CodedOutputStream(buf) | ||
| # write_numpy iterates fields as numpy scalars; previously raised | ||
| # "AttributeError: 'numpy.uint64' object has no attribute 'value'" | ||
| ser.write_numpy(stream, arr[0]) | ||
| stream.flush() | ||
| assert len(buf.getvalue()) > 0 | ||
|
|
||
|
|
||
| def test_enum_serializer_write_accepts_numpy_scalar(): | ||
| """EnumSerializer.write must accept raw numpy scalars passed via | ||
| RecordSerializer._write from the write_numpy path.""" | ||
| es = _binary.EnumSerializer(_binary.uint64_serializer, basic_types.TextFormat) | ||
| buf = io.BytesIO() | ||
| stream = _binary.CodedOutputStream(buf) | ||
| es.write(stream, np.uint64(3)) | ||
| stream.flush() | ||
| assert len(buf.getvalue()) > 0 | ||
|
|
||
|
|
||
| def test_enum_serializer_write_still_accepts_enum(): | ||
| """EnumSerializer.write must keep accepting Enum instances on the | ||
| Python (non-numpy) write path.""" | ||
| es = _binary.EnumSerializer(_binary.int32_serializer, basic_types.Fruits) | ||
| buf = io.BytesIO() | ||
| stream = _binary.CodedOutputStream(buf) | ||
| es.write(stream, basic_types.Fruits.APPLE) | ||
| stream.flush() | ||
| assert len(buf.getvalue()) > 0 |
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not the right way to test this.
The test model should be updated such that it reproduces the issue. Then regression tests can be added to
test_generated_types.pyandtest_protocol_roundtrip.py. Then, an equivalent test should be added for C++ and MATLAB to ensure no similar bugs exist.