-
-
Notifications
You must be signed in to change notification settings - Fork 275
/
reference.py
639 lines (551 loc) · 20.6 KB
/
reference.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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
from __future__ import annotations
import re
from collections import defaultdict
from contextlib import contextmanager
from enum import Enum, auto
from functools import lru_cache
from itertools import zip_longest
from keyword import iskeyword
from pathlib import Path, PurePath
from typing import (
TYPE_CHECKING,
Any,
Callable,
ClassVar,
DefaultDict,
Dict,
Generator,
List,
Mapping,
Optional,
Pattern,
Sequence,
Set,
Tuple,
Type,
TypeVar,
Union,
)
import inflect
import pydantic
from packaging import version
from pydantic import BaseModel, validator
from datamodel_code_generator import cached_property
if TYPE_CHECKING:
from pydantic.typing import AbstractSetIntStr, DictStrAny, MappingIntStrAny
class _BaseModel(BaseModel):
_exclude_fields: ClassVar[Set[str]] = set()
_pass_fields: ClassVar[Set[str]] = set()
if not TYPE_CHECKING:
def __init__(self, **values: Any) -> None:
super().__init__(**values)
for pass_field_name in self._pass_fields:
if pass_field_name in values:
setattr(self, pass_field_name, values[pass_field_name])
def dict(
self,
*,
include: Union[AbstractSetIntStr, MappingIntStrAny] = None,
exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None,
by_alias: bool = False,
skip_defaults: bool = None,
exclude_unset: bool = False,
exclude_defaults: bool = False,
exclude_none: bool = False,
) -> DictStrAny:
return super().dict(
include=include,
exclude=set(exclude or ()) | self._exclude_fields,
by_alias=by_alias,
skip_defaults=skip_defaults,
exclude_unset=exclude_unset,
exclude_defaults=exclude_defaults,
exclude_none=exclude_none,
)
class Reference(_BaseModel):
path: str
original_name: str = ''
name: str
loaded: bool = True
source: Optional[Any] = None
children: List[Any] = []
_exclude_fields: ClassVar[Set[str]] = {'children'}
@validator('original_name')
def validate_original_name(cls, v: Any, values: Dict[str, Any]) -> str:
"""
If original_name is empty then, `original_name` is assigned `name`
"""
if v: # pragma: no cover
return v
return values.get('name', v) # pragma: no cover
class Config:
arbitrary_types_allowed = True
keep_untouched = (cached_property,)
copy_on_model_validation = (
False
if version.parse(pydantic.VERSION) < version.parse('1.9.2')
else 'none'
)
@property
def short_name(self) -> str:
return self.name.rsplit('.', 1)[-1]
SINGULAR_NAME_SUFFIX: str = 'Item'
ID_PATTERN: Pattern[str] = re.compile(r'^#[^/].*')
T = TypeVar('T')
@contextmanager
def context_variable(
setter: Callable[[T], None], current_value: T, new_value: T
) -> Generator[None, None, None]:
previous_value: T = current_value
setter(new_value)
try:
yield
finally:
setter(previous_value)
_UNDER_SCORE_1: Pattern[str] = re.compile(r'(.)([A-Z][a-z]+)')
_UNDER_SCORE_2: Pattern[str] = re.compile('([a-z0-9])([A-Z])')
@lru_cache()
def camel_to_snake(string: str) -> str:
subbed = _UNDER_SCORE_1.sub(r'\1_\2', string)
return _UNDER_SCORE_2.sub(r'\1_\2', subbed).lower()
class FieldNameResolver:
def __init__(
self,
aliases: Optional[Mapping[str, str]] = None,
snake_case_field: bool = False,
empty_field_name: Optional[str] = None,
original_delimiter: Optional[str] = None,
):
self.aliases: Mapping[str, str] = {} if aliases is None else {**aliases}
self.empty_field_name: str = empty_field_name or '_'
self.snake_case_field = snake_case_field
self.original_delimiter: Optional[str] = original_delimiter
@classmethod
def _validate_field_name(cls, field_name: str) -> bool:
return True
def get_valid_name(
self,
name: str,
excludes: Optional[Set[str]] = None,
ignore_snake_case_field: bool = False,
upper_camel: bool = False,
) -> str:
if not name:
name = self.empty_field_name
if name[0] == '#':
name = name[1:] or self.empty_field_name
if (
self.snake_case_field
and not ignore_snake_case_field
and self.original_delimiter is not None
):
name = snake_to_upper_camel(name, delimiter=self.original_delimiter)
# TODO: when first character is a number
name = re.sub(r'[¹²³⁴⁵⁶⁷⁸⁹]|\W', '_', name)
if name[0].isnumeric():
name = f'field_{name}'
if self.snake_case_field and not ignore_snake_case_field:
name = camel_to_snake(name)
count = 1
if iskeyword(name) or not self._validate_field_name(name):
name += '_'
new_name = snake_to_upper_camel(name) if upper_camel else name
while (
not (new_name.isidentifier() or not self._validate_field_name(new_name))
or iskeyword(new_name)
or (excludes and new_name in excludes)
):
new_name = f'{name}{count}' if upper_camel else f'{name}_{count}'
count += 1
return new_name
def get_valid_field_name_and_alias(
self, field_name: str, excludes: Optional[Set[str]] = None
) -> Tuple[str, Optional[str]]:
if field_name in self.aliases:
return self.aliases[field_name], field_name
valid_name = self.get_valid_name(field_name, excludes=excludes)
return valid_name, None if field_name == valid_name else field_name
class PydanticFieldNameResolver(FieldNameResolver):
@classmethod
def _validate_field_name(cls, field_name: str) -> bool:
return not hasattr(BaseModel, field_name)
class EnumFieldNameResolver(FieldNameResolver):
def get_valid_name(
self,
name: str,
excludes: Optional[Set[str]] = None,
ignore_snake_case_field: bool = False,
upper_camel: bool = False,
) -> str:
return super().get_valid_name(
name='mro_' if name == 'mro' else name,
excludes=excludes,
ignore_snake_case_field=ignore_snake_case_field,
upper_camel=upper_camel,
)
class ModelType(Enum):
PYDANTIC = auto()
ENUM = auto()
CLASS = auto()
DEFAULT_FIELD_NAME_RESOLVERS: Dict[ModelType, Type[FieldNameResolver]] = {
ModelType.ENUM: EnumFieldNameResolver,
ModelType.PYDANTIC: PydanticFieldNameResolver,
ModelType.CLASS: FieldNameResolver,
}
def get_relative_path(base_path: PurePath, target_path: PurePath) -> PurePath:
if base_path == target_path:
return Path('.')
if not target_path.is_absolute():
return target_path
parent_count: int = 0
children: List[str] = []
for base_part, target_part in zip_longest(base_path.parts, target_path.parts):
if base_part == target_part and not parent_count:
continue
if base_part or not target_part:
parent_count += 1
if target_part:
children.append(target_part)
return Path(*['..' for _ in range(parent_count)], *children)
class ModelResolver:
def __init__(
self,
exclude_names: Set[str] = None,
duplicate_name_suffix: Optional[str] = None,
base_url: Optional[str] = None,
singular_name_suffix: Optional[str] = None,
aliases: Optional[Mapping[str, str]] = None,
snake_case_field: bool = False,
empty_field_name: Optional[str] = None,
custom_class_name_generator: Optional[Callable[[str], str]] = None,
base_path: Optional[Path] = None,
field_name_resolver_classes: Optional[
Dict[ModelType, Type[FieldNameResolver]]
] = None,
original_field_name_delimiter: Optional[str] = None,
) -> None:
self.references: Dict[str, Reference] = {}
self._current_root: Sequence[str] = []
self._root_id: Optional[str] = None
self._root_id_base_path: Optional[str] = None
self.ids: DefaultDict[str, Dict[str, str]] = defaultdict(dict)
self.after_load_files: Set[str] = set()
self.exclude_names: Set[str] = exclude_names or set()
self.duplicate_name_suffix: Optional[str] = duplicate_name_suffix
self._base_url: Optional[str] = base_url
self.singular_name_suffix: str = (
singular_name_suffix
if isinstance(singular_name_suffix, str)
else SINGULAR_NAME_SUFFIX
)
merged_field_name_resolver_classes = DEFAULT_FIELD_NAME_RESOLVERS.copy()
if field_name_resolver_classes: # pragma: no cover
merged_field_name_resolver_classes.update(field_name_resolver_classes)
self.field_name_resolvers: Dict[ModelType, FieldNameResolver] = {
k: v(
aliases=aliases,
snake_case_field=snake_case_field,
empty_field_name=empty_field_name,
original_delimiter=original_field_name_delimiter,
)
for k, v in merged_field_name_resolver_classes.items()
}
self.class_name_generator = (
custom_class_name_generator or self.default_class_name_generator
)
self._base_path: Path = base_path or Path.cwd()
self._current_base_path: Optional[Path] = self._base_path
@property
def current_base_path(self) -> Optional[Path]:
return self._current_base_path
def set_current_base_path(self, base_path: Optional[Path]) -> None:
self._current_base_path = base_path
@property
def base_url(self) -> Optional[str]:
return self._base_url
def set_base_url(self, base_url: Optional[str]) -> None:
self._base_url = base_url
@contextmanager
def current_base_path_context(
self, base_path: Optional[Path]
) -> Generator[None, None, None]:
if base_path:
base_path = (self._base_path / base_path).resolve()
with context_variable(
self.set_current_base_path, self.current_base_path, base_path
):
yield
@contextmanager
def base_url_context(self, base_url: str) -> Generator[None, None, None]:
if self._base_url:
with context_variable(self.set_base_url, self.base_url, base_url):
yield
else:
yield
@property
def current_root(self) -> Sequence[str]:
if len(self._current_root) > 1:
return self._current_root
return self._current_root
def set_current_root(self, current_root: Sequence[str]) -> None:
self._current_root = current_root
@contextmanager
def current_root_context(
self, current_root: Sequence[str]
) -> Generator[None, None, None]:
with context_variable(self.set_current_root, self.current_root, current_root):
yield
@property
def root_id(self) -> Optional[str]:
return self._root_id
@property
def root_id_base_path(self) -> Optional[str]:
return self._root_id_base_path
def set_root_id(self, root_id: Optional[str]) -> None:
if root_id and '/' in root_id:
self._root_id_base_path = root_id.rsplit('/', 1)[0]
else:
self._root_id_base_path = None
self._root_id = root_id
def add_id(self, id_: str, path: Sequence[str]) -> None:
self.ids['/'.join(self.current_root)][id_] = self.resolve_ref(path)
def resolve_ref(self, path: Union[Sequence[str], str]) -> str:
if isinstance(path, str):
joined_path = path
else:
joined_path = self.join_path(path)
if joined_path == '#':
return f"{'/'.join(self.current_root)}#"
if (
self.current_base_path
and not self.base_url
and joined_path[0] != '#'
and not is_url(joined_path)
):
# resolve local file path
file_path, *object_part = joined_path.split('#', 1)
resolved_file_path = Path(self.current_base_path, file_path).resolve()
joined_path = get_relative_path(
self._base_path, resolved_file_path
).as_posix()
if object_part:
joined_path += f'#{object_part[0]}'
if ID_PATTERN.match(joined_path):
ref: str = self.ids['/'.join(self.current_root)][joined_path]
elif (
'#' not in joined_path
and self.root_id_base_path
and self.current_root != path
):
if is_url(joined_path) or Path(self._base_path, joined_path).is_file():
ref = f'{joined_path}#'
else:
ref = f'{self.root_id_base_path}/{joined_path}#'
else:
if '#' not in joined_path:
joined_path += '#'
if joined_path[0] == '#':
joined_path = f'{"/".join(self.current_root)}{joined_path}'
delimiter = joined_path.index('#')
ref = f"{''.join(joined_path[:delimiter])}#{''.join(joined_path[delimiter + 1:])}"
if self.base_url:
from .http import join_url
return join_url(self.base_url, ref)
if is_url(ref):
file_part, path_part = ref.split('#', 1)
if file_part == self.root_id:
return f'{"/".join(self.current_root)}#{path_part}'
return ref
def is_after_load(self, ref: str) -> bool:
if is_url(ref) or not self.current_base_path:
return False
file_part, *_ = ref.split('#', 1)
absolute_path = Path(self._base_path, file_part).resolve().as_posix()
if self.is_external_root_ref(ref):
return absolute_path in self.after_load_files
elif self.is_external_ref(ref):
return absolute_path in self.after_load_files
return False # pragma: no cover
@staticmethod
def is_external_ref(ref: str) -> bool:
return '#' in ref and ref[0] != '#'
@staticmethod
def is_external_root_ref(ref: str) -> bool:
return ref[-1] == '#'
@staticmethod
def join_path(path: Sequence[str]) -> str:
joined_path = '/'.join(p for p in path if p).replace('/#', '#')
if '#' not in joined_path:
joined_path += '#'
return joined_path
def add_ref(self, ref: str, resolved: bool = False) -> Reference:
if not resolved:
path = self.resolve_ref(ref)
else:
path = ref
reference = self.references.get(path)
if reference:
return reference
split_ref = ref.rsplit('/', 1)
if len(split_ref) == 1:
original_name = Path(
split_ref[0][:-1] if self.is_external_root_ref(path) else split_ref[0]
).stem
else:
original_name = (
Path(split_ref[1][:-1]).stem
if self.is_external_root_ref(path)
else split_ref[1]
)
name = self.get_class_name(original_name, unique=False)
reference = Reference(
path=path,
original_name=original_name,
name=name,
loaded=False,
)
self.references[path] = reference
return reference
def add(
self,
path: Sequence[str],
original_name: str,
*,
class_name: bool = False,
singular_name: bool = False,
unique: bool = True,
singular_name_suffix: Optional[str] = None,
loaded: bool = False,
) -> Reference:
joined_path = self.join_path(path)
reference: Optional[Reference] = self.references.get(joined_path)
if reference:
if loaded and not reference.loaded:
reference.loaded = True
if (
not original_name
or original_name == reference.original_name
or original_name == reference.name
):
return reference
name = original_name
if class_name:
name = self.get_class_name(
name=name,
unique=unique,
reserved_name=reference.name if reference else None,
singular_name=singular_name,
singular_name_suffix=singular_name_suffix,
)
else:
# TODO: create a validate for module name
name = self.get_valid_field_name(name, model_type=ModelType.CLASS)
if singular_name: # pragma: no cover
name = get_singular_name(
name, singular_name_suffix or self.singular_name_suffix
)
elif unique: # pragma: no cover
name = self._get_uniq_name(name)
if reference:
reference.original_name = original_name
reference.name = name
reference.loaded = loaded
else:
reference = Reference(
path=joined_path, original_name=original_name, name=name, loaded=loaded
)
self.references[joined_path] = reference
return reference
def get(self, path: Union[Sequence[str], str]) -> Optional[Reference]:
return self.references.get(self.resolve_ref(path))
def default_class_name_generator(self, name: str) -> str:
# TODO: create a validate for class name
return self.field_name_resolvers[ModelType.CLASS].get_valid_name(
name, ignore_snake_case_field=True, upper_camel=True
)
def get_class_name(
self,
name: str,
unique: bool = True,
reserved_name: Optional[str] = None,
singular_name: bool = False,
singular_name_suffix: Optional[str] = None,
) -> str:
if '.' in name:
split_name = name.split('.')
prefix = '.'.join(
# TODO: create a validate for class name
self.field_name_resolvers[ModelType.CLASS].get_valid_name(
n, ignore_snake_case_field=True
)
for n in split_name[:-1]
)
prefix += '.'
class_name = split_name[-1]
else:
prefix = ''
class_name = name
class_name = self.class_name_generator(class_name)
if singular_name:
class_name = get_singular_name(
class_name, singular_name_suffix or self.singular_name_suffix
)
if unique:
if reserved_name == class_name:
return class_name
class_name = self._get_uniq_name(class_name, camel=True)
return f'{prefix}{class_name}'
def _get_uniq_name(self, name: str, camel: bool = False) -> str:
uniq_name: str = name
count: int = 1
reference_names = {
r.name for r in self.references.values()
} | self.exclude_names
while uniq_name in reference_names:
if self.duplicate_name_suffix:
name_parts: List[Union[str, int]] = [
name,
self.duplicate_name_suffix,
count - 1,
]
else:
name_parts = [name, count]
delimiter = '' if camel else '_'
uniq_name = delimiter.join(str(p) for p in name_parts if p)
count += 1
return uniq_name
@classmethod
def validate_name(cls, name: str) -> bool:
return name.isidentifier() and not iskeyword(name)
def get_valid_field_name(
self,
name: str,
excludes: Optional[Set[str]] = None,
model_type: ModelType = ModelType.PYDANTIC,
) -> str:
return self.field_name_resolvers[model_type].get_valid_name(name, excludes)
def get_valid_field_name_and_alias(
self,
field_name: str,
excludes: Optional[Set[str]] = None,
model_type: ModelType = ModelType.PYDANTIC,
) -> Tuple[str, Optional[str]]:
return self.field_name_resolvers[model_type].get_valid_field_name_and_alias(
field_name, excludes
)
@lru_cache()
def get_singular_name(name: str, suffix: str = SINGULAR_NAME_SUFFIX) -> str:
singular_name = inflect_engine.singular_noun(name)
if singular_name is False:
singular_name = f'{name}{suffix}'
return singular_name
@lru_cache()
def snake_to_upper_camel(word: str, delimiter: str = '_') -> str:
prefix = ''
if word.startswith(delimiter):
prefix = '_'
word = word[1:]
return prefix + ''.join(x[0].upper() + x[1:] for x in word.split(delimiter) if x)
def is_url(ref: str) -> bool:
return ref.startswith(('https://', 'http://'))
inflect_engine = inflect.engine()