Skip to content

Fix overriding an inherited field alias back to the field's own name #1133

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.

Sign up for GitHub

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
rvaccone wants to merge 1 commit into
base: main
Choose a base branch
from
+32 −1
Open

Fix overriding an inherited field alias back to the field's own name #1133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/msgspec/_core.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5908,7 +5908,12 @@ structmeta_process_rename(
((Field *)default_value)->name != NULL
) {
Field *field = (Field *)default_value;
if (PyUnicode_Compare(name, field->name) == 0) return 0;
if (PyUnicode_Compare(name, field->name) == 0) {
if (PyDict_GetItem(info->renamed_fields, name) != NULL) {
return PyDict_DelItem(info->renamed_fields, name);
}
return 0;
}
return PyDict_SetItem(info->renamed_fields, name, field->name);
}

Expand Down Expand Up @@ -5953,6 +5958,9 @@ structmeta_process_rename(
if (PyUnicode_Compare(name, temp) != 0) {
out = PyDict_SetItem(info->renamed_fields, name, temp);
}
else if (PyDict_GetItem(info->renamed_fields, name) != NULL) {
out = PyDict_DelItem(info->renamed_fields, name);
}
Py_DECREF(temp);
return out;
}
Expand Down
23 changes: 23 additions & 0 deletions tests/unit/test_struct.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2102,6 +2102,29 @@ class Test4(Base, rename=None):

assert Test4.__struct_encode_fields__ == ("my_field",)

def test_field_name_override_inherited(self):
class Base(Struct):
x: int = field(name="_x")

class Test1(Base):
x: int = field(name="x")

assert Test1.__struct_encode_fields__ == ("x",)

class Test2(Base):
x: int = 1

assert Test2.__struct_encode_fields__ == ("_x",)

def test_rename_override_inherited(self):
class Base(Struct, rename="upper"):
x: int

class Test(Base, rename="lower"):
x: int

assert Test.__struct_encode_fields__ == ("x",)

def test_rename_fields_only_used_for_encode_and_decode(self):
"""Check that the renamed fields don't show up elsewhere"""

Expand Down
Loading