8000 Fix: `dataclass` `InitVar`s shouldn't be required on serialization by sydney-runkle · Pull Request #1602 · pydantic/pydantic-core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix: dataclass InitVars shouldn't be required on serialization #1602

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

Merged
merged 14 commits into from
Jan 23, 2025
Merged

Fix: dataclass InitVars shouldn't be required on serialization #1602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
022e730
fix dataclass initvars not required on serialization
sydney-runkle Jan 21, 2025
2d0b850
Merge branch 'main' into fix-initvar-required
sydney-runkle Jan 21, 2025
327c60a
ensuring warning free serialization
sydney-runkle Jan 21, 2025
109749a
remove unhelpful test
sydney-runkle Jan 21, 2025
2d73a66
alternative solution
sydney-runkle Jan 21, 2025
3a027b5
skip init only fields
sydney-runkle Jan 21, 2025
369bed3
first pass as repro test
sydney-runkle Jan 21, 2025
42a98c1
simplify test
sydney-runkle Jan 21, 2025
e2f256f
only add to fields if not init only, fixing linting
sydney-runkle Jan 21, 2025
9ab1140
minify diff + add new test
sydney-runkle Jan 22, 2025
825fb9e
revert and use guard clause
sydney-runkle Jan 23, 2025
5cc59c2
revert lock changes
sydney-runkle Jan 23, 2025
14b6931
Merge branch 'main' into fix-initvar-required
sydney-runkle Jan 23, 2025
3e82624
whitespace
sydney-runkle Jan 23, 2025
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
20 changes: 11 additions & 9 deletions src/serializers/type_serializers/dataclass.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,17 @@ impl BuildSerializer for DataclassArgsBuilder {

let key_py: Py<PyString> = PyString::new(py, &name).into();

if field_info.get_as(intern!(py, "serialization_exclude"))? == Some(true) {
fields.insert(name, SerField::new(py, key_py, None, None, true));
} else {
let schema = field_info.get_as_req(intern!(py, "schema"))?;
let serializer = CombinedSerializer::build(&schema, config, definitions)
.map_err(|e| py_schema_error_type!("Field `{}`:\n {}", index, e))?;

let alias = field_info.get_as(intern!(py, "serialization_alias"))?;
fields.insert(name, SerField::new(py, key_py, alias, Some(serializer), true));
if !field_info.get_as(intern!(py, "init_only"))?.unwrap_or(false) {
if field_info.get_as(intern!(py, "serialization_exclude"))? == Some(true) {
fields.insert(name, SerField::new(py, key_py, None, None, true));
} else {
let schema = field_info.get_as_req(intern!(py, "schema"))?;
let serializer = CombinedSerializer::build(&schema, config, definitions)
.map_err(|e| py_schema_error_type!("Field `{}`:\n {}", index, e))?;

let alias = field_info.get_as(intern!(py, "serialization_alias"))?;
fields.insert(name, SerField::new(py, key_py, alias, Some(serializer), true));
}
}
}

Expand Down
43 changes: 43 additions & 0 deletions tests/serializers/test_dataclasses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,46 @@ class Model:
m = v.validate_python({'extra': 'extra'})

assert s.to_python(m) == {'extra': 'extra bam!'}


def test_dataclass_initvar_not_required_on_union_ser() -> None:
@dataclasses.dataclass
class Foo:
x: int
init_var: dataclasses.InitVar[int] = 1

@dataclasses.dataclass
class Bar:
x: int

schema = core_schema.union_schema(
[
core_schema.dataclass_schema(
Foo,
core_schema.dataclass_args_schema(
'Foo',
[
core_schema.dataclass_field(name='x', schema=core_schema.int_schema()),
core_schema.dataclass_field(
name='init_var',
init_only=True,
schema=core_schema.with_default_schema(core_schema.int_schema(), default=1),
),
],
),
['x'],
post_init=True,
),
core_schema.dataclass_schema(
Bar,
core_schema.dataclass_args_schema(
'Bar', [core_schema.dataclass_field(name='x', schema=core_schema.int_schema())]
),
['x'],
),
]
)

s = SchemaSerializer(schema)
assert s.to_python(Foo(x=1), warnings='error') == {'x': 1}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please can you add a test with just the Foo schema, and a test for Bar here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and can you add a test for Foo(x=1, init_var=2)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please can you add a test with just the Foo schema, and a test for Bar here.

Not quite sure what you mean here - I wasn't able to repro the issue without the union.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still it's still worth adding tests for the simplest cases.

assert s.to_python(Foo(x=1, init_var=2), warnings='error') == {'x': 1}
Loading
0