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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
# ------------------------------------------------------------------------------
# Copyright (c) 2021-2025, Nucleic Development Team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file LICENSE, distributed with this software.
# ------------------------------------------------------------------------------
"""Test defining an atom class using typing annotations."""
import logging
from collections import defaultdict
from typing import (
Any,
Callable as TCallable,
ClassVar,
DefaultDict as TDefaultDict,
Dict as TDict,
Final,
Iterable,
List as TList,
Literal,
Optional,
Set as TSet,
Tuple as TTuple,
Type,
TypeVar,
Union,
get_args,
)
import pytest
from atom.api import (
Atom,
Bool,
Bytes,
Callable,
DefaultDict,
Dict,
Enum,
FixedTuple,
Float,
Instance,
Int,
List,
Member,
Set,
SetAttr,
Str,
Subclass,
Tuple,
Typed,
Value,
)
from atom.atom import set_default
def test_ignore_annotations():
class A(Atom, use_annotations=False):
a: int
assert not hasattr(A, "a")
def test_reject_str_annotations():
with pytest.raises(TypeError):
class A(Atom, use_annotations=True):
a: "int"
def test_ignore_class_var():
class A(Atom, use_annotations=True):
a: ClassVar[int] = 1
assert not isinstance(A.a, Member)
def test_ignore_annotated_member():
class A(Atom, use_annotations=True):
a: List[int] = List(default=[1, 2, 3])
assert A().a == [1, 2, 3]
def test_ignore_str_annotated_member():
class A(Atom, use_annotations=True):
b: "List[int]" = List(default=[1, 2, 3])
assert A().b == [1, 2, 3]
def test_ignore_annotated_set_default():
class A(Atom, use_annotations=True):
a = Value()
class B(A, use_annotations=True):
a: Value[int] = set_default(1)
assert B().a == 1
def test_ignore_str_annotated_set_default():
class A(Atom, use_annotations=True):
a = Value()
class B(A, use_annotations=True):
a: "Value[int]" = set_default(1)
assert B().a == 1
def test_reject_bare_member_annotated_member():
with pytest.raises(ValueError) as e:
class A(Atom, use_annotations=True):
a: List
assert "field 'a' of 'A'" in e.exconly()
assert e.value.__cause__
def test_reject_non_member_annotated_member():
with pytest.raises(TypeError):
class A(Atom, use_annotations=True):
a: TList[int] = List(int, default=[1, 2, 3])
def test_reject_non_member_annotated_set_default():
class A(Atom, use_annotations=True):
a = Value()
with pytest.raises(TypeError):
class B(A, use_annotations=True):
a: int = set_default(1)
@pytest.mark.parametrize("final", [True, False])
@pytest.mark.parametrize(
"annotation, member",
[
(bool, Bool),
(int, Int),
(float, Float),
(str, Str),
(bytes, Bytes),
(Any, Value),
(object, Value),
(TCallable, Callable),
(TCallable[[int], int], Callable),
(logging.Logger, Typed),
(Iterable, Instance),
(Type[int], Subclass),
(Type[TypeVar("T")], Subclass),
(Literal[1, 2, "a"], Enum),
],
)
def test_annotation_use(final, annotation, member):
if final:
ann = Final[annotation]
else:
ann = annotation
class A(Atom, use_annotations=True):
a: ann
assert isinstance(A.a, member)
if member is Typed:
assert A.a.validate_mode[1] == annotation
elif member is Instance:
assert A.a.validate_mode[1] == (annotation.__origin__,)
elif member is Subclass:
if isinstance(a_args := get_args(annotation)[0], TypeVar):
assert A.a.validate_mode[1] is object
else:
assert A.a.validate_mode[1] == a_args
elif member is Enum:
assert A.a.validate_mode[1] == get_args(annotation)
else:
assert A.a.default_value_mode == member().default_value_mode
if final:
assert A.a.setattr_mode[0] is SetAttr.ReadOnly
@pytest.mark.parametrize("final", [True, False])
@pytest.mark.parametrize(
"annotation, member, validate_mode",
[
(Atom, Typed, Atom),
(Union[int, str], Instance, (int, str)),
(int | str, Instance, (int, str)),
],
)
def test_union_in_annotation(final, annotation, member, validate_mode):
if final:
annotation = Final[annotation]
class A(Atom, use_annotations=True):
a: annotation
assert isinstance(A.a, member)
assert A.a.validate_mode[1] == validate_mode
if final:
assert A.a.setattr_mode[0] is SetAttr.ReadOnly
@pytest.mark.parametrize("final", [True, False])
@pytest.mark.parametrize(
"annotation, member, depth",
[
(TList[int], List(), 0),
(TList[int], List(Int()), 1),
(TList[Literal[1, 2, 3]], List(Enum(1, 2, 3)), 1),
(TList[TList[int]], List(List()), 1),
(TList[TList[int]], List(List(Int())), -1),
(TSet[int], Set(), 0),
(TSet[int], Set(Int()), 1),
(TDict[int, int], Dict(), 0),
(TDict[int, int], Dict(Int(), Int()), 1),
(TDefaultDict[int, int], DefaultDict(Int(), Int()), 1),
(TTuple[int], Tuple(), 0),
(TTuple[int], FixedTuple(Int()), 1),
(TTuple[int, ...], Tuple(Int()), 1),
(TTuple[int, object], FixedTuple(Int(), Value()), 1),
(TTuple[int, Any], FixedTuple(Int(), Value()), 1),
(TTuple[int, float], FixedTuple(Int(), Float()), 1),
(TTuple[tuple, int], FixedTuple(Tuple(), Int()), 1),
(
TTuple[TTuple[int, int], int],
FixedTuple(FixedTuple(Int(), Int()), Int()),
-1,
),
(list[int], List(), 0),
(list[int], List(Int()), 1),
(list[list[int]], List(List()), 1),
(list[list[int]], List(List(Int())), -1),
(set[int], Set(), 0),
(set[int], Set(Int()), 1),
(dict[int, int], Dict(), 0),
(dict[int, int], Dict(Int(), Int()), 1),
(defaultdict[int, int], DefaultDict(Int(), Int()), 1),
(tuple[int], Tuple(), 0),
(tuple[int], FixedTuple(Int()), 1),
(tuple[int, ...], Tuple(Int()), 1),
(tuple[int, float], FixedTuple(Int(), Float()), 1),
(tuple[tuple, int], FixedTuple(Tuple(), Int()), 1),
(
tuple[tuple[int, int], int],
FixedTuple(FixedTuple(Int(), Int()), Int()),
-1,
),
],
)
def test_annotated_containers_no_default(final, annotation, member, depth):
if final:
ann = Final[annotation]
else:
ann = annotation
class A(Atom, use_annotations=True, type_containers=depth):
a: ann
assert isinstance(A.a, type(member))
if depth == 0:
if isinstance(member, Dict):
assert A.a.validate_mode[1] == (None, None)
elif isinstance(member, FixedTuple):
assert A.a.items == ()
else:
assert A.a.item is None
else:
if isinstance(member, Dict):
for (k, v), (mk, mv) in zip(
A.a.validate_mode[1:], member.validate_mode[1:]
):
assert type(k) is type(mk)
assert type(v) is type(mv)
elif isinstance(member, DefaultDict):
for (k, v, f), (mk, mv, mf) in zip(
A.a.validate_mode[1:], member.validate_mode[1:]
):
assert type(k) is type(mk)
assert type(v) is type(mv)
assert f(A()) == mf(A())
elif isinstance(member, FixedTuple):
for v, mv in zip(A.a.validate_mode[1], member.validate_mode[1]):
assert type(v) is type(mv)
else:
assert type(A.a.item) is type(member.item)
if isinstance(member.item, List):
assert type(A.a.item.item) is type(member.item.item)
if final:
assert A.a.setattr_mode[0] is SetAttr.ReadOnly
@pytest.mark.parametrize("final", [True, False])
@pytest.mark.parametrize(
"annotation, member, default",
[
(bool, Bool, True),
(int, Int, 1),
(float, Float, 1.0),
(str, Str, "a"),
(bytes, Bytes, b"a"),
(Any, Value, 1),
(Union[Any, None], Value, None),
(object, Value, 2),
(TCallable, Callable, lambda x: x),
(TTuple[int], FixedTuple, (1,)),
(TList, List, [1]),
(TSet, Set, {1}),
(TDict, Dict, {1: 2}),
(TDefaultDict, DefaultDict, defaultdict(int, {1: 2})),
(Optional[Iterable], Instance, None),
(Type[int], Subclass, int),
(tuple[int], FixedTuple, (1,)),
(list, List, [1]),
(set, Set, {1}),
(dict, Dict, {1: 2}),
(defaultdict, DefaultDict, defaultdict(int, {1: 2})),
(Literal[1, 2, "a"], Enum, 2),
],
)
def test_annotations_with_default(final, annotation, member, default):
if final:
ann = Final[annotation]
else:
ann = annotation
class A(Atom, use_annotations=True):
a: ann = default
assert isinstance(A.a, member)
if member is Subclass:
assert A.a.default_value_mode == member(int, default=default).default_value_mode
elif member is Enum:
assert A.a.default_value_mode[1] == default
elif member is not Instance:
assert A.a.default_value_mode == member(default=default).default_value_mode
if final:
assert A.a.setattr_mode[0] is SetAttr.ReadOnly
def test_annotations_no_default_for_instance():
with pytest.raises(ValueError):
class A(Atom, use_annotations=True):
a: Iterable = []
with pytest.raises(ValueError):
class B(Atom, use_annotations=True):
a: Optional[Iterable] = []
def test_annotations_invalid_default_for_literal():
with pytest.raises(ValueError):
class A(Atom, use_annotations=True):
a: Literal["a", "b"] = "c"
|