Coverage for fastapi/_compat/model_field.py: 100%

1from typing import ( 7 ctx1abcdefg

2 Any, 

3 Dict, 

4 List, 

5 Tuple, 

6 Union, 

7) 

8 

9from fastapi.types import IncEx 7 ctx1abcdefg

10from pydantic.fields import FieldInfo 7 ctx1abcdefg

11from typing_extensions import Literal, Protocol 7 ctx1abcdefg

12 

13 

14class ModelField(Protocol): 7 ctx1abcdefg

15 field_info: "FieldInfo" 7 ctx1abcdefg

16 name: str 7 ctx1abcdefg

17 mode: Literal["validation", "serialization"] = "validation" 7 ctx1abcdefg

18 _version: Literal["v1", "v2"] = "v1" 7 ctx1abcdefg

19 

20 @property 7 ctx1abcdefg

21 def alias(self) -> str: ... 7 ctx1abcdefg

22 

23 @property 7 ctx1abcdefg

24 def required(self) -> bool: ... 7 ctx1abcdefg

25 

26 @property 7 ctx1abcdefg

27 def default(self) -> Any: ... 7 ctx1abcdefg

28 

29 @property 7 ctx1abcdefg

30 def type_(self) -> Any: ... 7 ctx1abcdefg

31 

32 def get_default(self) -> Any: ... 7 ctx1abcdefg

33 

34 def validate( 7 ctx1abcdefg

35 self, 

36 value: Any, 

37 values: Dict[str, Any] = {}, # noqa: B006 

38 *, 

39 loc: Tuple[Union[int, str], ...] = (), 

40 ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]: ... 

41 

42 def serialize( 7 ctx1abcdefg

43 self, 

44 value: Any, 

45 *, 

46 mode: Literal["json", "python"] = "json", 

47 include: Union[IncEx, None] = None, 

48 exclude: Union[IncEx, None] = None, 

49 by_alias: bool = True, 

50 exclude_unset: bool = False, 

51 exclude_defaults: bool = False, 

52 exclude_none: bool = False, 

53 ) -> Any: ...