serialize_by_alias tests

Author: sydney-runkle

tests/serializers/test_dataclasses.py

@@ -235,3 +235,44 @@ class Bar:
     s = SchemaSerializer(schema)
     assert s.to_python(Foo(x=1), warnings='error') == {'x': 1}
     assert s.to_python(Foo(x=1, init_var=2), warnings='error') == {'x': 1}
+
+
+@pytest.mark.parametrize(
+    'config,runtime,expected',
+    [
+        (True, True, {'A': 'hello'}),
+        (True, False, {'a': 'hello'}),
+        (True, None, {'A': 'hello'}),
+        (False, True, {'A': 'hello'}),
+        (False, False, {'a': 'hello'}),
+        (False, None, {'a': 'hello'}),
+        (None, True, {'A': 'hello'}),
+        (None, False, {'a': 'hello'}),
+        (None, None, {'a': 'hello'}),
+    ],
+)
+def test_alias_by_config_via_runtime_setting(config, runtime, expected) -> None:
+    """This test reflects the priority that applies for config vs runtime serialization alias configuration.
+
+    If the runtime value (by_alias) is set, that value is used.
+    If the runtime value is unset, the config value (serialize_by_alias) is used.
+    If neither are set, the default, False, is used.
+    """
+
+    @dataclasses.dataclass
+    class Foo:
+        a: str
+
+    schema = core_schema.dataclass_schema(
+        Foo,
+        core_schema.dataclass_args_schema(
+            'Foo',
+            [
+                core_schema.dataclass_field(name='a', schema=core_schema.str_schema(), serialization_alias='A'),
+            ],
+        ),
+        ['a'],
+        config=core_schema.CoreConfig(serialize_by_alias=config) if config is not None else {},
+    )
+    s = SchemaSerializer(schema)
+    assert s.to_python(Foo(a='hello'), by_alias=runtime) == expected

tests/serializers/test_model.py

@@ -1174,3 +1174,42 @@ class BModel(BasicModel): ...
     with pytest.warns(UserWarning, match='Expected 2 fields but got 1 for type `.*AModel` with value `.*`.+'):
         value = BasicModel(root=AModel(type='a'))
         s.to_python(value)
+
+
+@pytest.mark.parametrize(
+    'config,runtime,expected',
+    [
+        (True, True, {'A': 1}),
+        (True, False, {'a': 1}),
+        (True, None, {'A': 1}),
+        (False, True, {'A': 1}),
+        (False, False, {'a': 1}),
+        (False, None, {'a': 1}),
+        (None, True, {'A': 1}),
+        (None, False, {'a': 1}),
+        (None, None, {'a': 1}),
+    ],
+)
+def test_alias_by_config_via_runtime_setting(config, runtime, expected) -> None:
+    """This test reflects the priority that applies for config vs runtime serialization alias configuration.
+
+    If the runtime value (by_alias) is set, that value is used.
+    If the runtime value is unset, the config value (serialize_by_alias) is used.
+    If neither are set, the default, False, is used.
+    """
+
+    class Model:
+        def __init__(self, a: int) -> None:
+            self.a = a
+
+    schema = core_schema.model_schema(
+        Model,
+        core_schema.model_fields_schema(
+            {
+                'a': core_schema.model_field(core_schema.int_schema(), serialization_alias='A'),
+            }
+        ),
+        config=core_schema.CoreConfig(serialize_by_alias=config) if config is not None else {},
+    )
+    s = SchemaSerializer(schema)
+    assert s.to_python(Model(1), by_alias=runtime) == expected

tests/serializers/test_typed_dict.py

@@ -333,3 +333,37 @@ def test_extra_custom_serializer():
     m = {'extra': 'extra'}
 
     assert s.to_python(m) == {'extra': 'extra bam!'}
+
+
+@pytest.mark.parametrize(
+    'config,runtime,expected',
+    [
+        (True, True, {'A': 1}),
+        (True, False, {'a': 1}),
+        (True, None, {'A': 1}),
+        (False, True, {'A': 1}),
+        (False, False, {'a': 1}),
+        (False, None, {'a': 1}),
+        (None, True, {'A': 1}),
+        (None, False, {'a': 1}),
+        (None, None, {'a': 1}),
+    ],
+)
+def test_alias_by_config_via_runtime_setting(config, runtime, expected) -> None:
+    """This test reflects the priority that applies for config vs runtime serialization alias configuration.
+
+    If the runtime value (by_alias) is set, that value is used.
+    If the runtime value is unset, the config value (serialize_by_alias) is used.
+    If neither are set, the default, False, is used.
+    """
+
+    class Model(TypedDict):
+        a: int
+
+    schema = core_schema.typed_dict_schema(
+        {
+            'a': core_schema.typed_dict_field(core_schema.int_schema(), serialization_alias='A'),
+        },
+    )
+    s = SchemaSerializer(schema, config=core_schema.CoreConfig(serialize_by_alias=config) if config is not None else {})
+    assert s.to_python(Model(a=1), by_alias=runtime) == expected