Coverage for pydantic/root_model.py: 100.00%

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

2 

3from __future__ import annotations as _annotations 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

4 

5import typing 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

6from copy import copy, deepcopy 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

7 

8from pydantic_core import PydanticUndefined 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

9 

10from . import PydanticUserError 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

11from ._internal import _model_construction, _repr 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

12from .main import BaseModel, _object_setattr 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

13 

14if typing.TYPE_CHECKING: 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

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 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

29 

30__all__ = ('RootModel',) 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

31 

32RootModelRootType = typing.TypeVar('RootModelRootType') 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

33 

34 

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

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 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

50 __pydantic_private__ = None 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

51 __pydantic_extra__ = None 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

52 

53 root: RootModelRootType 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

54 

55 def __init_subclass__(cls, **kwargs): 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

56 extra = cls.model_config.get('extra') 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

57 if extra is not None: 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

58 raise PydanticUserError( 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

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

60 ) 

61 super().__init_subclass__(**kwargs) 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

62 

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

64 __tracebackhide__ = True 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

65 if data: 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

66 if root is not PydanticUndefined: 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

67 raise ValueError( 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

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

69 ) 

70 root = data # type: ignore 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

71 self.__pydantic_validator__.validate_python(root, self_instance=self) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

72 

73 __init__.__pydantic_base_init__ = True # pyright: ignore[reportFunctionMemberAccess] 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

74 

75 @classmethod 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

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

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) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

90 

91 def __getstate__(self) -> dict[Any, Any]: 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

92 return { 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

93 '__dict__': self.__dict__, 

94 '__pydantic_fields_set__': self.__pydantic_fields_set__, 

95 } 

96 

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

98 _object_setattr(self, '__pydantic_fields_set__', state['__pydantic_fields_set__']) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

99 _object_setattr(self, '__dict__', state['__dict__']) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

100 

101 def __copy__(self) -> Self: 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

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

103 cls = type(self) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

104 m = cls.__new__(cls) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

105 _object_setattr(m, '__dict__', copy(self.__dict__)) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

106 _object_setattr(m, '__pydantic_fields_set__', copy(self.__pydantic_fields_set__)) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

107 return m 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

108 

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

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

111 cls = type(self) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

112 m = cls.__new__(cls) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

113 _object_setattr(m, '__dict__', deepcopy(self.__dict__, memo=memo)) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

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__)) 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

117 return m 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

118 

119 if typing.TYPE_CHECKING: 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

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 | None = None, 

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: 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

150 if not isinstance(other, RootModel): 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

151 return NotImplemented 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

152 return self.__pydantic_fields__['root'].annotation == other.__pydantic_fields__[ 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO

153 'root' 

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

155 

156 def __repr_args__(self) -> _repr.ReprArgs: 42 ctx1abcdefghijklmnopqrstuvwxyzABPCDEFGHIJKLMNO

157 yield 'root', self.root 41 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNO