Coverage for pydantic/root_model.py: 100.00%

1"""RootModel class and type definitions.""" 

2 

3from __future__ import annotations as _annotations 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

4 

5import typing 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

6from copy import copy, deepcopy 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

7 

8from pydantic_core import PydanticUndefined 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

9 

10from . import PydanticUserError 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

11from ._internal import _model_construction, _repr 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

12from .main import BaseModel, _object_setattr 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

13 

14if typing.TYPE_CHECKING: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

15 from typing import Any, Literal 

16 

17 from typing_extensions import Self, dataclass_transform 

18 

19 from .fields import Field as PydanticModelField 

20 from .fields import PrivateAttr as PydanticModelPrivateAttr 

21 

22 # dataclass_transform could be applied to RootModel directly, but `ModelMetaclass`'s dataclass_transform 

23 # takes priority (at least with pyright). We trick type checkers into thinking we apply dataclass_transform 

24 # on a new metaclass. 

25 @dataclass_transform(kw_only_default=False, field_specifiers=(PydanticModelField, PydanticModelPrivateAttr)) 

26 class _RootModelMetaclass(_model_construction.ModelMetaclass): ... 

27else: 

28 _RootModelMetaclass = _model_construction.ModelMetaclass 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

29 

30__all__ = ('RootModel',) 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

31 

32RootModelRootType = typing.TypeVar('RootModelRootType') 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

33 

34 

35class RootModel(BaseModel, typing.Generic[RootModelRootType], metaclass=_RootModelMetaclass): 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

36 """!!! abstract "Usage Documentation" 

37 [`RootModel` and Custom Root Types](../concepts/models.md#rootmodel-and-custom-root-types) 

38 

39 A Pydantic `BaseModel` for the root object of the model. 

40 

41 Attributes: 

42 root: The root object of the model. 

43 __pydantic_root_model__: Whether the model is a RootModel. 

44 __pydantic_private__: Private fields in the model. 

45 __pydantic_extra__: Extra fields in the model. 

46 

47 """ 

48 

49 __pydantic_root_model__ = True 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

50 __pydantic_private__ = None 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

51 __pydantic_extra__ = None 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

52 

53 root: RootModelRootType 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

54 

55 def __init_subclass__(cls, **kwargs): 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

56 extra = cls.model_config.get('extra') 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

57 if extra is not None: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

58 raise PydanticUserError( 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

59 "`RootModel` does not support setting `model_config['extra']`", code='root-model-extra' 

60 ) 

61 super().__init_subclass__(**kwargs) 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

62 

63 def __init__(self, /, root: RootModelRootType = PydanticUndefined, **data) -> None: # type: ignore 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

64 __tracebackhide__ = True 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

65 if data: 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

66 if root is not PydanticUndefined: 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

67 raise ValueError( 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

68 '"RootModel.__init__" accepts either a single positional argument or arbitrary keyword arguments' 

69 ) 

70 root = data # type: ignore 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

71 self.__pydantic_validator__.validate_python(root, self_instance=self) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

72 

73 __init__.__pydantic_base_init__ = True # pyright: ignore[reportFunctionMemberAccess] 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

74 

75 @classmethod 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

76 def model_construct(cls, root: RootModelRootType, _fields_set: set[str] | None = None) -> Self: # type: ignore 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

77 """Create a new model using the provided root object and update fields set. 

78 

79 Args: 

80 root: The root object of the model. 

81 _fields_set: The set of fields to be updated. 

82 

83 Returns: 

84 The new model. 

85 

86 Raises: 

87 NotImplemented: If the model is not a subclass of `RootModel`. 

88 """ 

89 return super().model_construct(root=root, _fields_set=_fields_set) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

90 

91 def __getstate__(self) -> dict[Any, Any]: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

92 return { 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

93 '__dict__': self.__dict__, 

94 '__pydantic_fields_set__': self.__pydantic_fields_set__, 

95 } 

96 

97 def __setstate__(self, state: dict[Any, Any]) -> None: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

98 _object_setattr(self, '__pydantic_fields_set__', state['__pydantic_fields_set__']) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

99 _object_setattr(self, '__dict__', state['__dict__']) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

100 

101 def __copy__(self) -> Self: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

102 """Returns a shallow copy of the model.""" 

103 cls = type(self) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

104 m = cls.__new__(cls) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

105 _object_setattr(m, '__dict__', copy(self.__dict__)) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

106 _object_setattr(m, '__pydantic_fields_set__', copy(self.__pydantic_fields_set__)) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

107 return m 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

108 

109 def __deepcopy__(self, memo: dict[int, Any] | None = None) -> Self: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

110 """Returns a deep copy of the model.""" 

111 cls = type(self) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

112 m = cls.__new__(cls) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

113 _object_setattr(m, '__dict__', deepcopy(self.__dict__, memo=memo)) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

114 # This next line doesn't need a deepcopy because __pydantic_fields_set__ is a set[str], 

115 # and attempting a deepcopy would be marginally slower. 

116 _object_setattr(m, '__pydantic_fields_set__', copy(self.__pydantic_fields_set__)) 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

117 return m 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

118 

119 if typing.TYPE_CHECKING: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

120 

121 def model_dump( # type: ignore 

122 self, 

123 *, 

124 mode: Literal['json', 'python'] | str = 'python', 

125 include: Any = None, 

126 exclude: Any = None, 

127 context: dict[str, Any] | None = None, 

128 by_alias: bool = False, 

129 exclude_unset: bool = False, 

130 exclude_defaults: bool = False, 

131 exclude_none: bool = False, 

132 round_trip: bool = False, 

133 warnings: bool | Literal['none', 'warn', 'error'] = True, 

134 serialize_as_any: bool = False, 

135 ) -> Any: 

136 """This method is included just to get a more accurate return type for type checkers. 

137 It is included in this `if TYPE_CHECKING:` block since no override is actually necessary. 

138 

139 See the documentation of `BaseModel.model_dump` for more details about the arguments. 

140 

141 Generally, this method will have a return type of `RootModelRootType`, assuming that `RootModelRootType` is 

142 not a `BaseModel` subclass. If `RootModelRootType` is a `BaseModel` subclass, then the return 

143 type will likely be `dict[str, Any]`, as `model_dump` calls are recursive. The return type could 

144 even be something different, in the case of a custom serializer. 

145 Thus, `Any` is used here to catch all of these cases. 

146 """ 

147 ... 

148 

149 def __eq__(self, other: Any) -> bool: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

150 if not isinstance(other, RootModel): 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

151 return NotImplemented 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

152 return self.__pydantic_fields__['root'].annotation == other.__pydantic_fields__[ 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF

153 'root' 

154 ].annotation and super().__eq__(other) 

155 

156 def __repr_args__(self) -> _repr.ReprArgs: 39 ctx1abcdefghijklmnopqrstuvGHIJKLMwxyzABCDEF

157 yield 'root', self.root 32 ctx1abcdefghijklmnopqrstuvwxyzABCDEF