Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 19 additions & 8 deletions src/cattrs/gen/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from collections.abc import Callable, Iterable, Mapping
from typing import TYPE_CHECKING, Any, Final, Literal, TypeVar

from attrs import NOTHING, Attribute, Factory
from attrs import NOTHING, Attribute, Converter, Factory
from typing_extensions import NoDefault

from .._compat import (
Expand Down Expand Up @@ -177,16 +177,27 @@ def make_dict_unstructure_fn_from_attrs(
if isinstance(d, Factory):
globs[def_name] = d.factory
internal_arg_parts[def_name] = d.factory
if d.takes_self:
lines.append(f" if instance.{attr_name} != {def_name}(instance):")
else:
lines.append(f" if instance.{attr_name} != {def_name}():")
lines.append(f" res['{kn}'] = {invoke}")
def_str = f"{def_name}(instance)" if d.takes_self else f"{def_name}()"
else:
globs[def_name] = d
internal_arg_parts[def_name] = d
lines.append(f" if instance.{attr_name} != {def_name}:")
lines.append(f" res['{kn}'] = {invoke}")
def_str = def_name

c = a.converter
if c is not None:
conv_name = f"__c_conv_{attr_name}"
globs[conv_name] = c
internal_arg_parts[conv_name] = c
if isinstance(c, Converter):
field_name = f"__c_field_{attr_name}"
globs[field_name] = a
internal_arg_parts[field_name] = a
def_str = f"{conv_name}({def_str}, instance, {field_name})"
else:
Copy link
Member

Choose a reason for hiding this comment

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

If the default is not a Factory, and the converter is not a Converter, we can calculate the default at hook generation time (as opposed to hook run time). It's just converter(default).

Maybe something like:

            c = a.converter
            if c is not None:
                conv_name = f"__c_conv_{attr_name}"
                if isinstance(c, Converter):
                    globs[conv_name] = c
                    internal_arg_parts[conv_name] = c
                    field_name = f"__c_field_{attr_name}"
                    globs[field_name] = a
                    internal_arg_parts[field_name] = a
                    def_str = f"{conv_name}({def_str}, instance, {field_name})"
                elif not isinstance(d, Factory):
                    globs[def_name] = c(globs[def_name])
                else:
                    globs[conv_name] = c
                    internal_arg_parts[conv_name] = c
                    def_str = f"{conv_name}({def_str})"

def_str = f"{conv_name}({def_str})"

lines.append(f" if instance.{attr_name} != {def_str}:")
lines.append(f" res['{kn}'] = {invoke}")

else:
# No default or no override.
Expand Down
26 changes: 26 additions & 0 deletions tests/test_converter.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
Union,
)

import attrs
import pytest
from attrs import Factory, define, field, fields, has, make_class
from hypothesis import assume, given
Expand Down Expand Up @@ -339,6 +340,31 @@ class C:
assert inst == converter.structure(unstructured, C)


@given(simple_typed_classes(defaults="always", allow_nan=False))
def test_omit_default_with_attrs_converter_roundtrip(cl_and_vals):
"""
Omit default with attrs' converter on the converter works.
"""
converter = Converter(omit_if_default=True)
cl, vals, kwargs = cl_and_vals

@define
class C:
a1: int = field(default="1", converter=int)
a2: int = field(default="1", converter=attrs.Converter(int))
c: cl = Factory(lambda: cl(*vals, **kwargs))

inst = C()
unstructured = converter.unstructure(inst)
assert unstructured == {}
assert inst == converter.structure(unstructured, C)

inst = C(0, 0)
unstructured = converter.unstructure(inst)
assert unstructured == {"a1": 0, "a2": 0}
assert inst == converter.structure(unstructured, C)


def test_dict_roundtrip_with_alias():
"""
A class with an aliased attribute can be unstructured and structured.
Expand Down