Skip to content

structs/projects.py

structs.projects

Project Structs

ProjectBase

Bases: BaseModel

ProjectBase

Source code in structs/projects.py 
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
class ProjectBase(BaseModel):
    ''' ProjectBase'''
    id: str = Field(description='`pid`, project id', alias='_id')
    name: str = Field(description='project name')
    owners: list[str] = Field(description='list of owners')
    action_date: datetime = Field(description='action date')
    desc: str | None = Field(description='desc')
    calendar: str | None = Field(description='calendar url')
    gitlab_project_id: str | None = Field(description='gitlab project id')
    mailling_leader: EmailStr | None = Field(
        description='mailing list of leader')
    mailling_staff: EmailStr | None = Field(
        description='mailing list of staff')
    mattermost_ch_id: str | None = Field(
        description='Mattermost main channel id')
    shared_drive: HttpUrl | None = Field(description='Google shared drive')
    traffic_fee_doc: HttpUrl | None = Field(
        description='doc fields for traffic fee')
    volunteer_certificate_hours: int = Field(
        default=16, ge=0,
        description='hours for volunteer certificate')

    _validate_skip_empty_str = validator(
        '*', pre=True, allow_reuse=True)(skip_empty_str)
    _validate_convert_action_date = validator(
        'action_date', pre=True, allow_reuse=True)(convert_action_date)

ProjectBaseUpdate

Bases: BaseModel

ProjectBaseUpdate

Source code in structs/projects.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
class ProjectBaseUpdate(BaseModel):
    ''' ProjectBaseUpdate '''
    name: str | None = Field(description='project name')
    action_date: datetime | None = Field(description='action date')
    desc: str | None = Field(description='desc')
    calendar: str | None = Field(description='calendar url')
    gitlab_project_id: str | None = Field(description='gitlab project id')
    mailling_leader: EmailStr | None = Field(
        description='mailing list of leader')
    mailling_staff: EmailStr | None = Field(
        description='mailing list of staff')
    mattermost_ch_id: str | None = Field(
        description='Mattermost main channel id')
    shared_drive: HttpUrl | None = Field(description='Google shared drive')
    traffic_fee_doc: HttpUrl | None = Field(
        description='doc fields for traffic fee')
    volunteer_certificate_hours: int = Field(
        default=16, ge=0,
        description='hours for volunteer certificate')

    _validate_skip_empty_str = validator(
        '*', pre=True, allow_reuse=True)(skip_empty_str)
    _validate_convert_action_date = validator(
        'action_date', pre=True, allow_reuse=True)(convert_action_date)

ProjectTrafficLocationFee

Bases: BaseModel

ProjectTrafficLocationFee

Source code in structs/projects.py 
90
91
92
93
class ProjectTrafficLocationFee(BaseModel):
    ''' ProjectTrafficLocationFee '''
    data: list[ProjectTrafficLocationFeeItem] = Field(
        description='list of data')

ProjectTrafficLocationFeeItem

Bases: BaseModel

ProjectTrafficLocationFeeItem

Source code in structs/projects.py 
79
80
81
82
83
84
85
86
87
class ProjectTrafficLocationFeeItem(BaseModel):
    ''' ProjectTrafficLocationFeeItem '''
    location: str = Field(default='', description='location')
    fee: int = Field(default=0, description='fee in TWD', gt=0)

    class Config:
        ''' Config '''
        # pylint: disable=too-few-public-methods
        anystr_strip_whitespace = True

Config

Config

Source code in structs/projects.py 
84
85
86
87
class Config:
    ''' Config '''
    # pylint: disable=too-few-public-methods
    anystr_strip_whitespace = True

convert_action_date 

convert_action_date(value: Any) -> datetime

convert action_date to date

Source code in structs/projects.py 
20
21
22
def convert_action_date(value: Any) -> datetime:
    ''' convert `action_date` to date '''
    return arrow.get(value).naive

skip_empty_str 

skip_empty_str(value: Any) -> Any

skip empty string

Source code in structs/projects.py 
 9
10
11
12
13
14
15
16
17
def skip_empty_str(value: Any) -> Any:
    ''' skip empty string '''
    if isinstance(value, str):
        value = value.strip()

    if not value:
        return None

    return value
Last update: October 13, 2022