Coverage for pydantic/_internal/_decorators_v1.py: 95.00%

1"""Logic for V1 validators, e.g. `@validator` and `@root_validator`.""" 

2 

3from __future__ import annotations as _annotations 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

4 

5from inspect import Parameter, signature 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

6from typing import Any, Union, cast 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

7 

8from pydantic_core import core_schema 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

9from typing_extensions import Protocol 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

10 

11from ..errors import PydanticUserError 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

12from ._utils import can_be_positional 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

13 

14 

15class V1OnlyValueValidator(Protocol): 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

16 """A simple validator, supported for V1 validators and V2 validators.""" 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

17 

18 def __call__(self, __value: Any) -> Any: ... 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

19 

20 

21class V1ValidatorWithValues(Protocol): 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

22 """A validator with `values` argument, supported for V1 validators and V2 validators.""" 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

23 

24 def __call__(self, __value: Any, values: dict[str, Any]) -> Any: ... 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

25 

26 

27class V1ValidatorWithValuesKwOnly(Protocol): 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

28 """A validator with keyword only `values` argument, supported for V1 validators and V2 validators.""" 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

29 

30 def __call__(self, __value: Any, *, values: dict[str, Any]) -> Any: ... 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

31 

32 

33class V1ValidatorWithKwargs(Protocol): 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

34 """A validator with `kwargs` argument, supported for V1 validators and V2 validators.""" 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

35 

36 def __call__(self, __value: Any, **kwargs: Any) -> Any: ... 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

37 

38 

39class V1ValidatorWithValuesAndKwargs(Protocol): 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

40 """A validator with `values` and `kwargs` arguments, supported for V1 validators and V2 validators.""" 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

41 

42 def __call__(self, __value: Any, values: dict[str, Any], **kwargs: Any) -> Any: ... 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

43 

44 

45V1Validator = Union[ 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

46 V1ValidatorWithValues, V1ValidatorWithValuesKwOnly, V1ValidatorWithKwargs, V1ValidatorWithValuesAndKwargs 

47] 

48 

49 

50def can_be_keyword(param: Parameter) -> bool: 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

51 return param.kind in (Parameter.POSITIONAL_OR_KEYWORD, Parameter.KEYWORD_ONLY) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

52 

53 

54def make_generic_v1_field_validator(validator: V1Validator) -> core_schema.WithInfoValidatorFunction: 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

55 """Wrap a V1 style field validator for V2 compatibility. 

56 

57 Args: 

58 validator: The V1 style field validator. 

59 

60 Returns: 

61 A wrapped V2 style field validator. 

62 

63 Raises: 

64 PydanticUserError: If the signature is not supported or the parameters are 

65 not available in Pydantic V2. 

66 """ 

67 sig = signature(validator) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

68 

69 needs_values_kw = False 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

70 

71 for param_num, (param_name, parameter) in enumerate(sig.parameters.items()): 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

72 if can_be_keyword(parameter) and param_name in ('field', 'config'): 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

73 raise PydanticUserError( 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

74 'The `field` and `config` parameters are not available in Pydantic V2, ' 

75 'please use the `info` parameter instead.', 

76 code='validator-field-config-info', 

77 ) 

78 if parameter.kind is Parameter.VAR_KEYWORD: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

79 needs_values_kw = True 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

80 elif can_be_keyword(parameter) and param_name == 'values': 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

81 needs_values_kw = True 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

82 elif can_be_positional(parameter) and param_num == 0: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

83 # value 

84 continue 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

85 elif parameter.default is Parameter.empty: # ignore params with defaults e.g. bound by functools.partial 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

86 raise PydanticUserError( 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

87 f'Unsupported signature for V1 style validator {validator}: {sig} is not supported.', 

88 code='validator-v1-signature', 

89 ) 

90 

91 if needs_values_kw: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

92 # (v, **kwargs), (v, values, **kwargs), (v, *, values, **kwargs) or (v, *, values) 

93 val1 = cast(V1ValidatorWithValues, validator) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

94 

95 def wrapper1(value: Any, info: core_schema.ValidationInfo) -> Any: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

96 return val1(value, values=info.data) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

97 

98 return wrapper1 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

99 else: 

100 val2 = cast(V1OnlyValueValidator, validator) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

101 

102 def wrapper2(value: Any, _: core_schema.ValidationInfo) -> Any: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

103 return val2(value) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

104 

105 return wrapper2 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

106 

107 

108RootValidatorValues = dict[str, Any] 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

109# technically tuple[model_dict, model_extra, fields_set] | tuple[dataclass_dict, init_vars] 

110RootValidatorFieldsTuple = tuple[Any, ...] 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

111 

112 

113class V1RootValidatorFunction(Protocol): 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

114 """A simple root validator, supported for V1 validators and V2 validators.""" 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

115 

116 def __call__(self, __values: RootValidatorValues) -> RootValidatorValues: ... 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

117 

118 

119class V2CoreBeforeRootValidator(Protocol): 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

120 """V2 validator with mode='before'.""" 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

121 

122 def __call__(self, __values: RootValidatorValues, __info: core_schema.ValidationInfo) -> RootValidatorValues: ... 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

123 

124 

125class V2CoreAfterRootValidator(Protocol): 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

126 """V2 validator with mode='after'.""" 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

127 

128 def __call__( 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

129 self, __fields_tuple: RootValidatorFieldsTuple, __info: core_schema.ValidationInfo 18 ctx1abcdefghijGHIJklmn

130 ) -> RootValidatorFieldsTuple: ... 18 ctx1abcdefghijGHIJklmn

131 

132 

133def make_v1_generic_root_validator( 39 ctx1opqrstabcdefuvwxyzghijKLMGHIJABCDEFklmn

134 validator: V1RootValidatorFunction, pre: bool 

135) -> V2CoreBeforeRootValidator | V2CoreAfterRootValidator: 

136 """Wrap a V1 style root validator for V2 compatibility. 

137 

138 Args: 

139 validator: The V1 style field validator. 

140 pre: Whether the validator is a pre validator. 

141 

142 Returns: 

143 A wrapped V2 style validator. 

144 """ 

145 if pre is True: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

146 # mode='before' for pydantic-core 

147 def _wrapper1(values: RootValidatorValues, _: core_schema.ValidationInfo) -> RootValidatorValues: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

148 return validator(values) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

149 

150 return _wrapper1 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

151 

152 # mode='after' for pydantic-core 

153 def _wrapper2(fields_tuple: RootValidatorFieldsTuple, _: core_schema.ValidationInfo) -> RootValidatorFieldsTuple: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

154 if len(fields_tuple) == 2: 154 ↛ 156line 154 didn't jump to line 156 because the condition on line 154 was never true32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

155 # dataclass, this is easy 

156 values, init_vars = fields_tuple 

157 values = validator(values) 

158 return values, init_vars 

159 else: 

160 # ugly hack: to match v1 behaviour, we merge values and model_extra, then split them up based on fields 

161 # afterwards 

162 model_dict, model_extra, fields_set = fields_tuple 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

163 if model_extra: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

164 fields = set(model_dict.keys()) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

165 model_dict.update(model_extra) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

166 model_dict_new = validator(model_dict) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

167 for k in list(model_dict_new.keys()): 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

168 if k not in fields: 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

169 model_extra[k] = model_dict_new.pop(k) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

170 else: 

171 model_dict_new = validator(model_dict) 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

172 return model_dict_new, model_extra, fields_set 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn

173 

174 return _wrapper2 32 ctx1opqrstabcdefuvwxyzghijABCDEFklmn