-
-
Notifications
You must be signed in to change notification settings - Fork 600
/
new_default_element.py
488 lines (385 loc) · 14.2 KB
/
new_default_element.py
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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
import re
import warnings
from dataclasses import dataclass, field
from textwrap import dedent
from typing import List, Optional, Pattern, Union
from omegaconf import AnyNode, DictConfig, OmegaConf
@dataclass
class ResultDefault:
config_path: Optional[str] = None
parent: Optional[str] = None
package: Optional[str] = None
is_self: bool = False
override_key: Optional[str] = field(default=None, compare=False)
def __repr__(self) -> str:
attrs = []
attr_names = "config_path", "package", "parent"
for attr in attr_names:
value = getattr(self, attr)
if value is not None:
attrs.append(f'{attr}="{value}"')
flags = []
flag_names = ["is_self"]
for flag in flag_names:
value = getattr(self, flag)
if value:
flags.append(f"{flag}=True")
ret = f"{','.join(attrs + flags)}"
return f"{type(self).__name__}({ret})"
@dataclass
class InputDefault:
package: Optional[str] = None
parent_base_dir: Optional[str] = field(default=None, compare=False, repr=False)
parent_package: Optional[str] = field(default=None, compare=False, repr=False)
package_header: Optional[str] = field(default=None, compare=False)
def is_self(self) -> bool:
raise NotImplementedError()
def update_parent(
self, parent_base_dir: Optional[str], parent_package: Optional[str]
) -> None:
assert self.parent_package is None or self.parent_package == parent_package
assert self.parent_base_dir is None or self.parent_base_dir == parent_base_dir
self.parent_base_dir = parent_base_dir
self.parent_package = parent_package
if self.package is not None:
if "_group_" in self.package:
pkg = self.package
resolved = pkg.replace("_group_", self.get_default_package())
self.package = f"_global_.{resolved}"
def is_optional(self) -> bool:
raise NotImplementedError()
def get_group_path(self) -> str:
raise NotImplementedError()
def get_config_path(self) -> str:
raise NotImplementedError()
def get_default_package(self) -> str:
return self.get_group_path().replace("/", ".")
def get_final_package(self, default_to_package_header: bool = True) -> str:
"""
:param default_to_package_header: if package is not present, fallback to package header
:return:
"""
raise NotImplementedError()
def _relative_group_path(self) -> str:
raise NotImplementedError()
def get_name(self) -> Optional[str]:
raise NotImplementedError()
def _get_attributes(self) -> List[str]:
raise NotImplementedError()
def _get_flags(self) -> List[str]:
raise NotImplementedError()
def _get_parent_package(self) -> Optional[str]:
ret = self.__dict__["parent_package"]
assert ret is None or isinstance(ret, str)
return ret
def is_virtual(self) -> bool:
return False
def is_deleted(self) -> bool:
if "deleted" in self.__dict__:
return bool(self.__dict__["deleted"])
else:
return False
def set_package_header(self, package_header: str) -> None:
assert self.__dict__["package_header"] is None
if package_header == "_group_" or self.get_default_package() == package_header:
return
# package header is always interpreted as absolute.
# if it does not have a _global_ prefix, add it.
if package_header != "_global_" and not package_header.startswith("_global_."):
if package_header == "":
package_header = "_global_"
else:
package_header = f"_global_.{package_header}"
package_header = package_header.replace("_group_", self.get_default_package())
self.__dict__["package_header"] = package_header
def get_package_header(self) -> Optional[str]:
ret = self.__dict__["package_header"]
assert ret is None or isinstance(ret, str)
return ret
def get_package(self, default_to_package_header: bool = True) -> Optional[str]:
if self.__dict__["package"] is None and default_to_package_header:
ret = self.__dict__["package_header"]
else:
ret = self.__dict__["package"]
assert ret is None or isinstance(ret, str)
return ret
def _get_final_package(
self,
parent_package: Optional[str],
package: Optional[str],
name: Optional[str],
) -> str:
assert parent_package is not None
if package is None:
package = self._relative_group_path().replace("/", ".")
if name is not None:
# name computation should be deferred to after the final config group choice is done
package = package.replace("_name_", name)
# package = package.replace(
# "_group_", self.get_group_path().replace("/", ".")
# )
if parent_package == "":
ret = package
else:
if package == "":
ret = parent_package
else:
ret = f"{parent_package}.{package}"
lgi = ret.rfind("_global_")
if lgi == -1:
return ret
else:
return ret[lgi + len("_global_") + 1 :]
def __repr__(self) -> str:
attrs = []
attr_names = self._get_attributes()
for attr in attr_names:
value = getattr(self, attr)
if value is not None:
if isinstance(value, str):
svalue = f'"{value}"'
else:
svalue = value
attrs.append(f"{attr}={svalue}")
flags = []
flag_names = self._get_flags()
for flag in flag_names:
value = getattr(self, flag)
if value:
flags.append(f"{flag}=True")
ret = f"{','.join(attrs)}"
if len(flags) > 0:
ret = f"{ret},{','.join(flags)}"
return f"{type(self).__name__}({ret})"
def is_interpolation(self) -> bool:
"""
True if config_name is an interpolation
"""
name = self.get_name()
if isinstance(name, str):
node = AnyNode(name)
return node._is_interpolation()
else:
return False
def is_missing(self) -> bool:
"""
True if the name of the config is '???'
:return:
"""
raise NotImplementedError()
def resolve_interpolation(self, known_choices: DictConfig) -> None:
raise NotImplementedError()
def get_override_key(self) -> str:
default_pkg = self.get_default_package()
final_pkg = self.get_final_package(default_to_package_header=False)
key = self.get_group_path()
if default_pkg != final_pkg:
key = f"{key}@{final_pkg}"
return key
def is_override(self) -> bool:
raise NotImplementedError()
@dataclass
class VirtualRoot(InputDefault):
def is_virtual(self) -> bool:
return True
def is_self(self) -> bool:
return False
def is_optional(self) -> bool:
raise NotImplementedError()
def get_group_path(self) -> str:
raise NotImplementedError()
def get_config_path(self) -> str:
return "<root>"
def get_final_package(self, default_to_package_header: bool = True) -> str:
raise NotImplementedError()
def _relative_group_path(self) -> str:
raise NotImplementedError()
def get_name(self) -> str:
raise NotImplementedError()
def is_missing(self) -> bool:
return False
def _get_attributes(self) -> List[str]:
raise NotImplementedError()
def _get_flags(self) -> List[str]:
raise NotImplementedError()
def __repr__(self) -> str:
return "VirtualRoot()"
def resolve_interpolation(self, known_choices: DictConfig) -> None:
raise NotImplementedError()
def is_override(self) -> bool:
return False
@dataclass(repr=False)
class ConfigDefault(InputDefault):
path: Optional[str] = None
def __post_init__(self) -> None:
if self.is_self() and self.package is not None:
raise ValueError("_self_@PACKAGE is not supported")
if self.package == "_here_":
self.package = ""
def is_self(self) -> bool:
return self.path == "_self_"
def is_optional(self) -> bool:
return False
def get_group_path(self) -> str:
assert self.parent_base_dir is not None
assert self.path is not None
if self.path.startswith("/"):
path = self.path[1:]
absolute = True
else:
path = self.path
absolute = False
idx = path.rfind("/")
if idx == -1:
group = ""
else:
group = path[0:idx]
if not absolute:
if self.parent_base_dir == "":
return group
else:
if group == "":
return f"{self.parent_base_dir}"
else:
return f"{self.parent_base_dir}/{group}"
else:
return group
def get_name(self) -> Optional[str]:
assert self.path is not None
idx = self.path.rfind("/")
if idx == -1:
return self.path
else:
return self.path[idx + 1 :]
def get_config_path(self) -> str:
assert self.parent_base_dir is not None
assert self.path is not None
if self.path.startswith("/"):
path = self.path[1:]
absolute = True
else:
path = self.path
absolute = False
if not absolute:
if self.parent_base_dir == "":
return path
else:
return f"{self.parent_base_dir}/{path}"
else:
return path
def get_final_package(self, default_to_package_header: bool = True) -> str:
return self._get_final_package(
self.parent_package,
self.get_package(default_to_package_header),
self.get_name(),
)
def _relative_group_path(self) -> str:
assert self.path is not None
if self.path.startswith("/"):
path = self.path[1:]
else:
path = self.path
idx = path.rfind("/")
if idx == -1:
return ""
else:
return path[0:idx]
def _get_attributes(self) -> List[str]:
return ["path", "package"]
def _get_flags(self) -> List[str]:
return []
def resolve_interpolation(self, known_choices: DictConfig) -> None:
raise NotImplementedError()
def is_missing(self) -> bool:
return self.get_name() == "???"
def is_override(self) -> bool:
return False
_legacy_interpolation_pattern: Pattern[str] = re.compile(r"\${defaults\.\d\.")
@dataclass(repr=False)
class GroupDefault(InputDefault):
# config group name if present
group: Optional[str] = None
# config file name
name: Optional[str] = None
optional: bool = False
override: bool = False
deleted: Optional[bool] = None
config_name_overridden: bool = field(default=False, compare=False, repr=False)
def __post_init__(self) -> None:
assert self.group is not None and self.group != ""
if self.package == "_here_":
self.package = ""
def is_self(self) -> bool:
return self.name == "_self_"
def is_optional(self) -> bool:
return self.optional
def is_override(self) -> bool:
return self.override
def get_group_path(self) -> str:
assert self.parent_base_dir is not None
assert self.group is not None
if self.group.startswith("/"):
group = self.group[1:]
absolute = True
else:
group = self.group
absolute = False
if self.parent_base_dir == "" or absolute:
return group
else:
return f"{self.parent_base_dir}/{group}"
def get_config_path(self) -> str:
group_path = self.get_group_path()
assert group_path != ""
return f"{group_path}/{self.get_name()}"
def get_name(self) -> Optional[str]:
return self.name
def get_final_package(self, default_to_package_header: bool = True) -> str:
return self._get_final_package(
self._get_parent_package(),
self.get_package(default_to_package_header=default_to_package_header),
self.get_name(),
)
def _relative_group_path(self) -> str:
assert self.group is not None
if self.group.startswith("/"):
return self.group[1:]
else:
return self.group
def _get_attributes(self) -> List[str]:
return ["group", "name", "package", "deleted"]
def _get_flags(self) -> List[str]:
return ["optional", "override"]
def resolve_interpolation(self, known_choices: DictConfig) -> None:
name = self.get_name()
if name is not None:
if re.match(_legacy_interpolation_pattern, name) is not None:
msg = dedent(
f"""
Defaults list element '{self.get_override_key()}={name}' is using a deprecated interpolation form.
See http://hydra.cc/docs/next/upgrades/1.0_to_1.1/defaults_list_interpolation for migration information."""
)
warnings.warn(
category=UserWarning,
message=msg,
)
node = OmegaConf.create({"_dummy_": self.get_name()})
node._set_parent(known_choices)
self.name = node["_dummy_"]
def is_missing(self) -> bool:
return self.get_name() == "???"
@dataclass
class DefaultsTreeNode:
node: InputDefault
children: Optional[List[Union["DefaultsTreeNode", InputDefault]]] = None
parent: Optional["DefaultsTreeNode"] = field(
default=None,
repr=False,
compare=False,
)
def parent_node(self) -> Optional[InputDefault]:
if self.parent is None:
return None
else:
return self.parent.node