Skip to content

models/formdb.py

models.formdb

FormDB

FormDB

Bases: DBBase

Form Collection

Source code in models/formdb.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
class FormDB(DBBase):
    ''' Form Collection '''

    def __init__(self) -> None:
        super().__init__('form')

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

        Indexs:
            - `case`
            - `pid`

        '''
        self.create_index([('case', 1), ])
        self.create_index([('pid', 1), ])

    def add_by_case(self, case: str, pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Add data by case

        Args:
            case (str): Case name.
            pid (str): Project id.
            uid (str): User id.
            data (dict): The data to insert / update.

        Returns:
            Return the inserted / updated data.

        '''
        _data = {}
        for k in data:
            _data[f'data.{k}'] = data[k]

        return self.find_one_and_update(
            {'case': case, 'pid': pid, 'uid': uid},
            {'$set': _data},
            upsert=True,
            return_document=ReturnDocument.AFTER,
        )

add_by_case 

add_by_case(
    case: str, pid: str, uid: str, data: dict[str, Any]
) -> dict[str, Any]

Add data by case

Parameters:

Name Type Description Default
case str

Case name.

 required
pid str

Project id.

 required
uid str

User id.

 required
data dict

The data to insert / update.

 required

Returns:

Type Description
dict[str, Any]

Return the inserted / updated data.
Source code in models/formdb.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def add_by_case(self, case: str, pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Add data by case

    Args:
        case (str): Case name.
        pid (str): Project id.
        uid (str): User id.
        data (dict): The data to insert / update.

    Returns:
        Return the inserted / updated data.

    '''
    _data = {}
    for k in data:
        _data[f'data.{k}'] = data[k]

    return self.find_one_and_update(
        {'case': case, 'pid': pid, 'uid': uid},
        {'$set': _data},
        upsert=True,
        return_document=ReturnDocument.AFTER,
    )

index 

index() -> None

To make collection's index

Indexs
  • case
  • pid
Source code in models/formdb.py 
15
16
17
18
19
20
21
22
23
24
def index(self) -> None:
    ''' To make collection's index

    Indexs:
        - `case`
        - `pid`

    '''
    self.create_index([('case', 1), ])
    self.create_index([('pid', 1), ])

FormTrafficFeeMappingDB

Bases: DBBase

Form traffic fee mapping Collection

Source code in models/formdb.py 
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
class FormTrafficFeeMappingDB(DBBase):
    ''' Form traffic fee mapping Collection '''

    def __init__(self) -> None:
        super().__init__('form_traffic_fee_mapping')

    def save(self, pid: str, data: dict[str, Any]) -> dict[str, Any]:  # pylint: disable=arguments-differ
        ''' Save location / fee data

        Args:
            pid (str): Project id.
            data (dict): The data to insert / update.

                Format: `{'{location}': {fee}, ...}`

        Returns:
            Return the inserted / updated data.

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

save 

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

Save location / fee data

Parameters:

Name Type Description Default
pid str

Project id.

 required
data dict

The data to insert / update.

Format: {'{location}': {fee}, ...}

 required

Returns:

Type Description
dict[str, Any]

Return the inserted / updated data.
Source code in models/formdb.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def save(self, pid: str, data: dict[str, Any]) -> dict[str, Any]:  # pylint: disable=arguments-differ
    ''' Save location / fee data

    Args:
        pid (str): Project id.
        data (dict): The data to insert / update.

            Format: `{'{location}': {fee}, ...}`

    Returns:
        Return the inserted / updated data.

    '''
    return self.find_one_and_update(
        {'_id': pid},
        {'$set': {'data': data}},
        upsert=True,
        return_document=ReturnDocument.AFTER,
    )
Last update: June 6, 2022