File size: 11,620 Bytes
e40d9d0 |
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 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
from typing import Any
import pytest
from pytest import raises
from omegaconf import (
MISSING,
BooleanNode,
DictConfig,
EnumNode,
FloatNode,
IntegerNode,
ListConfig,
MissingMandatoryValue,
OmegaConf,
StringNode,
)
from omegaconf.errors import UnsupportedInterpolationType
from . import Color, ConcretePlugin, IllegalType, StructuredWithMissing, does_not_raise
@pytest.mark.parametrize( # type: ignore
"cfg, key, expected_is_missing, expectation",
[
({}, "foo", False, does_not_raise()),
({"foo": True}, "foo", False, does_not_raise()),
({"foo": MISSING}, "foo", True, raises(MissingMandatoryValue)),
(
{"foo": "${bar}", "bar": MISSING},
"foo",
True,
raises(MissingMandatoryValue),
),
(
{"foo": "${unknown_resolver:foo}"},
"foo",
False,
raises(UnsupportedInterpolationType),
),
({"foo": StringNode(value="???")}, "foo", True, raises(MissingMandatoryValue)),
(
{"foo": StringNode(value="???"), "inter": "${foo}"},
"inter",
True,
raises(MissingMandatoryValue),
),
(StructuredWithMissing, "num", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "opt_num", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "dict", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "opt_dict", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "list", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "opt_list", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "user", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "opt_user", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "inter_user", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "inter_opt_user", True, raises(MissingMandatoryValue)),
(StructuredWithMissing, "inter_num", True, raises(MissingMandatoryValue)),
],
)
def test_is_missing(
cfg: Any, key: str, expected_is_missing: bool, expectation: Any
) -> None:
cfg = OmegaConf.create(cfg)
with expectation:
cfg.get(key)
assert OmegaConf.is_missing(cfg, key) == expected_is_missing
OmegaConf.set_struct(cfg, True)
assert OmegaConf.is_missing(cfg, key) == expected_is_missing
OmegaConf.set_readonly(cfg, True)
assert OmegaConf.is_missing(cfg, key) == expected_is_missing
def test_is_missing_resets() -> None:
cfg = OmegaConf.structured(StructuredWithMissing)
assert OmegaConf.is_missing(cfg, "dict")
cfg.dict = {}
assert not OmegaConf.is_missing(cfg, "dict")
assert OmegaConf.is_missing(cfg, "list")
cfg.list = [1, 2, 3]
assert not OmegaConf.is_missing(cfg, "list")
cfg.list = "???"
assert OmegaConf.is_missing(cfg, "list")
@pytest.mark.parametrize( # type: ignore
"cfg, expected",
[
(None, False),
({}, False),
([], False),
("aa", False),
(10, False),
(True, False),
(bool, False),
(StringNode("foo"), False),
(ConcretePlugin, False),
(ConcretePlugin(), False),
(OmegaConf.create({}), True),
(OmegaConf.create([]), True),
(OmegaConf.structured(ConcretePlugin), True),
(OmegaConf.structured(ConcretePlugin()), True),
],
)
def test_is_config(cfg: Any, expected: bool) -> None:
assert OmegaConf.is_config(cfg) == expected
@pytest.mark.parametrize( # type: ignore
"cfg, expected",
[
(None, False),
({}, False),
([], False),
("aa", False),
(10, False),
(True, False),
(bool, False),
(StringNode("foo"), False),
(ConcretePlugin, False),
(ConcretePlugin(), False),
(OmegaConf.create({}), False),
(OmegaConf.create([]), True),
(OmegaConf.structured(ConcretePlugin), False),
(OmegaConf.structured(ConcretePlugin()), False),
],
)
def test_is_list(cfg: Any, expected: bool) -> None:
assert OmegaConf.is_list(cfg) == expected
@pytest.mark.parametrize( # type: ignore
"cfg, expected",
[
(None, False),
({}, False),
([], False),
("aa", False),
(10, False),
(True, False),
(bool, False),
(StringNode("foo"), False),
(ConcretePlugin, False),
(ConcretePlugin(), False),
(OmegaConf.create({}), True),
(OmegaConf.create([]), False),
(OmegaConf.structured(ConcretePlugin), True),
(OmegaConf.structured(ConcretePlugin()), True),
],
)
def test_is_dict(cfg: Any, expected: bool) -> None:
assert OmegaConf.is_dict(cfg) == expected
@pytest.mark.parametrize("is_optional", [True, False]) # type: ignore
@pytest.mark.parametrize( # type: ignore
"fac",
[
(
lambda is_optional, missing: StringNode(
value="foo" if not missing else "???", is_optional=is_optional
)
),
(
lambda is_optional, missing: IntegerNode(
value=10 if not missing else "???", is_optional=is_optional
)
),
(
lambda is_optional, missing: FloatNode(
value=10 if not missing else "???", is_optional=is_optional
)
),
(
lambda is_optional, missing: BooleanNode(
value=True if not missing else "???", is_optional=is_optional
)
),
(
lambda is_optional, missing: EnumNode(
enum_type=Color,
value=Color.RED if not missing else "???",
is_optional=is_optional,
)
),
(
lambda is_optional, missing: ListConfig(
content=[1, 2, 3] if not missing else "???", is_optional=is_optional
)
),
(
lambda is_optional, missing: DictConfig(
content={"foo": "bar"} if not missing else "???",
is_optional=is_optional,
)
),
(
lambda is_optional, missing: DictConfig(
ref_type=ConcretePlugin,
content=ConcretePlugin() if not missing else "???",
is_optional=is_optional,
)
),
],
)
def test_is_optional(fac: Any, is_optional: bool) -> None:
obj = fac(is_optional, False)
assert OmegaConf.is_optional(obj) == is_optional
cfg = OmegaConf.create({"node": obj})
assert OmegaConf.is_optional(cfg, "node") == is_optional
obj = fac(is_optional, True)
assert OmegaConf.is_optional(obj) == is_optional
cfg = OmegaConf.create({"node": obj})
assert OmegaConf.is_optional(cfg, "node") == is_optional
@pytest.mark.parametrize("is_none", [True, False]) # type: ignore
@pytest.mark.parametrize( # type: ignore
"fac",
[
(lambda none: StringNode(value="foo" if not none else None, is_optional=True)),
(lambda none: IntegerNode(value=10 if not none else None, is_optional=True)),
(lambda none: FloatNode(value=10 if not none else None, is_optional=True)),
(lambda none: BooleanNode(value=True if not none else None, is_optional=True)),
(
lambda none: EnumNode(
enum_type=Color,
value=Color.RED if not none else None,
is_optional=True,
)
),
(
lambda none: ListConfig(
content=[1, 2, 3] if not none else None, is_optional=True
)
),
(
lambda none: DictConfig(
content={"foo": "bar"} if not none else None, is_optional=True
)
),
(
lambda none: DictConfig(
ref_type=ConcretePlugin,
content=ConcretePlugin() if not none else None,
is_optional=True,
)
),
],
)
def test_is_none(fac: Any, is_none: bool) -> None:
obj = fac(is_none)
assert OmegaConf.is_none(obj) == is_none
cfg = OmegaConf.create({"node": obj})
assert OmegaConf.is_none(cfg, "node") == is_none
@pytest.mark.parametrize(
"fac", # type: ignore
[
(
lambda inter: StringNode(
value="foo" if inter is None else inter, is_optional=True
)
),
(
lambda inter: IntegerNode(
value=10 if inter is None else inter, is_optional=True
)
),
(
lambda inter: FloatNode(
value=10 if inter is None else inter, is_optional=True
)
),
(
lambda inter: BooleanNode(
value=True if inter is None else inter, is_optional=True
)
),
(
lambda inter: EnumNode(
enum_type=Color,
value=Color.RED if inter is None else inter,
is_optional=True,
)
),
(
lambda inter: ListConfig(
content=[1, 2, 3] if inter is None else inter, is_optional=True
)
),
(
lambda inter: DictConfig(
content={"foo": "bar"} if inter is None else inter, is_optional=True
)
),
(
lambda inter: DictConfig(
ref_type=ConcretePlugin,
content=ConcretePlugin() if inter is None else inter,
is_optional=True,
)
),
],
ids=[
"StringNode",
"IntegerNode",
"FloatNode",
"BooleanNode",
"EnumNode",
"ListConfig",
"DictConfig",
"ConcretePlugin",
],
)
def test_is_interpolation(fac):
obj = fac(inter=None)
assert not OmegaConf.is_interpolation(obj)
cfg = OmegaConf.create({"node": obj})
assert not OmegaConf.is_interpolation(cfg, "node")
assert not OmegaConf.is_interpolation(cfg, "missing")
for inter in ["${foo}", "http://${url}", "${resolver:value}"]:
obj = fac(inter=inter)
assert OmegaConf.is_interpolation(obj)
cfg = OmegaConf.create({"node": obj})
assert OmegaConf.is_interpolation(cfg, "node")
@pytest.mark.parametrize( # type: ignore
"cfg, type_",
[
({"foo": 10}, int),
({"foo": 10.0}, float),
({"foo": True}, bool),
({"foo": "bar"}, str),
({"foo": None}, type(None)),
({"foo": ConcretePlugin()}, ConcretePlugin),
({"foo": ConcretePlugin}, ConcretePlugin),
({"foo": {}}, dict),
({"foo": OmegaConf.create()}, dict),
({"foo": []}, list),
({"foo": OmegaConf.create([])}, list),
],
)
def test_get_type(cfg: Any, type_: Any) -> None:
cfg = OmegaConf.create(cfg)
assert OmegaConf.get_type(cfg, "foo") == type_
@pytest.mark.parametrize( # type: ignore
"obj, type_",
[
(10, int),
(10.0, float),
(True, bool),
("foo", str),
(DictConfig(content={}), dict),
(ListConfig(content=[]), list),
(IllegalType, IllegalType),
(IllegalType(), IllegalType),
],
)
def test_get_type_on_raw(obj: Any, type_: Any) -> None:
assert OmegaConf.get_type(obj) == type_
def test_is_issubclass() -> None:
cfg = OmegaConf.structured(ConcretePlugin)
t = OmegaConf.get_type(cfg)
assert t is not None and issubclass(t, ConcretePlugin)
|