"exclude" filters don't appear to work correctly with msgspec structs

[BenGatewood]

Describe the bug

When I try and exclude attributes from a custom class that inherits from msgspec.Struct the syntax/approach from the docs doesn't seem to produce the desired behaviour and the excluded attributes remain in the snapshot

To reproduce

from syrupy.filters import props


class Base(msgspec.Struct):
    foo: str
    bar: int


def test_base(snapshot):
    b = Base(
        foo="baz",
        bar=5,
    )

    assert b == snapshot(exclude=props("bar"))

Expected behavior

From the above example, I would expect a snapshot like:

# name: test_base
  Base(foo='baz')
# ---

Environment (please complete the following information):

• OS: Mac OSX 13.5
• Syrupy Version: 4.0.8
• Python Version: 3.11

Additional context

Thanks for looking!

[noahnu]

Custom classes are serialized by calling repr, see:

syrupy/src/syrupy/extensions/amber/serializer.py

Line 373 in 2ed84ea

def __serialize_plain(

Since repr returns a string, we don't have a way to modify the result of calling repr to apply an exclude. You could extend the serializer to support msgspec.Struct:

import pytest
from typing import Any
from syrupy.filters import props
from syrupy.extensions.amber import AmberSnapshotExtension, AmberDataSerializer

import msgspec

class MySpec(msgspec.Struct):
    a: str
    b: int


class ExtendedAmberDataSerializer(AmberDataSerializer):
    @classmethod
    def serialize_unknown(cls, data: Any, *, depth: int = 0, **kwargs: Any) -> str:
        if isinstance(data, (msgspec.Struct,)):
            return cls.serialize_custom_iterable(
                data=data,
                resolve_entries=(
                    cls.sort(data.__struct_fields__),
                    lambda o, p: getattr(o, str(p)),
                    None
                ),
                separator="=",
                **kwargs
            )
        return super().serialize_unknown(data, depth=depth, **kwargs)


class ExtendedAmberSnapshotExtension(AmberSnapshotExtension):
    serializer_class = ExtendedAmberDataSerializer


@pytest.fixture
def snapshot(snapshot):
    return snapshot.use_extension(ExtendedAmberSnapshotExtension)

def test_case(snapshot):
    assert MySpec(a="word", b=3) == snapshot(exclude=props("a"))

I acknowledge the serializer can be improved here.. I think we could expose an alternative to serialize_dict to handle repr a bit better

---

Note that "serialize_custom_iterable" requires syrupy v4.1.0 (just released today).

[noahnu]

Updated my example using serialize_custom_iterable which I've exposed in v4.1.0.

[BenGatewood]

Nice one - thanks! I'll have a go with this method for the moment

[noahnu]

Will close out this issue then. Feel free to comment and I'll re-open if there are other ways we can make this simpler.