Coverage for apps/kwai-api/src/kwai_api/v1/trainings/coaches/schemas.py: 100%

1"""Module that defines the JSON:API schemas for coaches.""" 

2 

3from typing import Literal 

4 

5from kwai_core.json_api import Meta, Relationship, ResourceIdentifier 

6from pydantic import BaseModel, Field 

7 

8from kwai_api.schemas.resources import CoachResourceIdentifier 

9 

10 

11class CoachAttributes(BaseModel): 

12 """Attributes for a coach JSON:API resource.""" 

13 

14 name: str 

15 head: bool 

16 

17 

18class CoachResource(CoachResourceIdentifier): 

19 """A JSON:API resource for a coach.""" 

20 

21 attributes: CoachAttributes 

22 

23 

24class CoachDocument(BaseModel): 

25 """A JSON:API document for one coaches.""" 

26 

27 data: CoachResource 

28 

29 

30class CoachesDocument(BaseModel): 

31 """A JSON:API document for multiple coaches.""" 

32 

33 meta: Meta 

34 data: list[CoachResource] = Field(default_factory=list) 

35 

36 

37class TrainingCoachResourceIdentifier(ResourceIdentifier): 

38 """A JSON:API resource identifier for a training coach.""" 

39 

40 type: Literal["training_coaches"] = "training_coaches" 

41 

42 

43class TrainingCoachAttributes(BaseModel): 

44 """Base attributes for a training coach JSON:API resource.""" 

45 

46 payed: bool 

47 head: bool 

48 present: bool 

49 remark: str 

50 

51 

52class TrainingCoachRelationships(BaseModel): 

53 """Relationships of a training coach JSON:API resource.""" 

54 

55 coach: Relationship[CoachResourceIdentifier] 

56 

57 

58class TrainingCoachResource(TrainingCoachResourceIdentifier): 

59 """Resource for a training coach JSON:API resource.""" 

60 

61 attributes: TrainingCoachAttributes 

62 relationships: TrainingCoachRelationships 

63 

64 

65class TrainingCoachDocument(BaseModel): 

66 """Document for a coach of a training.""" 

67 

68 data: TrainingCoachResource 

69 included: set[CoachResource] = Field(default_factory=set) 

70 

71 

72class TrainingCoachesDocument(BaseModel): 

73 """Document for multiple training coaches.""" 

74 

75 meta: Meta 

76 data: list[TrainingCoachResource] = Field(default_factory=list) 

77 included: set[CoachResource] = Field(default_factory=set)