-
-
Notifications
You must be signed in to change notification settings - Fork 437
Expand file tree
/
Copy pathutil.py
More file actions
289 lines (209 loc) · 9.83 KB
/
util.py
File metadata and controls
289 lines (209 loc) · 9.83 KB
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
"""Utility functions and Pydantic version compatibility helpers.
Provides Pydantic version detection (PYDANTIC_V2), YAML/TOML loading,
and version-compatible decorators (model_validator, field_validator).
"""
from __future__ import annotations
import re
import warnings
from functools import lru_cache
from typing import TYPE_CHECKING, Any, Literal, TypeVar, overload
if TYPE_CHECKING:
from collections.abc import Callable
from pathlib import Path
from pydantic import BaseModel as _BaseModel
try:
from tomllib import load as load_tomllib # type: ignore[ignoreMissingImports]
except ImportError:
from tomli import load as load_tomllib # type: ignore[ignoreMissingImports]
def load_toml(path: Path) -> dict[str, Any]:
"""Load and parse a TOML file."""
with path.open("rb") as f:
return load_tomllib(f)
@lru_cache(maxsize=1)
def get_pydantic_version() -> tuple[Any, bool, bool]:
"""Get pydantic version info lazily. Returns (version, is_v2, is_v2_11)."""
# Apply pydantic patch before importing pydantic
from datamodel_code_generator.pydantic_patch import apply_patch # noqa: PLC0415
apply_patch()
import pydantic # noqa: PLC0415
from packaging import version # noqa: PLC0415
pydantic_version = version.parse(pydantic.VERSION if isinstance(pydantic.VERSION, str) else str(pydantic.VERSION))
is_v2 = version.parse("2.0b3") <= pydantic_version
is_v2_11 = version.parse("2.11") <= pydantic_version
return pydantic_version, is_v2, is_v2_11
_is_v2: bool | None = None
def is_pydantic_v2() -> bool:
"""Check if pydantic v2 is installed."""
global _is_v2 # noqa: PLW0603
if _is_v2 is None: # pragma: no branch
_is_v2 = get_pydantic_version()[1]
return _is_v2
_YAML_1_2_BOOL_PATTERN = re.compile(r"^(?:true|false|True|False|TRUE|FALSE)$")
_YAML_DEPRECATED_BOOL_VALUES = {"True", "False", "TRUE", "FALSE"}
# Pattern for scientific notation without decimal point (e.g., 1e-5, 1E+10)
# Standard YAML only matches floats with decimal points, missing patterns like "1e-5"
_YAML_SCIENTIFIC_NOTATION_PATTERN = re.compile(r"^[-+]?[0-9][0-9_]*[eE][-+]?[0-9]+$")
def _construct_yaml_bool_with_warning(loader: Any, node: Any) -> bool:
value = loader.construct_scalar(node)
if value in _YAML_DEPRECATED_BOOL_VALUES: # pragma: no cover
warnings.warn(
f"YAML bool '{value}' is deprecated. Use lowercase 'true' or 'false' instead. "
f"In a future version, only lowercase booleans will be recognized.",
DeprecationWarning,
stacklevel=6,
)
return value in {"true", "True", "TRUE"}
@lru_cache(maxsize=1)
def get_safe_loader() -> type:
"""Get customized SafeLoader lazily."""
try:
from yaml import CSafeLoader as _SafeLoader # noqa: PLC0415
except ImportError: # pragma: no cover
from yaml import SafeLoader as _SafeLoader # noqa: PLC0415
class CustomSafeLoader(_SafeLoader): # type: ignore[valid-type,misc]
"""SafeLoader with YAML 1.2 bool handling and timestamp-as-string."""
yaml_constructors = _SafeLoader.yaml_constructors.copy()
yaml_implicit_resolvers = { # noqa: RUF012
k: v
for k, v in (
(k, [(tag, pat) for tag, pat in v if tag != "tag:yaml.org,2002:bool"])
for k, v in _SafeLoader.yaml_implicit_resolvers.items()
)
if v
}
CustomSafeLoader.yaml_constructors["tag:yaml.org,2002:timestamp"] = CustomSafeLoader.yaml_constructors[
"tag:yaml.org,2002:str"
]
for key in ["t", "f", "T", "F"]:
CustomSafeLoader.yaml_implicit_resolvers.setdefault(key, []).append((
"tag:yaml.org,2002:bool",
_YAML_1_2_BOOL_PATTERN,
))
CustomSafeLoader.yaml_constructors["tag:yaml.org,2002:bool"] = _construct_yaml_bool_with_warning
# Add scientific notation without decimal point (e.g., 1e-5) as float
for key in ["-", "+", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"]:
CustomSafeLoader.yaml_implicit_resolvers.setdefault(key, []).append((
"tag:yaml.org,2002:float",
_YAML_SCIENTIFIC_NOTATION_PATTERN,
))
return CustomSafeLoader
Model = TypeVar("Model", bound="_BaseModel") # pyright: ignore[reportInvalidTypeForm]
T = TypeVar("T")
@overload
def model_validator(
mode: Literal["before"],
) -> (
Callable[[Callable[[type[Model], T], T]], Callable[[type[Model], T], T]]
| Callable[[Callable[[Model, T], T]], Callable[[Model, T], T]]
): ...
@overload
def model_validator(
mode: Literal["after"],
) -> (
Callable[[Callable[[type[Model], T], T]], Callable[[type[Model], T], T]]
| Callable[[Callable[[Model, T], T]], Callable[[Model, T], T]]
| Callable[[Callable[[Model], Model]], Callable[[Model], Model]]
): ...
@overload
def model_validator() -> (
Callable[[Callable[[type[Model], T], T]], Callable[[type[Model], T], T]]
| Callable[[Callable[[Model, T], T]], Callable[[Model, T], T]]
| Callable[[Callable[[Model], Model]], Callable[[Model], Model]]
): ...
def model_validator( # pyright: ignore[reportInconsistentOverload]
mode: Literal["before", "after"] = "after",
) -> (
Callable[[Callable[[type[Model], T], T]], Callable[[type[Model], T], T]]
| Callable[[Callable[[Model, T], T]], Callable[[Model, T], T]]
| Callable[[Callable[[Model], Model]], Callable[[Model], Model]]
):
"""Decorate model validators for both Pydantic v1 and v2."""
@overload
def inner(method: Callable[[type[Model], T], T]) -> Callable[[type[Model], T], T]: ...
@overload
def inner(method: Callable[[Model, T], T]) -> Callable[[Model, T], T]: ...
@overload
def inner(method: Callable[[Model], Model]) -> Callable[[Model], Model]: ...
def inner(
method: Callable[[type[Model], T], T] | Callable[[Model, T], T] | Callable[[Model], Model],
) -> Callable[[type[Model], T], T] | Callable[[Model, T], T] | Callable[[Model], Model]:
if is_pydantic_v2():
from pydantic import model_validator as model_validator_v2 # noqa: PLC0415
if mode == "before":
return model_validator_v2(mode=mode)(classmethod(method)) # type: ignore[reportReturnType]
return model_validator_v2(mode=mode)(method) # type: ignore[reportReturnType]
from pydantic import root_validator # noqa: PLC0415
return root_validator(method, pre=mode == "before") # pyright: ignore[reportCallIssue]
return inner
def field_validator(
field_name: str,
*fields: str,
mode: Literal["before", "after"] = "after",
) -> Callable[[Any], Callable[[Any, Any], Any]]:
"""Decorate field validators for both Pydantic v1 and v2."""
def inner(method: Callable[[Model, Any], Any]) -> Callable[[Model, Any], Any]:
if is_pydantic_v2():
from pydantic import field_validator as field_validator_v2 # noqa: PLC0415
return field_validator_v2(field_name, *fields, mode=mode)(method)
from pydantic import validator # noqa: PLC0415
return validator(field_name, *fields, pre=mode == "before")(method) # pyright: ignore[reportReturnType]
return inner
@lru_cache(maxsize=1)
def _get_config_dict() -> type:
"""Get ConfigDict type lazily. Only used with pydantic v2."""
from pydantic import ConfigDict # noqa: PLC0415
return ConfigDict
class _ConfigDictProxy:
"""Proxy for lazy ConfigDict access."""
def __call__(self, **kwargs: Any) -> Any:
return _get_config_dict()(**kwargs)
ConfigDict: type = _ConfigDictProxy() # type: ignore[assignment]
@lru_cache(maxsize=1)
def _get_base_model_class() -> type:
"""Get version-compatible BaseModel class lazily."""
from pydantic import BaseModel as _PydanticBaseModel # noqa: PLC0415
if is_pydantic_v2():
from pydantic import ConfigDict as _ConfigDict # noqa: PLC0415
class _BaseModelV2(_PydanticBaseModel):
model_config = _ConfigDict(strict=False)
return _BaseModelV2
return _PydanticBaseModel
_BaseModel: type | None = None
def __getattr__(name: str) -> Any:
"""Provide lazy access to BaseModel and SafeLoader."""
global _BaseModel # noqa: PLW0603
if name == "BaseModel":
if _BaseModel is None:
_BaseModel = _get_base_model_class()
return _BaseModel
if name == "SafeLoader":
return get_safe_loader()
msg = f"module {__name__!r} has no attribute {name!r}"
raise AttributeError(msg)
_UNDER_SCORE_1: re.Pattern[str] = re.compile(r"([^_])([A-Z][a-z]+)")
_UNDER_SCORE_2: re.Pattern[str] = re.compile(r"([a-z0-9])([A-Z])")
@lru_cache
def camel_to_snake(string: str) -> str:
"""Convert camelCase or PascalCase to snake_case."""
subbed = _UNDER_SCORE_1.sub(r"\1_\2", string)
return _UNDER_SCORE_2.sub(r"\1_\2", subbed).lower()
def model_dump(obj: _BaseModel, **kwargs: Any) -> dict[str, Any]: # pyright: ignore[reportInvalidTypeForm]
"""Version-compatible model serialization (dict/model_dump)."""
if is_pydantic_v2():
return obj.model_dump(**kwargs)
return obj.dict(**kwargs) # type: ignore[reportDeprecated]
def model_validate(cls: type[Model], obj: Any) -> Model:
"""Version-compatible model validation (parse_obj/model_validate)."""
if is_pydantic_v2():
return cls.model_validate(obj)
return cls.parse_obj(obj) # type: ignore[reportDeprecated]
def get_fields_set(obj: _BaseModel) -> set[str]: # pyright: ignore[reportInvalidTypeForm]
"""Version-compatible access to fields set (__fields_set__/model_fields_set)."""
if is_pydantic_v2():
return obj.model_fields_set
return obj.__fields_set__ # type: ignore[reportDeprecated]
def model_copy(obj: Model, **kwargs: Any) -> Model:
"""Version-compatible model copy (copy/model_copy)."""
if is_pydantic_v2():
return obj.model_copy(**kwargs)
return obj.copy(**kwargs) # type: ignore[reportDeprecated]