-
-
Notifications
You must be signed in to change notification settings - Fork 301
Expand file tree
/
Copy pathteam_dto.py
More file actions
258 lines (201 loc) · 8 KB
/
team_dto.py
File metadata and controls
258 lines (201 loc) · 8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
from datetime import datetime
from typing import List, Optional
from fastapi import HTTPException
from pydantic import BaseModel, Field, field_validator
from backend.models.dtos.stats_dto import Pagination
from backend.models.postgis.statuses import (
TeamJoinMethod,
TeamMemberFunctions,
TeamVisibility,
)
def validate_team_visibility(value: str) -> str:
"""Validates that value is a known Team Visibility."""
try:
TeamVisibility[value.upper()]
except KeyError:
raise HTTPException(
status_code=400,
detail=(
f"Unknown teamVisibility: {value}. Valid values are: "
f"{TeamVisibility.PUBLIC.name}, "
f"{TeamVisibility.PRIVATE.name}."
),
)
return value
def validate_team_join_method(value: str):
"""Validates join method value and its visibility."""
try:
TeamJoinMethod[value.upper()]
except KeyError:
raise HTTPException(
status_code=400,
detail=(
f"Unknown teamJoinMethod: {value}. "
f"Valid values are: {TeamJoinMethod.ANY.name}, "
f"{TeamJoinMethod.BY_INVITE.name}, "
f"{TeamJoinMethod.BY_REQUEST.name}."
),
)
return value
def validate_team_member_function(value: str):
"""Validates that value is a known Team Member Function."""
try:
TeamMemberFunctions[value.upper()]
except KeyError:
raise HTTPException(
status_code=400,
detail=(
f"Unknown teamMemberFunction: {value}. "
f"Valid values are: {TeamMemberFunctions.MEMBER.name}, "
f"{TeamMemberFunctions.MANAGER.name}."
),
)
return value
class TeamMembersDTO(BaseModel):
username: str
function: str
active: bool
join_request_notifications: bool = Field(
default=False, alias="joinRequestNotifications"
)
picture_url: Optional[str] = Field(None, alias="pictureUrl")
joined_date: Optional[datetime] = Field(None, alias="joinedDate")
@field_validator("function")
def validate_function(cls, value):
return validate_team_member_function(value)
class Config:
populate_by_name = True
json_encoders = {datetime: lambda v: v.isoformat() + "Z" if v else None}
class TeamProjectDTO(BaseModel):
"""Describes a JSON model to create a project team"""
project_name: str = Field(None)
project_id: int = Field(None)
role: str = Field(None)
class ProjectTeamDTO(BaseModel):
"""Describes a JSON model to create a project team"""
team_id: int = Field(alias="teamId")
team_name: str = Field(default=None, alias="name")
role: str = Field()
class Config:
populate_by_name = True
use_enum_values = True
class TeamDetailsDTO(BaseModel):
"""Pydantic model equivalent of the original TeamDetailsDTO"""
team_id: Optional[int] = Field(None, alias="teamId")
organisation_id: int
organisation: str
organisation_slug: Optional[str] = Field(None, alias="organisationSlug")
name: str
logo: Optional[str] = None
description: Optional[str] = None
join_method: str = Field(alias="joinMethod")
visibility: str
is_org_admin: bool = Field(False)
is_general_admin: bool = Field(False)
members: List[TeamMembersDTO] = Field([], alias="members")
team_projects: List[TeamProjectDTO] = Field([], alias="team_projects")
@field_validator("join_method")
def validate_join_method(cls, value):
return validate_team_join_method(value)
@field_validator("visibility")
def validate_visibility(cls, value):
return validate_team_visibility(value)
class Config:
populate_by_name = True
class TeamDTO(BaseModel):
"""Describes JSON model for a team"""
team_id: Optional[int] = Field(None, alias="teamId")
organisation_id: int = Field(None, alias="organisationId")
organisation: str = Field(None, alias="organisation")
name: str = Field(None, alias="name")
logo: Optional[str] = None
description: Optional[str] = None
join_method: str = Field(None, alias="joinMethod")
visibility: str = Field(None, alias="visibility")
members: Optional[List[TeamMembersDTO]] = None
members_count: Optional[int] = Field(None, alias="membersCount")
managers_count: Optional[int] = Field(None, alias="managersCount")
@field_validator("join_method")
def validate_join_method(cls, value):
return validate_team_join_method(value)
@field_validator("visibility")
def validate_visibility(cls, value):
return validate_team_visibility(value)
class Config:
populate_by_name = True
class TeamsListDTO(BaseModel):
def __init__(self):
"""DTO constructor initialise all arrays to empty"""
super().__init__()
self.teams = []
""" Returns List of all teams"""
teams: List[TeamDTO] = []
pagination: Optional[Pagination] = None
class ListTeamsDTO(BaseModel):
def __init__(self):
"""DTO constructor initialise all arrays to empty"""
super().__init__()
self.teams = []
""" Returns List of all teams"""
teams: List[ProjectTeamDTO] = []
pagination: Optional[Pagination] = None
class NewTeamDTO(BaseModel):
"""Describes a JSON model to create a new team"""
creator: float = Field(None, alias="creator")
organisation_id: int = Field(..., alias="organisation_id")
name: str = Field(..., alias="name")
description: Optional[str] = Field(None, alias="description")
join_method: str = Field(
...,
alias="joinMethod",
)
visibility: str = Field(..., serialize_when_none=False)
@field_validator("join_method")
def validate_join_method(cls, value):
return validate_team_join_method(value)
@field_validator("visibility")
def validate_visibility(cls, value):
return validate_team_visibility(value)
class Config:
populate_by_name = True
class UpdateTeamDTO(BaseModel):
"""Describes a JSON model to update a team"""
creator: Optional[int] = Field(None, alias="creator")
team_id: Optional[int] = Field(None, alias="team_id")
organisation: Optional[str] = Field(None, alias="organisation")
organisation_id: Optional[int] = Field(None, alias="organisation_id")
name: Optional[str] = Field(None, alias="name")
logo: Optional[str] = Field(None, alias="logo")
description: Optional[str] = Field(None, alias="description")
join_method: Optional[str] = Field(None, alias="joinMethod")
visibility: Optional[str] = Field(None, serialize_when_none=False)
members: Optional[List[TeamMembersDTO]] = Field([], serialize_when_none=False)
@field_validator("join_method")
def validate_join_method(cls, value):
return validate_team_join_method(value)
@field_validator("visibility")
def validate_visibility(cls, value):
return validate_team_visibility(value)
class Config:
populate_by_name = True
class TeamSearchDTO(BaseModel):
"""Describes a JSON model to search for a team"""
user_id: Optional[int] = Field(None, alias="userId")
organisation: Optional[int] = Field(None, alias="organisation")
team_name: Optional[str] = Field(None, alias="team_name")
omit_members: Optional[bool] = Field(False, alias="omitMemberList")
full_members_list: Optional[bool] = Field(True, alias="fullMemberList")
member: Optional[int] = Field(None, alias="member")
manager: Optional[int] = Field(None, alias="manager")
team_role: Optional[str] = Field(None, alias="team_role")
member_request: Optional[int] = Field(None, alias="member_request")
paginate: Optional[bool] = Field(False, alias="paginate")
page: Optional[int] = Field(1, alias="page")
per_page: Optional[int] = Field(10, alias="perPage")
class Config:
populate_by_name = True
class ProjectTeamPairDTO(BaseModel):
project_id: int
team_id: int
class ProjectTeamPairDTOList(BaseModel):
items: List[ProjectTeamPairDTO]