1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
"""Tests for field name resolver functionality."""
from __future__ import annotations
import pytest
from datamodel_code_generator.reference import FieldNameResolver
@pytest.mark.parametrize(
("name", "expected_resolved"),
[
("3a", "field_3a"),
("$in", "field_in"),
("field", "field"),
],
)
def test_get_valid_field_name(name: str, expected_resolved: str) -> None:
"""Test field name resolution to valid Python identifiers."""
resolver = FieldNameResolver()
assert expected_resolved == resolver.get_valid_name(name)
def test_hierarchical_flat_alias() -> None:
"""Test traditional flat alias resolution."""
resolver = FieldNameResolver(aliases={"name": "name_alias"})
field_name, alias = resolver.get_valid_field_name_and_alias("name")
assert field_name == "name_alias"
assert alias == "name"
def test_hierarchical_scoped_alias() -> None:
"""Test scoped alias resolution (ClassName.field)."""
resolver = FieldNameResolver(
aliases={
"User.name": "user_name",
"Address.name": "address_name",
"name": "default_name",
}
)
field_name, alias = resolver.get_valid_field_name_and_alias("name", class_name="User")
assert field_name == "user_name"
assert alias == "name"
field_name, alias = resolver.get_valid_field_name_and_alias("name", class_name="Address")
assert field_name == "address_name"
assert alias == "name"
field_name, alias = resolver.get_valid_field_name_and_alias("name", class_name="Other")
assert field_name == "default_name"
assert alias == "name"
def test_hierarchical_alias_priority() -> None:
"""Test that scoped aliases have priority over flat aliases."""
resolver = FieldNameResolver(
aliases={
"User.name": "scoped_name",
"name": "flat_name",
}
)
field_name, _ = resolver.get_valid_field_name_and_alias("name", class_name="User")
assert field_name == "scoped_name"
field_name, _ = resolver.get_valid_field_name_and_alias("name", class_name="Other")
assert field_name == "flat_name"
def test_hierarchical_class_name_provided_but_no_scoped_aliases() -> None:
"""Test when class_name is provided but no scoped aliases are configured."""
resolver = FieldNameResolver(aliases={"name": "name_alias"})
field_name, alias = resolver.get_valid_field_name_and_alias("name", class_name="User")
assert field_name == "name_alias"
assert alias == "name"
def test_hierarchical_scoped_alias_not_matching() -> None:
"""Test when scoped alias exists but doesn't match current class."""
resolver = FieldNameResolver(
aliases={
"Other.name": "other_name",
"name": "default_name",
}
)
field_name, alias = resolver.get_valid_field_name_and_alias("name", class_name="User")
assert field_name == "default_name"
assert alias == "name"
def test_hierarchical_no_alias_match() -> None:
"""Test that unmatched fields return valid name without alias."""
resolver = FieldNameResolver(aliases={"other": "other_alias"})
field_name, alias = resolver.get_valid_field_name_and_alias("name")
assert field_name == "name"
assert alias is None
def test_hierarchical_backward_compatibility() -> None:
"""Test that existing flat alias behavior is preserved."""
resolver = FieldNameResolver(aliases={"name": "name_", "id": "id_"})
field_name, alias = resolver.get_valid_field_name_and_alias("name")
assert field_name == "name_"
assert alias == "name"
field_name, alias = resolver.get_valid_field_name_and_alias("id")
assert field_name == "id_"
assert alias == "id"
def test_hierarchical_dotted_field_name_alias() -> None:
"""Test that field names containing dots can be aliased (backward compat)."""
resolver = FieldNameResolver(aliases={"filter.name": "filter_name_alias"})
field_name, alias = resolver.get_valid_field_name_and_alias("filter.name")
assert field_name == "filter_name_alias"
assert alias == "filter.name"
def test_hierarchical_dotted_field_name_without_class_name() -> None:
"""Test dotted field name alias works without class_name parameter."""
resolver = FieldNameResolver(
aliases={
"a.b": "a_b_alias",
"User.name": "user_name",
}
)
field_name, alias = resolver.get_valid_field_name_and_alias("a.b")
assert field_name == "a_b_alias"
assert alias == "a.b"
def test_hierarchical_path_parameter_backward_compatibility() -> None:
"""Test that path parameter is accepted but ignored."""
resolver = FieldNameResolver(aliases={"name": "name_alias"})
field_name, alias = resolver.get_valid_field_name_and_alias("name", path=["root", "properties", "name"])
assert field_name == "name_alias"
assert alias == "name"
|