Coverage for pydantic/warnings.py: 97.30%

1"""Pydantic-specific warnings.""" 

2 

3from __future__ import annotations as _annotations 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

4 

5from .version import version_short 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

6 

7__all__ = ( 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

8 'PydanticDeprecatedSince20', 

9 'PydanticDeprecatedSince26', 

10 'PydanticDeprecatedSince29', 

11 'PydanticDeprecatedSince210', 

12 'PydanticDeprecatedSince211', 

13 'PydanticDeprecationWarning', 

14 'PydanticExperimentalWarning', 

15) 

16 

17 

18class PydanticDeprecationWarning(DeprecationWarning): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

19 """A Pydantic specific deprecation warning. 

20 

21 This warning is raised when using deprecated functionality in Pydantic. It provides information on when the 

22 deprecation was introduced and the expected version in which the corresponding functionality will be removed. 

23 

24 Attributes: 

25 message: Description of the warning. 

26 since: Pydantic version in what the deprecation was introduced. 

27 expected_removal: Pydantic version in what the corresponding functionality expected to be removed. 

28 """ 

29 

30 message: str 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

31 since: tuple[int, int] 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

32 expected_removal: tuple[int, int] 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

33 

34 def __init__( 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

35 self, message: str, *args: object, since: tuple[int, int], expected_removal: tuple[int, int] | None = None 

36 ) -> None: 

37 super().__init__(message, *args) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

38 self.message = message.rstrip('.') 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

39 self.since = since 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

40 self.expected_removal = expected_removal if expected_removal is not None else (since[0] + 1, 0) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

41 

42 def __str__(self) -> str: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

43 message = ( 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

44 f'{self.message}. Deprecated in Pydantic V{self.since[0]}.{self.since[1]}' 

45 f' to be removed in V{self.expected_removal[0]}.{self.expected_removal[1]}.' 

46 ) 

47 if self.since == (2, 0): 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

48 message += f' See Pydantic V2 Migration Guide at https://errors.pydantic.dev/{version_short()}/migration/' 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

49 return message 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

50 

51 

52class PydanticDeprecatedSince20(PydanticDeprecationWarning): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

53 """A specific `PydanticDeprecationWarning` subclass defining functionality deprecated since Pydantic 2.0.""" 

54 

55 def __init__(self, message: str, *args: object) -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

56 super().__init__(message, *args, since=(2, 0), expected_removal=(3, 0)) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

57 

58 

59class PydanticDeprecatedSince26(PydanticDeprecationWarning): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

60 """A specific `PydanticDeprecationWarning` subclass defining functionality deprecated since Pydantic 2.6.""" 

61 

62 def __init__(self, message: str, *args: object) -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

63 super().__init__(message, *args, since=(2, 6), expected_removal=(3, 0)) 

64 

65 

66class PydanticDeprecatedSince29(PydanticDeprecationWarning): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

67 """A specific `PydanticDeprecationWarning` subclass defining functionality deprecated since Pydantic 2.9.""" 

68 

69 def __init__(self, message: str, *args: object) -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

70 super().__init__(message, *args, since=(2, 9), expected_removal=(3, 0)) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

71 

72 

73class PydanticDeprecatedSince210(PydanticDeprecationWarning): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

74 """A specific `PydanticDeprecationWarning` subclass defining functionality deprecated since Pydantic 2.10.""" 

75 

76 def __init__(self, message: str, *args: object) -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

77 super().__init__(message, *args, since=(2, 10), expected_removal=(3, 0)) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

78 

79 

80class PydanticDeprecatedSince211(PydanticDeprecationWarning): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

81 """A specific `PydanticDeprecationWarning` subclass defining functionality deprecated since Pydantic 2.11.""" 

82 

83 def __init__(self, message: str, *args: object) -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

84 super().__init__(message, *args, since=(2, 11), expected_removal=(3, 0)) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

85 

86 

87class GenericBeforeBaseModelWarning(Warning): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

88 pass 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

89 

90 

91class PydanticExperimentalWarning(Warning): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

92 """A Pydantic specific experimental functionality warning. 

93 

94 This warning is raised when using experimental functionality in Pydantic. 

95 It is raised to warn users that the functionality may change or be removed in future versions of Pydantic. 

96 """