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
|
from functools import wraps
from pathlib import Path
from typing import (
Any,
ClassVar,
DefaultDict,
Dict,
List,
Optional,
Sequence,
Set,
Tuple,
Type,
TypeVar,
)
from pydantic import Field
from datamodel_code_generator import DatetimeClassType, PythonVersion
from datamodel_code_generator.imports import (
IMPORT_DATE,
IMPORT_DATETIME,
IMPORT_TIME,
IMPORT_TIMEDELTA,
Import,
)
from datamodel_code_generator.model import DataModel, DataModelFieldBase
from datamodel_code_generator.model.base import UNDEFINED
from datamodel_code_generator.model.imports import (
IMPORT_CLASSVAR,
IMPORT_MSGSPEC_CONVERT,
IMPORT_MSGSPEC_FIELD,
IMPORT_MSGSPEC_META,
)
from datamodel_code_generator.model.pydantic.base_model import (
Constraints as _Constraints,
)
from datamodel_code_generator.model.rootmodel import RootModel as _RootModel
from datamodel_code_generator.model.types import DataTypeManager as _DataTypeManager
from datamodel_code_generator.model.types import type_map_factory
from datamodel_code_generator.reference import Reference
from datamodel_code_generator.types import (
DataType,
StrictTypes,
Types,
chain_as_tuple,
get_optional_type,
)
def _has_field_assignment(field: DataModelFieldBase) -> bool:
return not (
field.required
or (field.represented_default == 'None' and field.strip_default_none)
)
DataModelFieldBaseT = TypeVar('DataModelFieldBaseT', bound=DataModelFieldBase)
def import_extender(cls: Type[DataModelFieldBaseT]) -> Type[DataModelFieldBaseT]:
original_imports: property = getattr(cls, 'imports', None) # type: ignore
@wraps(original_imports.fget) # type: ignore
def new_imports(self: DataModelFieldBaseT) -> Tuple[Import, ...]:
extra_imports = []
field = self.field
# TODO: Improve field detection
if field and field.startswith('field('):
extra_imports.append(IMPORT_MSGSPEC_FIELD)
if self.field and 'lambda: convert' in self.field:
extra_imports.append(IMPORT_MSGSPEC_CONVERT)
if self.annotated:
extra_imports.append(IMPORT_MSGSPEC_META)
if self.extras.get('is_classvar'):
extra_imports.append(IMPORT_CLASSVAR)
return chain_as_tuple(original_imports.fget(self), extra_imports) # type: ignore
setattr(cls, 'imports', property(new_imports))
return cls
class RootModel(_RootModel):
pass
class Struct(DataModel):
TEMPLATE_FILE_PATH: ClassVar[str] = 'msgspec.jinja2'
BASE_CLASS: ClassVar[str] = 'msgspec.Struct'
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:
super().__init__(
reference=reference,
fields=sorted(fields, key=_has_field_assignment, reverse=False),
decorators=decorators,
base_classes=base_classes,
custom_base_class=custom_base_class,
custom_template_dir=custom_template_dir,
extra_template_data=extra_template_data,
methods=methods,
path=path,
description=description,
default=default,
nullable=nullable,
keyword_only=keyword_only,
)
self.extra_template_data.setdefault('base_class_kwargs', {})
if self.keyword_only:
self.add_base_class_kwarg('kw_only', 'True')
def add_base_class_kwarg(self, name: str, value):
self.extra_template_data['base_class_kwargs'][name] = value
class Constraints(_Constraints):
# To override existing pattern alias
regex: Optional[str] = Field(None, alias='regex')
pattern: Optional[str] = Field(None, alias='pattern')
@import_extender
class DataModelField(DataModelFieldBase):
_FIELD_KEYS: ClassVar[Set[str]] = {
'default',
'default_factory',
}
_META_FIELD_KEYS: ClassVar[Set[str]] = {
'title',
'description',
'gt',
'ge',
'lt',
'le',
'multiple_of',
# 'min_items', # not supported by msgspec
# 'max_items', # not supported by msgspec
'min_length',
'max_length',
'pattern',
'examples',
# 'unique_items', # not supported by msgspec
}
_PARSE_METHOD = 'convert'
_COMPARE_EXPRESSIONS: ClassVar[Set[str]] = {'gt', 'ge', 'lt', 'le', 'multiple_of'}
constraints: Optional[Constraints] = None
def self_reference(self) -> bool: # pragma: no cover
return isinstance(self.parent, Struct) and self.parent.reference.path in {
d.reference.path for d in self.data_type.all_data_types if d.reference
}
def process_const(self) -> None:
if 'const' not in self.extras:
return None
self.const = True
self.nullable = False
const = self.extras['const']
if self.data_type.type == 'str' and isinstance(
const, str
): # pragma: no cover # Literal supports only str
self.data_type = self.data_type.__class__(literals=[const])
def _get_strict_field_constraint_value(self, constraint: str, value: Any) -> Any:
if value is None or constraint not in self._COMPARE_EXPRESSIONS:
return value
if any(
data_type.type == 'float' for data_type in self.data_type.all_data_types
):
return float(value)
return int(value)
@property
def field(self) -> Optional[str]:
"""for backwards compatibility"""
result = str(self)
if result == '':
return None
return result
def __str__(self) -> str:
data: Dict[str, Any] = {
k: v for k, v in self.extras.items() if k in self._FIELD_KEYS
}
if self.alias:
data['name'] = self.alias
if self.default != UNDEFINED and self.default is not None:
data['default'] = self.default
elif not self.required:
data['default'] = None
if self.required:
data = {
k: v
for k, v in data.items()
if k
not in (
'default',
'default_factory',
)
}
elif self.default and 'default_factory' not in data:
default_factory = self._get_default_as_struct_model()
if default_factory is not None:
data.pop('default')
data['default_factory'] = default_factory
if not data:
return ''
if len(data) == 1 and 'default' in data:
return repr(data['default'])
kwargs = [
f'{k}={v if k == "default_factory" else repr(v)}' for k, v in data.items()
]
return f'field({", ".join(kwargs)})'
@property
def annotated(self) -> Optional[str]:
if not self.use_annotated: # pragma: no cover
return None
data: Dict[str, Any] = {
k: v for k, v in self.extras.items() if k in self._META_FIELD_KEYS
}
if (
self.constraints is not None
and not self.self_reference()
and not self.data_type.strict
):
data = {
**data,
**{
k: self._get_strict_field_constraint_value(k, v)
for k, v in self.constraints.dict().items()
if k in self._META_FIELD_KEYS
},
}
meta_arguments = sorted(
f'{k}={repr(v)}' for k, v in data.items() if v is not None
)
if not meta_arguments:
return None
meta = f'Meta({", ".join(meta_arguments)})'
if not self.required and not self.extras.get('is_classvar'):
type_hint = self.data_type.type_hint
annotated_type = f'Annotated[{type_hint}, {meta}]'
return get_optional_type(annotated_type, self.data_type.use_union_operator)
annotated_type = f'Annotated[{self.type_hint}, {meta}]'
if self.extras.get('is_classvar'):
annotated_type = f'ClassVar[{annotated_type}]'
return annotated_type
def _get_default_as_struct_model(self) -> Optional[str]:
for data_type in self.data_type.data_types or (self.data_type,):
# TODO: Check nested data_types
if data_type.is_dict or self.data_type.is_union:
# TODO: Parse Union and dict model for default
continue # pragma: no cover
elif data_type.is_list and len(data_type.data_types) == 1:
data_type = data_type.data_types[0]
if ( # pragma: no cover
data_type.reference
and (
isinstance(data_type.reference.source, Struct)
or isinstance(data_type.reference.source, RootModel)
)
and isinstance(self.default, list)
):
return f'lambda: {self._PARSE_METHOD}({repr(self.default)}, type=list[{data_type.alias or data_type.reference.source.class_name}])'
elif data_type.reference and isinstance(data_type.reference.source, Struct):
return f'lambda: {self._PARSE_METHOD}({repr(self.default)}, type={data_type.alias or data_type.reference.source.class_name})'
return None
class DataTypeManager(_DataTypeManager):
def __init__(
self,
python_version: PythonVersion = PythonVersion.PY_38,
use_standard_collections: bool = False,
use_generic_container_types: bool = False,
strict_types: Optional[Sequence[StrictTypes]] = None,
use_non_positive_negative_number_constrained_types: bool = False,
use_union_operator: bool = False,
use_pendulum: bool = False,
target_datetime_class: DatetimeClassType = DatetimeClassType.Datetime,
):
super().__init__(
python_version,
use_standard_collections,
use_generic_container_types,
strict_types,
use_non_positive_negative_number_constrained_types,
use_union_operator,
use_pendulum,
target_datetime_class,
)
datetime_map = (
{
Types.time: self.data_type.from_import(IMPORT_TIME),
Types.date: self.data_type.from_import(IMPORT_DATE),
Types.date_time: self.data_type.from_import(IMPORT_DATETIME),
Types.timedelta: self.data_type.from_import(IMPORT_TIMEDELTA),
}
if target_datetime_class is DatetimeClassType.Datetime
else {}
)
self.type_map: Dict[Types, DataType] = {
**type_map_factory(self.data_type),
**datetime_map,
}
|