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
|
from abc import ABC, abstractmethod
from collections import defaultdict
from copy import deepcopy
from functools import lru_cache
from pathlib import Path
from typing import (
TYPE_CHECKING,
Any,
ClassVar,
DefaultDict,
Dict,
FrozenSet,
Iterator,
List,
Optional,
Set,
Tuple,
TypeVar,
Union,
)
from warnings import warn
from jinja2 import Environment, FileSystemLoader, Template
from pydantic import Field
from datamodel_code_generator.imports import (
IMPORT_ANNOTATED,
IMPORT_ANNOTATED_BACKPORT,
IMPORT_OPTIONAL,
IMPORT_UNION,
Import,
)
from datamodel_code_generator.reference import Reference, _BaseModel
from datamodel_code_generator.types import (
ANY,
NONE,
UNION_PREFIX,
DataType,
Nullable,
chain_as_tuple,
get_optional_type,
)
from datamodel_code_generator.util import PYDANTIC_V2, ConfigDict, cached_property
TEMPLATE_DIR: Path = Path(__file__).parents[0] / 'template'
ALL_MODEL: str = '#all#'
ConstraintsBaseT = TypeVar('ConstraintsBaseT', bound='ConstraintsBase')
class ConstraintsBase(_BaseModel):
unique_items: Optional[bool] = Field(None, alias='uniqueItems')
_exclude_fields: ClassVar[Set[str]] = {'has_constraints'}
if PYDANTIC_V2:
model_config = ConfigDict(
arbitrary_types_allowed=True, ignored_types=(cached_property,)
)
else:
class Config:
arbitrary_types_allowed = True
keep_untouched = (cached_property,)
@cached_property
def has_constraints(self) -> bool:
return any(v is not None for v in self.dict().values())
@staticmethod
def merge_constraints(
a: ConstraintsBaseT, b: ConstraintsBaseT
) -> Optional[ConstraintsBaseT]:
constraints_class = None
if isinstance(a, ConstraintsBase): # pragma: no cover
root_type_field_constraints = {
k: v for k, v in a.dict(by_alias=True).items() if v is not None
}
constraints_class = a.__class__
else:
root_type_field_constraints = {} # pragma: no cover
if isinstance(b, ConstraintsBase): # pragma: no cover
model_field_constraints = {
k: v for k, v in b.dict(by_alias=True).items() if v is not None
}
constraints_class = constraints_class or b.__class__
else:
model_field_constraints = {}
if not issubclass(constraints_class, ConstraintsBase): # pragma: no cover
return None
return constraints_class.parse_obj(
{
**root_type_field_constraints,
**model_field_constraints,
}
)
class DataModelFieldBase(_BaseModel):
name: Optional[str] = None
default: Optional[Any] = None
required: bool = False
alias: Optional[str] = None
data_type: DataType
constraints: Any = None
strip_default_none: bool = False
nullable: Optional[bool] = None
parent: Optional[Any] = None
extras: Dict[str, Any] = {}
use_annotated: bool = False
has_default: bool = False
use_field_description: bool = False
const: bool = False
original_name: Optional[str] = None
use_default_kwarg: bool = False
use_one_literal_as_default: bool = False
_exclude_fields: ClassVar[Set[str]] = {'parent'}
_pass_fields: ClassVar[Set[str]] = {'parent', 'data_type'}
can_have_extra_keys: ClassVar[bool] = True
type_has_null: Optional[bool] = None
if not TYPE_CHECKING:
def __init__(self, **data: Any) -> None:
super().__init__(**data)
if self.data_type.reference or self.data_type.data_types:
self.data_type.parent = self
self.process_const()
def process_const(self) -> None:
if 'const' not in self.extras:
return None
self.default = self.extras['const']
self.const = True
self.required = False
self.nullable = False
@property
def type_hint(self) -> str:
type_hint = self.data_type.type_hint
if not type_hint:
return NONE
elif self.has_default_factory:
return type_hint
elif self.data_type.is_optional and self.data_type.type != ANY:
return type_hint
elif self.nullable is not None:
if self.nullable:
return get_optional_type(type_hint, self.data_type.use_union_operator)
return type_hint
elif self.required:
if self.type_has_null:
return get_optional_type(type_hint, self.data_type.use_union_operator)
return type_hint
elif self.fall_back_to_nullable:
return get_optional_type(type_hint, self.data_type.use_union_operator)
else:
return type_hint
@property
def imports(self) -> Tuple[Import, ...]:
type_hint = self.type_hint
has_union = not self.data_type.use_union_operator and UNION_PREFIX in type_hint
imports: List[Union[Tuple[Import], Iterator[Import]]] = [
(
i
for i in self.data_type.all_imports
if not (not has_union and i == IMPORT_UNION)
)
]
if self.fall_back_to_nullable:
if (
self.nullable or (self.nullable is None and not self.required)
) and not self.data_type.use_union_operator:
imports.append((IMPORT_OPTIONAL,))
else:
if (
self.nullable and not self.data_type.use_union_operator
): # pragma: no cover
imports.append((IMPORT_OPTIONAL,))
if self.use_annotated and self.annotated:
import_annotated = (
IMPORT_ANNOTATED
if self.data_type.python_version.has_annotated_type
else IMPORT_ANNOTATED_BACKPORT
)
imports.append((import_annotated,))
return chain_as_tuple(*imports)
@property
def docstring(self) -> Optional[str]:
if self.use_field_description:
description = self.extras.get('description', None)
if description is not None:
return f'{description}'
return None
@property
def unresolved_types(self) -> FrozenSet[str]:
return self.data_type.unresolved_types
@property
def field(self) -> Optional[str]:
"""for backwards compatibility"""
return None
@property
def method(self) -> Optional[str]:
return None
@property
def represented_default(self) -> str:
return repr(self.default)
@property
def annotated(self) -> Optional[str]:
return None
@property
def has_default_factory(self) -> bool:
return 'default_factory' in self.extras
@property
def fall_back_to_nullable(self) -> bool:
return True
@lru_cache()
def get_template(template_file_path: Path) -> Template:
loader = FileSystemLoader(str(TEMPLATE_DIR / template_file_path.parent))
environment: Environment = Environment(loader=loader)
return environment.get_template(template_file_path.name)
def get_module_path(name: str, file_path: Optional[Path]) -> List[str]:
if file_path:
return [
*file_path.parts[:-1],
file_path.stem,
*name.split('.')[:-1],
]
return name.split('.')[:-1]
def get_module_name(name: str, file_path: Optional[Path]) -> str:
return '.'.join(get_module_path(name, file_path))
class TemplateBase(ABC):
@property
@abstractmethod
def template_file_path(self) -> Path:
raise NotImplementedError
@cached_property
def template(self) -> Template:
return get_template(self.template_file_path)
@abstractmethod
def render(self) -> str:
raise NotImplementedError
def _render(self, *args: Any, **kwargs: Any) -> str:
return self.template.render(*args, **kwargs)
def __str__(self) -> str:
return self.render()
class BaseClassDataType(DataType): ...
UNDEFINED: Any = object()
class DataModel(TemplateBase, Nullable, ABC):
TEMPLATE_FILE_PATH: ClassVar[str] = ''
BASE_CLASS: ClassVar[str] = ''
DEFAULT_IMPORTS: ClassVar[Tuple[Import, ...]] = ()
def __init__(
self,
*,
reference: Reference,
fields: List[DataModelFieldBase],
decorators: Optional[List[str]] = None,
base_classes: Optional[List[Reference]] = None,
custom_base_class: Optional[str] = None,
custom_template_dir: Optional[Path] = None,
extra_template_data: Optional[DefaultDict[str, Dict[str, Any]]] = None,
methods: Optional[List[str]] = None,
path: Optional[Path] = None,
description: Optional[str] = None,
default: Any = UNDEFINED,
nullable: bool = False,
keyword_only: bool = False,
) -> None:
self.keyword_only = keyword_only
if not self.TEMPLATE_FILE_PATH:
raise Exception('TEMPLATE_FILE_PATH is undefined')
self._custom_template_dir: Optional[Path] = custom_template_dir
self.decorators: List[str] = decorators or []
self._additional_imports: List[Import] = []
self.custom_base_class = custom_base_class
if base_classes:
self.base_classes: List[BaseClassDataType] = [
BaseClassDataType(reference=b) for b in base_classes
]
else:
self.set_base_class()
self.file_path: Optional[Path] = path
self.reference: Reference = reference
self.reference.source = self
self.extra_template_data = (
# The supplied defaultdict will either create a new entry,
# or already contain a predefined entry for this type
extra_template_data[self.name]
if extra_template_data is not None
else defaultdict(dict)
)
self.fields = self._validate_fields(fields) if fields else []
for base_class in self.base_classes:
if base_class.reference:
base_class.reference.children.append(self)
if extra_template_data is not None:
all_model_extra_template_data = extra_template_data.get(ALL_MODEL)
if all_model_extra_template_data:
# The deepcopy is needed here to ensure that different models don't
# end up inadvertently sharing state (such as "base_class_kwargs")
self.extra_template_data.update(deepcopy(all_model_extra_template_data))
self.methods: List[str] = methods or []
self.description = description
for field in self.fields:
field.parent = self
self._additional_imports.extend(self.DEFAULT_IMPORTS)
self.default: Any = default
self._nullable: bool = nullable
def _validate_fields(
self, fields: List[DataModelFieldBase]
) -> List[DataModelFieldBase]:
names: Set[str] = set()
unique_fields: List[DataModelFieldBase] = []
for field in fields:
if field.name:
if field.name in names:
warn(f'Field name `{field.name}` is duplicated on {self.name}')
continue
else:
names.add(field.name)
unique_fields.append(field)
return unique_fields
def set_base_class(self) -> None:
base_class = self.custom_base_class or self.BASE_CLASS
if not base_class:
self.base_classes = []
return None
base_class_import = Import.from_full_path(base_class)
self._additional_imports.append(base_class_import)
self.base_classes = [BaseClassDataType.from_import(base_class_import)]
@cached_property
def template_file_path(self) -> Path:
template_file_path = Path(self.TEMPLATE_FILE_PATH)
if self._custom_template_dir is not None:
custom_template_file_path = self._custom_template_dir / template_file_path
if custom_template_file_path.exists():
return custom_template_file_path
return template_file_path
@property
def imports(self) -> Tuple[Import, ...]:
return chain_as_tuple(
(i for f in self.fields for i in f.imports),
self._additional_imports,
)
@property
def reference_classes(self) -> FrozenSet[str]:
return frozenset(
{r.reference.path for r in self.base_classes if r.reference}
| {t for f in self.fields for t in f.unresolved_types}
)
@property
def name(self) -> str:
return self.reference.name
@property
def duplicate_name(self) -> str:
return self.reference.duplicate_name or ''
@property
def base_class(self) -> str:
return ', '.join(b.type_hint for b in self.base_classes)
@staticmethod
def _get_class_name(name: str) -> str:
if '.' in name:
return name.rsplit('.', 1)[-1]
return name
@property
def class_name(self) -> str:
return self._get_class_name(self.name)
@class_name.setter
def class_name(self, class_name: str) -> None:
if '.' in self.reference.name:
self.reference.name = (
f"{self.reference.name.rsplit('.', 1)[0]}.{class_name}"
)
else:
self.reference.name = class_name
@property
def duplicate_class_name(self) -> str:
return self._get_class_name(self.duplicate_name)
@property
def module_path(self) -> List[str]:
return get_module_path(self.name, self.file_path)
@property
def module_name(self) -> str:
return get_module_name(self.name, self.file_path)
@property
def all_data_types(self) -> Iterator[DataType]:
for field in self.fields:
yield from field.data_type.all_data_types
yield from self.base_classes
@property
def nullable(self) -> bool:
return self._nullable
@cached_property
def path(self) -> str:
return self.reference.path
def render(self, *, class_name: Optional[str] = None) -> str:
response = self._render(
class_name=class_name or self.class_name,
fields=self.fields,
decorators=self.decorators,
base_class=self.base_class,
methods=self.methods,
description=self.description,
keyword_only=self.keyword_only,
**self.extra_template_data,
)
return response
|