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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
|
"""Tests for dataclass parameter options (frozen, keyword_only)."""
from __future__ import annotations
from datamodel_code_generator.model.dataclass import DataClass, DataModelField
from datamodel_code_generator.reference import Reference
from datamodel_code_generator.types import DataType
def test_dataclass_without_frozen() -> None:
"""Test dataclass generation without frozen parameter."""
reference = Reference(path="TestModel", name="TestModel")
field = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
dataclass = DataClass(
reference=reference,
fields=[field],
frozen=False,
)
rendered = dataclass.render()
assert "@dataclass" in rendered
assert "frozen=True" not in rendered
assert "class TestModel:" in rendered
def test_dataclass_with_frozen() -> None:
"""Test dataclass generation with frozen=True."""
reference = Reference(path="TestModel", name="TestModel")
field = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
dataclass = DataClass(
reference=reference,
fields=[field],
frozen=True,
)
rendered = dataclass.render()
assert "@dataclass(frozen=True)" in rendered
assert "class TestModel:" in rendered
def test_dataclass_with_keyword_only_and_frozen() -> None:
"""Test dataclass generation with both keyword_only and frozen parameters."""
reference = Reference(path="TestModel", name="TestModel")
field = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
dataclass = DataClass(
reference=reference,
fields=[field],
keyword_only=True,
frozen=True,
)
rendered = dataclass.render()
assert "@dataclass" in rendered
assert "kw_only=True" in rendered
assert "frozen=True" in rendered
assert "class TestModel:" in rendered
def test_dataclass_with_only_keyword_only() -> None:
"""Test dataclass generation with only keyword_only parameter."""
reference = Reference(path="TestModel", name="TestModel")
field = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
dataclass = DataClass(
reference=reference,
fields=[field],
keyword_only=True,
frozen=False,
)
rendered = dataclass.render()
assert "@dataclass" in rendered
assert "kw_only=True" in rendered
assert "frozen=True" not in rendered
assert "class TestModel:" in rendered
def test_dataclass_frozen_attribute() -> None:
"""Test that frozen attribute is properly stored."""
reference = Reference(path="TestModel", name="TestModel")
dataclass = DataClass(
reference=reference,
fields=[],
frozen=True,
)
assert dataclass.frozen is True
def test_dataclass_frozen_false_attribute() -> None:
"""Test that frozen attribute defaults to False."""
reference = Reference(path="TestModel", name="TestModel")
dataclass = DataClass(
reference=reference,
fields=[],
)
assert dataclass.frozen is False
def test_dataclass_kw_only_true_only() -> None:
"""Test dataclass generation with kw_only=True only (comprehensive test)."""
reference = Reference(path="TestModel", name="TestModel")
field1 = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
field2 = DataModelField(
name="field2",
data_type=DataType(type="int"),
required=False,
)
dataclass = DataClass(
reference=reference,
fields=[field1, field2],
keyword_only=True,
)
rendered = dataclass.render()
# Should have @dataclass(kw_only=True) but not frozen=True
assert "@dataclass(kw_only=True)" in rendered
assert "frozen=True" not in rendered
assert "class TestModel:" in rendered
# Verify frozen attribute is False (default)
assert dataclass.frozen is False
assert dataclass.keyword_only is True
def test_dataclass_legacy_keyword_only() -> None:
"""Test that legacy 'frozen' argument is supported if dataclass_arguments is not set."""
reference = Reference(path="TestModel", name="TestModel")
field = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
dataclass = DataClass(
reference=reference,
fields=[field],
keyword_only=True,
)
rendered = dataclass.render()
assert "@dataclass(kw_only=True)" in rendered
def test_dataclass_legacy_frozen() -> None:
"""Test that legacy 'frozen' argument is supported if dataclass_arguments is not set."""
reference = Reference(path="TestModel", name="TestModel")
field = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
dataclass = DataClass(
reference=reference,
fields=[field],
frozen=True,
)
rendered = dataclass.render()
assert "@dataclass(frozen=True)" in rendered
def test_dataclass_with_custom_dataclass_arguments() -> None:
"""Test that custom dataclass_arguments are rendered correctly."""
reference = Reference(path="TestModel", name="TestModel")
field = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
dataclass = DataClass(
reference=reference,
fields=[field],
dataclass_arguments={"slots": True, "repr": False, "order": True},
)
rendered = dataclass.render()
assert "@dataclass(slots=True, order=True)" in rendered
assert "repr=False" not in rendered
def test_dataclass_both_legacy_and_dataclass_arguments() -> None:
"""Test that dataclass_arguments take precedence over legacy flags."""
reference = Reference(path="TestModel", name="TestModel")
field = DataModelField(
name="field1",
data_type=DataType(type="str"),
required=True,
)
dataclass = DataClass(
reference=reference,
fields=[field],
frozen=True, # legacy flag
keyword_only=True, # legacy flag
dataclass_arguments={"frozen": False, "order": True},
)
rendered = dataclass.render()
assert "@dataclass(order=True)" in rendered
assert "@dataclass(frozen=False)" not in rendered
assert "@dataclass(frozen=True)" not in rendered
assert "@dataclass(kw_only=False)" not in rendered
assert "@dataclass(kw_only=True)" not in rendered
|