Coverage for pydantic/_internal/_repr.py: 100.00%

1"""Tools to provide pretty/human-readable display of objects.""" 

2 

3from __future__ import annotations as _annotations 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

4 

5import types 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

6import typing 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

7from typing import Any 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

8 

9import typing_extensions 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

10 

11from . import _typing_extra 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

12 

13if typing.TYPE_CHECKING: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

14 ReprArgs: typing_extensions.TypeAlias = 'typing.Iterable[tuple[str | None, Any]]' 

15 RichReprResult: typing_extensions.TypeAlias = ( 

16 'typing.Iterable[Any | tuple[Any] | tuple[str, Any] | tuple[str, Any, Any]]' 

17 ) 

18 

19 

20class PlainRepr(str): 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

21 """String class where repr doesn't include quotes. Useful with Representation when you want to return a string 

22 representation of something that is valid (or pseudo-valid) python. 

23 """ 

24 

25 def __repr__(self) -> str: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

26 return str(self) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

27 

28 

29class Representation: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

30 # Mixin to provide `__str__`, `__repr__`, and `__pretty__` and `__rich_repr__` methods. 

31 # `__pretty__` is used by [devtools](https://python-devtools.helpmanual.io/). 

32 # `__rich_repr__` is used by [rich](https://rich.readthedocs.io/en/stable/pretty.html). 

33 # (this is not a docstring to avoid adding a docstring to classes which inherit from Representation) 

34 

35 # we don't want to use a type annotation here as it can break get_type_hints 

36 __slots__ = () # type: typing.Collection[str] 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

37 

38 def __repr_args__(self) -> ReprArgs: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

39 """Returns the attributes to show in __str__, __repr__, and __pretty__ this is generally overridden. 

40 

41 Can either return: 

42 * name - value pairs, e.g.: `[('foo_name', 'foo'), ('bar_name', ['b', 'a', 'r'])]` 

43 * or, just values, e.g.: `[(None, 'foo'), (None, ['b', 'a', 'r'])]` 

44 """ 

45 attrs_names = self.__slots__ 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

46 if not attrs_names and hasattr(self, '__dict__'): 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

47 attrs_names = self.__dict__.keys() 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

48 attrs = ((s, getattr(self, s)) for s in attrs_names) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

49 return [(a, v if v is not self else self.__repr_recursion__(v)) for a, v in attrs if v is not None] 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

50 

51 def __repr_name__(self) -> str: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

52 """Name of the instance's class, used in __repr__.""" 

53 return self.__class__.__name__ 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

54 

55 def __repr_recursion__(self, object: Any) -> str: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

56 """Returns the string representation of a recursive object.""" 

57 # This is copied over from the stdlib `pprint` module: 

58 return f'<Recursion on {type(object).__name__} with id={id(object)}>' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

59 

60 def __repr_str__(self, join_str: str) -> str: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

61 return join_str.join(repr(v) if a is None else f'{a}={v!r}' for a, v in self.__repr_args__()) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

62 

63 def __pretty__(self, fmt: typing.Callable[[Any], Any], **kwargs: Any) -> typing.Generator[Any, None, None]: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

64 """Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.""" 

65 yield self.__repr_name__() + '(' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

66 yield 1 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

67 for name, value in self.__repr_args__(): 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

68 if name is not None: 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

69 yield name + '=' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

70 yield fmt(value) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

71 yield ',' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

72 yield 0 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

73 yield -1 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

74 yield ')' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

75 

76 def __rich_repr__(self) -> RichReprResult: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

77 """Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.""" 

78 for name, field_repr in self.__repr_args__(): 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

79 if name is None: 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

80 yield field_repr 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

81 else: 

82 yield name, field_repr 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

83 

84 def __str__(self) -> str: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

85 return self.__repr_str__(' ') 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

86 

87 def __repr__(self) -> str: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

88 return f'{self.__repr_name__()}({self.__repr_str__(", ")})' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

89 

90 

91def display_as_type(obj: Any) -> str: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

92 """Pretty representation of a type, should be as close as possible to the original type definition string. 

93 

94 Takes some logic from `typing._type_repr`. 

95 """ 

96 if isinstance(obj, (types.FunctionType, types.BuiltinFunctionType)): 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

97 return obj.__name__ 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

98 elif obj is ...: 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

99 return '...' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

100 elif isinstance(obj, Representation): 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

101 return repr(obj) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

102 elif isinstance(obj, typing.ForwardRef) or _typing_extra.is_type_alias_type(obj): 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

103 return str(obj) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

104 

105 if not isinstance(obj, (_typing_extra.typing_base, _typing_extra.WithArgsTypes, type)): 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

106 obj = obj.__class__ 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

107 

108 if _typing_extra.origin_is_union(typing_extensions.get_origin(obj)): 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

109 args = ', '.join(map(display_as_type, typing_extensions.get_args(obj))) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

110 return f'Union[{args}]' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

111 elif isinstance(obj, _typing_extra.WithArgsTypes): 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

112 if _typing_extra.is_literal(obj): 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

113 args = ', '.join(map(repr, typing_extensions.get_args(obj))) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

114 else: 

115 args = ', '.join(map(display_as_type, typing_extensions.get_args(obj))) 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

116 try: 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

117 return f'{obj.__qualname__}[{args}]' 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF

118 except AttributeError: 7 ctx1abcdefg

119 return str(obj).replace('typing.', '').replace('typing_extensions.', '') # handles TypeAliasType in 3.12 7 ctx1abcdefg

120 elif isinstance(obj, type): 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

121 return obj.__qualname__ 39 ctx1abhijklmnocpdeqrstuvwxGHIJKLMfgyzABCDEF

122 else: 

123 return repr(obj).replace('typing.', '').replace('typing_extensions.', '') 32 ctx1abhijklmnocpdeqrstuvwxfgyzABCDEF