Skip to content

models/projectdb.py

models.projectdb

ProjectDB

ProjectDB

Bases: DBBase

Project Collection

Parameters:

Name Type Description Default
pid str

Project id.

 required

Attributes:

Name Type Description
pid str

Project id.
Struct
  • _id: Project id (pid)
  • name: Project name for display.
  • action_date: timestamp The first date of the event launched.
  • created_at: timestamp The data created at.
  • desc: Description.
  • owners: List of uid. The permissions of owner has the top level over the project.
  • calendar: Google Calendar id. The ID patten should be {a-z0-9_}@group.calendar.google.com.
  • gitlab_project_id: Gitlab project id.
  • mailling_leader: The mailing-list for team leaders.
  • mailling_staff: The mailing-list for all project staffs.
  • mattermost_ch_id: The chat room for Mattermost.
  • shared_drive: Google Shared Drive URL.
  • traffic_fee_doc: The announcement URL of the traffic subsidy document.
  • volunteer_certificate_hours: The hours for volunteers to apply for.
  • parking_card: The options for parking card in form.
TODO

Need refactor in pydantic.

Source code in models/projectdb.py 
 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
class ProjectDB(DBBase):
    ''' Project Collection

    Args:
        pid (str): Project id.

    Attributes:
        pid (str): Project id.

    Struct:
        - ``_id``: Project id (pid)
        - ``name``: Project name for display.
        - ``action_date``: `timestamp` The first date of the event launched.
        - ``created_at``: `timestamp` The data created at.
        - ``desc``: Description.
        - ``owners``: List of uid. The permissions of `owner` has the top level over the project.
        - ``calendar``: Google Calendar id. The ID patten should be
                        `{a-z0-9_}@group.calendar.google.com`.
        - ``gitlab_project_id``: Gitlab project id.
        - ``mailling_leader``: The mailing-list for team leaders.
        - ``mailling_staff``: The mailing-list for all project staffs.
        - ``mattermost_ch_id``: The chat room for Mattermost.
        - ``shared_drive``: Google Shared Drive URL.
        - ``traffic_fee_doc``: The announcement URL of the traffic subsidy document.
        - ``volunteer_certificate_hours``: The hours for volunteers to apply for.
        - ``parking_card``: The options for parking card in form.

    TODO:
        Need refactor in pydantic.

    '''

    def __init__(self, pid: str) -> None:
        super().__init__('project')
        self.pid = pid

    def index(self) -> None:
        ''' To make collection's index

        Indexs:
            - `owners`, `action_date`

        '''
        self.create_index([('owners', 1), ('action_date', -1)])

    def default(self) -> dict[str, Any]:
        ''' default data

        Returns:
            The default data will only return the required fields in `_id`, `name`,
                `action_date`, `desc`, `owners`.

        '''
        result = {
            '_id': self.pid,
            'name': '',
            'action_date': 0,
            'desc': '',
            'owners': [],
        }
        self.make_create_at(result)
        return result

    def add(self, data: dict[str, Any]) -> dict[str, Any]:
        ''' Add data

        Args:
            data (dict): The data to inserted / updated.

        Returns:
            Return the inserted / updated data.

        '''
        return self.find_one_and_update(
            {'_id': data['_id']},
            {'$set': data},
            upsert=True,
            return_document=ReturnDocument.AFTER,
        )

add 

add(data: dict[str, Any]) -> dict[str, Any]

Add data

Parameters:

Name Type Description Default
data dict

The data to inserted / updated.

 required

Returns:

Type Description
dict[str, Any]

Return the inserted / updated data.
Source code in models/projectdb.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def add(self, data: dict[str, Any]) -> dict[str, Any]:
    ''' Add data

    Args:
        data (dict): The data to inserted / updated.

    Returns:
        Return the inserted / updated data.

    '''
    return self.find_one_and_update(
        {'_id': data['_id']},
        {'$set': data},
        upsert=True,
        return_document=ReturnDocument.AFTER,
    )

default 

default() -> dict[str, Any]

default data

Returns:

Type Description
dict[str, Any]

The default data will only return the required fields in _id, name, action_date, desc, owners.
Source code in models/projectdb.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def default(self) -> dict[str, Any]:
    ''' default data

    Returns:
        The default data will only return the required fields in `_id`, `name`,
            `action_date`, `desc`, `owners`.

    '''
    result = {
        '_id': self.pid,
        'name': '',
        'action_date': 0,
        'desc': '',
        'owners': [],
    }
    self.make_create_at(result)
    return result

index 

index() -> None

To make collection's index

Indexs
  • owners, action_date
Source code in models/projectdb.py 
45
46
47
48
49
50
51
52
def index(self) -> None:
    ''' To make collection's index

    Indexs:
        - `owners`, `action_date`

    '''
    self.create_index([('owners', 1), ('action_date', -1)])