Skip to content

module/form.py

module.form

Form

Form

Form Object

Source code in module/form.py 
 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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
class Form:  # pylint: disable=too-many-public-methods
    ''' Form Object '''
    @staticmethod
    def update_appreciation(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Update appreciation

        Args:
            pid (str): Project id.
            uid (str): User id.
            data (dict): The data to update.

                - `available`: `bool`.
                - `key`: In one of `oauth`, `badge_name`, `real_name`.
                - `value`: As user name.

        Returns:
            Return the added data.

        TODO:
            Need refactor in pydantic.

        '''
        return FormDB().add_by_case(case='appreciation', pid=pid, uid=uid, data=data)

    @staticmethod
    def get_appreciation(pid: str, uid: str) -> Optional[dict[str, Any]]:
        ''' Get appreciation

        Args:
            pid (str): Project id.
            uid (str): User id.

        Returns:
            The data or `None`.

        '''
        return FormDB().find_one({'case': 'appreciation', 'pid': pid, 'uid': uid})

    @staticmethod
    def all_appreciation(pid: str) -> Generator[dict[str, Any], None, None]:
        ''' Get all appreciation

        Args:
            pid (str): Project id.

        Yields:
            Return the data in `pid`.

        '''
        for raw in FormDB().find({'case': 'appreciation', 'pid': pid}):
            yield raw

    @staticmethod
    def update_volunteer_certificate(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Update volunteer certificate

        Args:
            pid (str): Project id.
            uid (str): User id.
            data (dict): The data to update.

                - `value`: `bool`.

        Returns:
            Return the added data.

        TODO:
            Need refactor in pydantic.

        '''
        return FormDB().add_by_case(case='volunteer_certificate', pid=pid, uid=uid, data=data)

    @staticmethod
    def get_volunteer_certificate(pid: str, uid: str) -> Optional[dict[str, Any]]:
        ''' Get volunteer certificate

        Args:
            pid (str): Project id.
            uid (str): User id.

        Returns:
            The data or `None`.

        '''
        return FormDB().find_one({'case': 'volunteer_certificate', 'pid': pid, 'uid': uid})

    @staticmethod
    def all_volunteer_certificate(pid: str) -> Generator[dict[str, Any], None, None]:
        ''' Get All volunteer certificate

        Args:
            pid (str): Project id.

        Yields:
            Return the data in `pid`.

        '''
        for raw in FormDB().find({'case': 'volunteer_certificate', 'pid': pid}):
            yield raw

    @staticmethod
    def update_traffic_fee(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Update traffic fee

        Args:
            pid (str): Project id.
            uid (str): User id.
            data (dict): The data to update.

                - `apply`: `bool`.
                - `fee`: `int`.
                - `fromwhere`: `str`.
                - `howto`: `str`.

        Returns:
            Return the added data.

        TODO:
            Need refactor in pydantic.

        '''
        return FormDB().add_by_case(case='traffic_fee', pid=pid, uid=uid, data=data)

    @staticmethod
    def get_traffic_fee(pid: str, uid: str) -> Optional[dict[str, Any]]:
        ''' Get traffic fee

        Args:
            pid (str): Project id.
            uid (str): User id.

        Returns:
            The data or `None`.

        '''
        return FormDB().find_one({'case': 'traffic_fee', 'pid': pid, 'uid': uid})

    @staticmethod
    def all_traffic_fee(pid: str) -> Generator[dict[str, Any], None, None]:
        ''' Get All traffic_fee

        Args:
            pid (str): Project id.

        Yields:
            Return the data in `pid`.

        '''
        for raw in FormDB().find({'case': 'traffic_fee', 'pid': pid}):
            yield raw

    @staticmethod
    def update_accommodation(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Update accommodation

        Args:
            pid (str): Project id.
            uid (str): User id.
            data (dict): The data to update.

                - `key`: In one of `yes-longtraffic`, `yes`, `no`.
                - `status`: `bool`.
                - `room`: Optional. The room numbers.
                - `room_key`: Optional. The key for exchange the place for
                              some users want live together.
                - `mixed`: (bool) accepted in mixed room.

        Returns:
            Return the added data.

        See Also:
            The more about how to use the `room_key` to exchange the `room`,
                please move to [module.form.FormAccommodation][].

        TODO:
            Need refactor in pydantic.

        '''
        return FormDB().add_by_case(case='accommodation', pid=pid, uid=uid, data=data)

    @staticmethod
    def get_accommodation(pid: str, uid: str) -> Optional[dict[str, Any]]:
        ''' Get accommodation

        Args:
            pid (str): Project id.
            uid (str): User id.

        Returns:
            The data or `None`.

        '''
        return FormDB().find_one({'case': 'accommodation', 'pid': pid, 'uid': uid})

    @staticmethod
    def all_accommodation(pid: str) -> Generator[dict[str, Any], None, None]:
        ''' Get all accommodation

        Args:
            pid (str): Project id.

        Yields:
            Return the data in `pid`.

        '''
        for raw in FormDB().find({'case': 'accommodation', 'pid': pid}):
            yield raw

    @staticmethod
    def update_clothes(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Update clothes

        Args:
            pid (str): Project id.
            uid (str): User id.
            data (dict): The data to update.

                - `clothes`: `S / 38.5 / 55` ...

        Returns:
            Return the added data.

        TODO:
            Need refactor in pydantic.

        '''
        return FormDB().add_by_case(case='clothes', pid=pid, uid=uid, data=data)

    @staticmethod
    def get_clothes(pid: str, uid: str) -> Optional[dict[str, Any]]:
        ''' Get clothes

        Args:
            pid (str): Project id.
            uid (str): User id.

        Returns:
            The data or `None`.

        '''
        return FormDB().find_one({'case': 'clothes', 'pid': pid, 'uid': uid})

    @staticmethod
    def all_clothes(pid: str) -> Generator[dict[str, Any], None, None]:
        ''' Get all clothes

        Args:
            pid (str): Project id.

        Yields:
            Return the data in `pid`.

        '''
        for raw in FormDB().find({'case': 'clothes', 'pid': pid}):
            yield raw

    @staticmethod
    def update_parking_card(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Update parking card

        Args:
            pid (str): Project id.
            uid (str): User id.
            data (dict): The data to update.

                - `carno`: The license plate.
                - `dates`: List of dates. The dates options are from
                           the collection of `db.project.parking_card`.

        Returns:
            Return the added data.

        TODO:
            Need refactor in pydantic.

        '''
        return FormDB().add_by_case(case='parking_card', pid=pid, uid=uid, data=data)

    @staticmethod
    def get_parking_card(pid: str, uid: str) -> Optional[dict[str, Any]]:
        ''' Get parking card

        Args:
            pid (str): Project id.
            uid (str): User id.

        Returns:
            The data or `None`.

        '''
        return FormDB().find_one({'case': 'parking_card', 'pid': pid, 'uid': uid})

    @staticmethod
    def all_parking_card(pid: str) -> Generator[dict[str, Any], None, None]:
        ''' Get all parking card

        Args:
            pid (str): Project id.

        Yields:
            Return the data in `pid`.

        '''
        for raw in FormDB().find({'case': 'parking_card', 'pid': pid}):
            yield raw

    @staticmethod
    def update_drink(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Update drink

        Args:
            pid (str): Project id.
            uid (str): User id.
            data (dict): The data to update.

                - `y18`: `bool`.

        Returns:
            Return the added data.

        TODO:
            Need refactor in pydantic.

        '''
        return FormDB().add_by_case(case='drink', pid=pid, uid=uid, data=data)

    @staticmethod
    def get_drink(pid: str, uid: str) -> Optional[dict[str, Any]]:
        ''' Get drink

        Args:
            pid (str): Project id.
            uid (str): User id.

        Returns:
            The data or `None`.

        '''
        return FormDB().find_one({'case': 'drink', 'pid': pid, 'uid': uid})

    @staticmethod
    def all_drink(pid: str) -> Generator[dict[str, Any], None, None]:
        ''' Get all drink

        Args:
            pid (str): Project id.

        Yields:
            Return the data in `pid`.

        '''
        for raw in FormDB().find({'case': 'drink', 'pid': pid}):
            yield raw

all_accommodation staticmethod 

all_accommodation(
    pid: str,
) -> Generator[dict[str, Any], None, None]

Get all accommodation

Parameters:

Name Type Description Default
pid str

Project id.

 required

Yields:

Type Description
dict[str, Any]

Return the data in pid.
Source code in module/form.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
@staticmethod
def all_accommodation(pid: str) -> Generator[dict[str, Any], None, None]:
    ''' Get all accommodation

    Args:
        pid (str): Project id.

    Yields:
        Return the data in `pid`.

    '''
    for raw in FormDB().find({'case': 'accommodation', 'pid': pid}):
        yield raw

all_appreciation staticmethod 

all_appreciation(
    pid: str,
) -> Generator[dict[str, Any], None, None]

Get all appreciation

Parameters:

Name Type Description Default
pid str

Project id.

 required

Yields:

Type Description
dict[str, Any]

Return the data in pid.
Source code in module/form.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
@staticmethod
def all_appreciation(pid: str) -> Generator[dict[str, Any], None, None]:
    ''' Get all appreciation

    Args:
        pid (str): Project id.

    Yields:
        Return the data in `pid`.

    '''
    for raw in FormDB().find({'case': 'appreciation', 'pid': pid}):
        yield raw

all_clothes staticmethod 

all_clothes(
    pid: str,
) -> Generator[dict[str, Any], None, None]

Get all clothes

Parameters:

Name Type Description Default
pid str

Project id.

 required

Yields:

Type Description
dict[str, Any]

Return the data in pid.
Source code in module/form.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
@staticmethod
def all_clothes(pid: str) -> Generator[dict[str, Any], None, None]:
    ''' Get all clothes

    Args:
        pid (str): Project id.

    Yields:
        Return the data in `pid`.

    '''
    for raw in FormDB().find({'case': 'clothes', 'pid': pid}):
        yield raw

all_drink staticmethod 

all_drink(
    pid: str,
) -> Generator[dict[str, Any], None, None]

Get all drink

Parameters:

Name Type Description Default
pid str

Project id.

 required

Yields:

Type Description
dict[str, Any]

Return the data in pid.
Source code in module/form.py 
354
355
356
357
358
359
360
361
362
363
364
365
366
@staticmethod
def all_drink(pid: str) -> Generator[dict[str, Any], None, None]:
    ''' Get all drink

    Args:
        pid (str): Project id.

    Yields:
        Return the data in `pid`.

    '''
    for raw in FormDB().find({'case': 'drink', 'pid': pid}):
        yield raw

all_parking_card staticmethod 

all_parking_card(
    pid: str,
) -> Generator[dict[str, Any], None, None]

Get all parking card

Parameters:

Name Type Description Default
pid str

Project id.

 required

Yields:

Type Description
dict[str, Any]

Return the data in pid.
Source code in module/form.py 
306
307
308
309
310
311
312
313
314
315
316
317
318
@staticmethod
def all_parking_card(pid: str) -> Generator[dict[str, Any], None, None]:
    ''' Get all parking card

    Args:
        pid (str): Project id.

    Yields:
        Return the data in `pid`.

    '''
    for raw in FormDB().find({'case': 'parking_card', 'pid': pid}):
        yield raw

all_traffic_fee staticmethod 

all_traffic_fee(
    pid: str,
) -> Generator[dict[str, Any], None, None]

Get All traffic_fee

Parameters:

Name Type Description Default
pid str

Project id.

 required

Yields:

Type Description
dict[str, Any]

Return the data in pid.
Source code in module/form.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
@staticmethod
def all_traffic_fee(pid: str) -> Generator[dict[str, Any], None, None]:
    ''' Get All traffic_fee

    Args:
        pid (str): Project id.

    Yields:
        Return the data in `pid`.

    '''
    for raw in FormDB().find({'case': 'traffic_fee', 'pid': pid}):
        yield raw

all_volunteer_certificate staticmethod 

all_volunteer_certificate(
    pid: str,
) -> Generator[dict[str, Any], None, None]

Get All volunteer certificate

Parameters:

Name Type Description Default
pid str

Project id.

 required

Yields:

Type Description
dict[str, Any]

Return the data in pid.
Source code in module/form.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
@staticmethod
def all_volunteer_certificate(pid: str) -> Generator[dict[str, Any], None, None]:
    ''' Get All volunteer certificate

    Args:
        pid (str): Project id.

    Yields:
        Return the data in `pid`.

    '''
    for raw in FormDB().find({'case': 'volunteer_certificate', 'pid': pid}):
        yield raw

get_accommodation staticmethod 

get_accommodation(
    pid: str, uid: str
) -> Optional[dict[str, Any]]

Get accommodation

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required

Returns:

Type Description
Optional[dict[str, Any]]

The data or None.
Source code in module/form.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
@staticmethod
def get_accommodation(pid: str, uid: str) -> Optional[dict[str, Any]]:
    ''' Get accommodation

    Args:
        pid (str): Project id.
        uid (str): User id.

    Returns:
        The data or `None`.

    '''
    return FormDB().find_one({'case': 'accommodation', 'pid': pid, 'uid': uid})

get_appreciation staticmethod 

get_appreciation(
    pid: str, uid: str
) -> Optional[dict[str, Any]]

Get appreciation

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required

Returns:

Type Description
Optional[dict[str, Any]]

The data or None.
Source code in module/form.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
@staticmethod
def get_appreciation(pid: str, uid: str) -> Optional[dict[str, Any]]:
    ''' Get appreciation

    Args:
        pid (str): Project id.
        uid (str): User id.

    Returns:
        The data or `None`.

    '''
    return FormDB().find_one({'case': 'appreciation', 'pid': pid, 'uid': uid})

get_clothes staticmethod 

get_clothes(pid: str, uid: str) -> Optional[dict[str, Any]]

Get clothes

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required

Returns:

Type Description
Optional[dict[str, Any]]

The data or None.
Source code in module/form.py 
242
243
244
245
246
247
248
249
250
251
252
253
254
@staticmethod
def get_clothes(pid: str, uid: str) -> Optional[dict[str, Any]]:
    ''' Get clothes

    Args:
        pid (str): Project id.
        uid (str): User id.

    Returns:
        The data or `None`.

    '''
    return FormDB().find_one({'case': 'clothes', 'pid': pid, 'uid': uid})

get_drink staticmethod 

get_drink(pid: str, uid: str) -> Optional[dict[str, Any]]

Get drink

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required

Returns:

Type Description
Optional[dict[str, Any]]

The data or None.
Source code in module/form.py 
340
341
342
343
344
345
346
347
348
349
350
351
352
@staticmethod
def get_drink(pid: str, uid: str) -> Optional[dict[str, Any]]:
    ''' Get drink

    Args:
        pid (str): Project id.
        uid (str): User id.

    Returns:
        The data or `None`.

    '''
    return FormDB().find_one({'case': 'drink', 'pid': pid, 'uid': uid})

get_parking_card staticmethod 

get_parking_card(
    pid: str, uid: str
) -> Optional[dict[str, Any]]

Get parking card

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required

Returns:

Type Description
Optional[dict[str, Any]]

The data or None.
Source code in module/form.py 
292
293
294
295
296
297
298
299
300
301
302
303
304
@staticmethod
def get_parking_card(pid: str, uid: str) -> Optional[dict[str, Any]]:
    ''' Get parking card

    Args:
        pid (str): Project id.
        uid (str): User id.

    Returns:
        The data or `None`.

    '''
    return FormDB().find_one({'case': 'parking_card', 'pid': pid, 'uid': uid})

get_traffic_fee staticmethod 

get_traffic_fee(
    pid: str, uid: str
) -> Optional[dict[str, Any]]

Get traffic fee

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required

Returns:

Type Description
Optional[dict[str, Any]]

The data or None.
Source code in module/form.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
@staticmethod
def get_traffic_fee(pid: str, uid: str) -> Optional[dict[str, Any]]:
    ''' Get traffic fee

    Args:
        pid (str): Project id.
        uid (str): User id.

    Returns:
        The data or `None`.

    '''
    return FormDB().find_one({'case': 'traffic_fee', 'pid': pid, 'uid': uid})

get_volunteer_certificate staticmethod 

get_volunteer_certificate(
    pid: str, uid: str
) -> Optional[dict[str, Any]]

Get volunteer certificate

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required

Returns:

Type Description
Optional[dict[str, Any]]

The data or None.
Source code in module/form.py 
86
87
88
89
90
91
92
93
94
95
96
97
98
@staticmethod
def get_volunteer_certificate(pid: str, uid: str) -> Optional[dict[str, Any]]:
    ''' Get volunteer certificate

    Args:
        pid (str): Project id.
        uid (str): User id.

    Returns:
        The data or `None`.

    '''
    return FormDB().find_one({'case': 'volunteer_certificate', 'pid': pid, 'uid': uid})

update_accommodation staticmethod 

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

Update accommodation

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
data dict

The data to update.

  • key: In one of yes-longtraffic, yes, no.
  • status: bool.
  • room: Optional. The room numbers.
  • room_key: Optional. The key for exchange the place for some users want live together.
  • mixed: (bool) accepted in mixed room.
 required

Returns:

Type Description
dict[str, Any]

Return the added data.
See Also

The more about how to use the room_key to exchange the room, please move to module.form.FormAccommodation.

TODO

Need refactor in pydantic.

Source code in module/form.py 
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
@staticmethod
def update_accommodation(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Update accommodation

    Args:
        pid (str): Project id.
        uid (str): User id.
        data (dict): The data to update.

            - `key`: In one of `yes-longtraffic`, `yes`, `no`.
            - `status`: `bool`.
            - `room`: Optional. The room numbers.
            - `room_key`: Optional. The key for exchange the place for
                          some users want live together.
            - `mixed`: (bool) accepted in mixed room.

    Returns:
        Return the added data.

    See Also:
        The more about how to use the `room_key` to exchange the `room`,
            please move to [module.form.FormAccommodation][].

    TODO:
        Need refactor in pydantic.

    '''
    return FormDB().add_by_case(case='accommodation', pid=pid, uid=uid, data=data)

update_appreciation staticmethod 

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

Update appreciation

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
data dict

The data to update.

  • available: bool.
  • key: In one of oauth, badge_name, real_name.
  • value: As user name.
 required

Returns:

Type Description
dict[str, Any]

Return the added data.
TODO

Need refactor in pydantic.

Source code in module/form.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@staticmethod
def update_appreciation(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Update appreciation

    Args:
        pid (str): Project id.
        uid (str): User id.
        data (dict): The data to update.

            - `available`: `bool`.
            - `key`: In one of `oauth`, `badge_name`, `real_name`.
            - `value`: As user name.

    Returns:
        Return the added data.

    TODO:
        Need refactor in pydantic.

    '''
    return FormDB().add_by_case(case='appreciation', pid=pid, uid=uid, data=data)

update_clothes staticmethod 

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

Update clothes

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
data dict

The data to update.

  • clothes: S / 38.5 / 55 ...
 required

Returns:

Type Description
dict[str, Any]

Return the added data.
TODO

Need refactor in pydantic.

Source code in module/form.py 
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
@staticmethod
def update_clothes(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Update clothes

    Args:
        pid (str): Project id.
        uid (str): User id.
        data (dict): The data to update.

            - `clothes`: `S / 38.5 / 55` ...

    Returns:
        Return the added data.

    TODO:
        Need refactor in pydantic.

    '''
    return FormDB().add_by_case(case='clothes', pid=pid, uid=uid, data=data)

update_drink staticmethod 

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

Update drink

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
data dict

The data to update.

  • y18: bool.
 required

Returns:

Type Description
dict[str, Any]

Return the added data.
TODO

Need refactor in pydantic.

Source code in module/form.py 
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
@staticmethod
def update_drink(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Update drink

    Args:
        pid (str): Project id.
        uid (str): User id.
        data (dict): The data to update.

            - `y18`: `bool`.

    Returns:
        Return the added data.

    TODO:
        Need refactor in pydantic.

    '''
    return FormDB().add_by_case(case='drink', pid=pid, uid=uid, data=data)

update_parking_card staticmethod 

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

Update parking card

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
data dict

The data to update.

  • carno: The license plate.
  • dates: List of dates. The dates options are from the collection of db.project.parking_card.
 required

Returns:

Type Description
dict[str, Any]

Return the added data.
TODO

Need refactor in pydantic.

Source code in module/form.py 
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
@staticmethod
def update_parking_card(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Update parking card

    Args:
        pid (str): Project id.
        uid (str): User id.
        data (dict): The data to update.

            - `carno`: The license plate.
            - `dates`: List of dates. The dates options are from
                       the collection of `db.project.parking_card`.

    Returns:
        Return the added data.

    TODO:
        Need refactor in pydantic.

    '''
    return FormDB().add_by_case(case='parking_card', pid=pid, uid=uid, data=data)

update_traffic_fee staticmethod 

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

Update traffic fee

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
data dict

The data to update.

  • apply: bool.
  • fee: int.
  • fromwhere: str.
  • howto: str.
 required

Returns:

Type Description
dict[str, Any]

Return the added data.
TODO

Need refactor in pydantic.

Source code in module/form.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
@staticmethod
def update_traffic_fee(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Update traffic fee

    Args:
        pid (str): Project id.
        uid (str): User id.
        data (dict): The data to update.

            - `apply`: `bool`.
            - `fee`: `int`.
            - `fromwhere`: `str`.
            - `howto`: `str`.

    Returns:
        Return the added data.

    TODO:
        Need refactor in pydantic.

    '''
    return FormDB().add_by_case(case='traffic_fee', pid=pid, uid=uid, data=data)

update_volunteer_certificate staticmethod 

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

Update volunteer certificate

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
data dict

The data to update.

  • value: bool.
 required

Returns:

Type Description
dict[str, Any]

Return the added data.
TODO

Need refactor in pydantic.

Source code in module/form.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
@staticmethod
def update_volunteer_certificate(pid: str, uid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Update volunteer certificate

    Args:
        pid (str): Project id.
        uid (str): User id.
        data (dict): The data to update.

            - `value`: `bool`.

    Returns:
        Return the added data.

    TODO:
        Need refactor in pydantic.

    '''
    return FormDB().add_by_case(case='volunteer_certificate', pid=pid, uid=uid, data=data)

FormAccommodation

FormAccommodation object

Source code in module/form.py 
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
class FormAccommodation:
    ''' FormAccommodation object '''
    @staticmethod
    def get(pid: str) -> Generator[dict[str, Any], None, None]:
        ''' Get data, and in `yes-longtraffic`, `yes`.

        Args:
            pid (str): Project id.

        Yields:
            Return the data in `pid`.

        '''
        for raw in FormDB().find({'case': 'accommodation', 'pid': pid, 'data.key': {'$ne': 'no'}}):
            yield raw

    @staticmethod
    def update_room(pid: str, uid: str, room: str, change_key: bool = True) -> dict[str, Any]:
        ''' Update room no

        Update will happend in `room`

        - Not the same with `room`.
        - Not yet have the `room`.

        Args:
            pid (str): Project id.
            uid (str): User id.
            room (str): Room numbers.
            change_key (bool): To generate a new `room_key`.

        '''
        _update = {'data.room': room}
        if change_key:
            _update['data.room_key'] = f'{uuid4().fields[0]:08x}'

        _query: dict[str, Any]
        _query = {'case': 'accommodation', 'pid': pid, 'uid': uid}
        _query['$or'] = [{'data.room': {'$ne': room}},
                         {'data.room': {'$exists': False}}]

        return FormDB().find_one_and_update(
            _query, {'$set': _update},
            return_document=ReturnDocument.AFTER,
        )

    @staticmethod
    def update_room_key(pid: str, uids: Iterable[str]) -> None:
        ''' update / regenerate the room key

        Args:
            pid (str): Project id.
            uids (list): User ids.

        '''
        for uid in uids:
            FormDB().find_one_and_update(
                {'case': 'accommodation', 'pid': pid, 'uid': uid}, {
                    '$set': {'data.room_key': f'{uuid4().fields[0]:08x}'}},
            )

    @staticmethod
    def get_room_mate(pid: str, uid: str) -> \
            tuple[Optional[dict[str, Any]], Optional[dict[str, Any]]]:
        ''' Get room mate

        Args:
            pid (str): Project id.
            uid (str): User id.

        Returns:
            (`user_room`, `mate`)

                - `user_room`: User's room info.
                - `mate`: User's room mate info.

        '''
        user_room = FormDB().find_one(
            {'case': 'accommodation', 'pid': pid, 'uid': uid})
        mate = None
        if user_room and 'room' in user_room['data'] and user_room['data']['room']:
            mate = FormDB().find_one(
                {'case': 'accommodation', 'pid': pid,
                 'uid': {'$ne': uid}, 'data.room': user_room['data']['room']})

        return (user_room, mate)

    @classmethod
    def make_exchange(cls, pid: str, uid: str, exkey: str) -> str:
        ''' make exchange

        Args:
            pid (str): Project id.
            uid (str): User id.
            exkey (str): Exchange key.

        '''
        data = FormDB().find_one_and_update(
            {'case': 'accommodation', 'pid': pid, 'uid': uid},
            {'$set': {'data.room_exkey': exkey}},
            return_document=ReturnDocument.AFTER,
        )

        ex_mate = FormDB().find_one(
            {'case': 'accommodation', 'pid': pid, 'data.room_exkey': data['data']['room_key']})
        if not ex_mate:
            logging.info('等待交換中 `%s`', exkey)
            return '等待交換中'

        # do exchange
        new_room = 'R-'+f'{uuid4().fields[0]:04x}'

        FormDB().update_many(
            {'case': 'accommodation', 'pid': pid,
                'uid': {'$in': (uid, ex_mate['uid'])}},
            {'$set': {'data.room': new_room}, '$unset': {'data.room_exkey': 1}},
        )

        cls.update_room_key(pid=pid, uids=(uid, ex_mate['uid']))

        logging.info('已交換 %s %s %s', new_room, uid, ex_mate['uid'])

        old_mates = list(FormDB().find(
            {'case': 'accommodation', 'pid': pid,
             'data.room': {'$in': (data['data']['room'], ex_mate['data']['room'])}}))

        logging.info('old_mates: %s', ', '.join(
            [mate['uid'] for mate in old_mates]))

        if len(old_mates) < 2:
            return '交換完畢'

        uids = [mate['uid'] for mate in old_mates]
        user_infos = User.get_info(uids=uids, need_sensitive=True)
        if user_infos[uids[0]]['profile_real']['roc_id'][1] != user_infos[
                uids[1]]['profile_real']['roc_id'][1]:
            logging.info('old_mates 性別不同，不交換。')
            return '交換完畢'

        new_room = 'R-'+f'{uuid4().fields[0]:04x}'

        FormDB().update_many(
            {'case': 'accommodation', 'pid': pid, 'uid': {'$in': uids}},
            {'$set': {'data.room': new_room}, '$unset': {'data.room_exkey': 1}},
        )

        cls.update_room_key(pid=pid, uids=uids)

        logging.info('old_mates new rooms: %s, %s', new_room, ', '.join(uids))

        return '交換完畢'

get staticmethod 

get(pid: str) -> Generator[dict[str, Any], None, None]

Get data, and in yes-longtraffic, yes.

Parameters:

Name Type Description Default
pid str

Project id.

 required

Yields:

Type Description
dict[str, Any]

Return the data in pid.
Source code in module/form.py 
426
427
428
429
430
431
432
433
434
435
436
437
438
@staticmethod
def get(pid: str) -> Generator[dict[str, Any], None, None]:
    ''' Get data, and in `yes-longtraffic`, `yes`.

    Args:
        pid (str): Project id.

    Yields:
        Return the data in `pid`.

    '''
    for raw in FormDB().find({'case': 'accommodation', 'pid': pid, 'data.key': {'$ne': 'no'}}):
        yield raw

get_room_mate staticmethod 

get_room_mate(
    pid: str, uid: str
) -> tuple[
    Optional[dict[str, Any]], Optional[dict[str, Any]]
]

Get room mate

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required

Returns:

Type Description
tuple[Optional[dict[str, Any]], Optional[dict[str, Any]]]

(user_room, mate)

  • user_room: User's room info.
  • mate: User's room mate info.
Source code in module/form.py 
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
@staticmethod
def get_room_mate(pid: str, uid: str) -> \
        tuple[Optional[dict[str, Any]], Optional[dict[str, Any]]]:
    ''' Get room mate

    Args:
        pid (str): Project id.
        uid (str): User id.

    Returns:
        (`user_room`, `mate`)

            - `user_room`: User's room info.
            - `mate`: User's room mate info.

    '''
    user_room = FormDB().find_one(
        {'case': 'accommodation', 'pid': pid, 'uid': uid})
    mate = None
    if user_room and 'room' in user_room['data'] and user_room['data']['room']:
        mate = FormDB().find_one(
            {'case': 'accommodation', 'pid': pid,
             'uid': {'$ne': uid}, 'data.room': user_room['data']['room']})

    return (user_room, mate)

make_exchange classmethod 

make_exchange(pid: str, uid: str, exkey: str) -> str

make exchange

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
exkey str

Exchange key.

 required
Source code in module/form.py 
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
@classmethod
def make_exchange(cls, pid: str, uid: str, exkey: str) -> str:
    ''' make exchange

    Args:
        pid (str): Project id.
        uid (str): User id.
        exkey (str): Exchange key.

    '''
    data = FormDB().find_one_and_update(
        {'case': 'accommodation', 'pid': pid, 'uid': uid},
        {'$set': {'data.room_exkey': exkey}},
        return_document=ReturnDocument.AFTER,
    )

    ex_mate = FormDB().find_one(
        {'case': 'accommodation', 'pid': pid, 'data.room_exkey': data['data']['room_key']})
    if not ex_mate:
        logging.info('等待交換中 `%s`', exkey)
        return '等待交換中'

    # do exchange
    new_room = 'R-'+f'{uuid4().fields[0]:04x}'

    FormDB().update_many(
        {'case': 'accommodation', 'pid': pid,
            'uid': {'$in': (uid, ex_mate['uid'])}},
        {'$set': {'data.room': new_room}, '$unset': {'data.room_exkey': 1}},
    )

    cls.update_room_key(pid=pid, uids=(uid, ex_mate['uid']))

    logging.info('已交換 %s %s %s', new_room, uid, ex_mate['uid'])

    old_mates = list(FormDB().find(
        {'case': 'accommodation', 'pid': pid,
         'data.room': {'$in': (data['data']['room'], ex_mate['data']['room'])}}))

    logging.info('old_mates: %s', ', '.join(
        [mate['uid'] for mate in old_mates]))

    if len(old_mates) < 2:
        return '交換完畢'

    uids = [mate['uid'] for mate in old_mates]
    user_infos = User.get_info(uids=uids, need_sensitive=True)
    if user_infos[uids[0]]['profile_real']['roc_id'][1] != user_infos[
            uids[1]]['profile_real']['roc_id'][1]:
        logging.info('old_mates 性別不同，不交換。')
        return '交換完畢'

    new_room = 'R-'+f'{uuid4().fields[0]:04x}'

    FormDB().update_many(
        {'case': 'accommodation', 'pid': pid, 'uid': {'$in': uids}},
        {'$set': {'data.room': new_room}, '$unset': {'data.room_exkey': 1}},
    )

    cls.update_room_key(pid=pid, uids=uids)

    logging.info('old_mates new rooms: %s, %s', new_room, ', '.join(uids))

    return '交換完畢'

update_room staticmethod 

update_room(
    pid: str, uid: str, room: str, change_key: bool = True
) -> dict[str, Any]

Update room no

Update will happend in room

  • Not the same with room.
  • Not yet have the room.

Parameters:

Name Type Description Default
pid str

Project id.

 required
uid str

User id.

 required
room str

Room numbers.

 required
change_key bool

To generate a new room_key.

 True
Source code in module/form.py 
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
@staticmethod
def update_room(pid: str, uid: str, room: str, change_key: bool = True) -> dict[str, Any]:
    ''' Update room no

    Update will happend in `room`

    - Not the same with `room`.
    - Not yet have the `room`.

    Args:
        pid (str): Project id.
        uid (str): User id.
        room (str): Room numbers.
        change_key (bool): To generate a new `room_key`.

    '''
    _update = {'data.room': room}
    if change_key:
        _update['data.room_key'] = f'{uuid4().fields[0]:08x}'

    _query: dict[str, Any]
    _query = {'case': 'accommodation', 'pid': pid, 'uid': uid}
    _query['$or'] = [{'data.room': {'$ne': room}},
                     {'data.room': {'$exists': False}}]

    return FormDB().find_one_and_update(
        _query, {'$set': _update},
        return_document=ReturnDocument.AFTER,
    )

update_room_key staticmethod 

update_room_key(pid: str, uids: Iterable[str]) -> None

update / regenerate the room key

Parameters:

Name Type Description Default
pid str

Project id.

 required
uids list

User ids.

 required
Source code in module/form.py 
470
471
472
473
474
475
476
477
478
479
480
481
482
483
@staticmethod
def update_room_key(pid: str, uids: Iterable[str]) -> None:
    ''' update / regenerate the room key

    Args:
        pid (str): Project id.
        uids (list): User ids.

    '''
    for uid in uids:
        FormDB().find_one_and_update(
            {'case': 'accommodation', 'pid': pid, 'uid': uid}, {
                '$set': {'data.room_key': f'{uuid4().fields[0]:08x}'}},
        )

FormTrafficFeeMapping

FormTrafficFeeMapping object

Source code in module/form.py 
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
class FormTrafficFeeMapping:
    ''' FormTrafficFeeMapping object '''

    @staticmethod
    def save(pid: str, datas: list[ProjectTrafficLocationFeeItem]) -> list[
            ProjectTrafficLocationFeeItem]:
        ''' Save mapping data

        :param str pid: pid
        :param dict data: location/fee mapping

        Args:
            pid (str): Project id.
            datas (list): location/fee mapping datas.

        Returns:
            Return the saved data.

        '''
        _data = {}
        for item in datas:
            _data[item.location] = item.fee

        result = []
        saved = FormTrafficFeeMappingDB().save(pid=pid, data=_data)
        for location, fee in saved['data'].items():
            result.append(ProjectTrafficLocationFeeItem.parse_obj({
                'location': location, 'fee': fee}))

        return result

    @staticmethod
    def get(pid: str) -> list[ProjectTrafficLocationFeeItem]:
        ''' Get

        :param str pid: pid

        Args:
            pid (str): Project id.

        Returns:
            The data or `None`.

        '''
        result = []
        datas = FormTrafficFeeMappingDB().find_one({'_id': pid})
        if datas and 'data' in datas:
            for location, fee in datas['data'].items():
                result.append(ProjectTrafficLocationFeeItem.parse_obj({
                    'location': location,
                    'fee': fee,
                }))
        return result

get staticmethod 

get(pid: str) -> list[ProjectTrafficLocationFeeItem]

Get

:param str pid: pid

Parameters:

Name Type Description Default
pid str

Project id.

 required

Returns:

Type Description
list[ProjectTrafficLocationFeeItem]

The data or None.
Source code in module/form.py 
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
@staticmethod
def get(pid: str) -> list[ProjectTrafficLocationFeeItem]:
    ''' Get

    :param str pid: pid

    Args:
        pid (str): Project id.

    Returns:
        The data or `None`.

    '''
    result = []
    datas = FormTrafficFeeMappingDB().find_one({'_id': pid})
    if datas and 'data' in datas:
        for location, fee in datas['data'].items():
            result.append(ProjectTrafficLocationFeeItem.parse_obj({
                'location': location,
                'fee': fee,
            }))
    return result

save staticmethod 

save(
    pid: str, datas: list[ProjectTrafficLocationFeeItem]
) -> list[ProjectTrafficLocationFeeItem]

Save mapping data

:param str pid: pid :param dict data: location/fee mapping

Parameters:

Name Type Description Default
pid str

Project id.

 required
datas list

location/fee mapping datas.

 required

Returns:

Type Description
list[ProjectTrafficLocationFeeItem]

Return the saved data.
Source code in module/form.py 
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
@staticmethod
def save(pid: str, datas: list[ProjectTrafficLocationFeeItem]) -> list[
        ProjectTrafficLocationFeeItem]:
    ''' Save mapping data

    :param str pid: pid
    :param dict data: location/fee mapping

    Args:
        pid (str): Project id.
        datas (list): location/fee mapping datas.

    Returns:
        Return the saved data.

    '''
    _data = {}
    for item in datas:
        _data[item.location] = item.fee

    result = []
    saved = FormTrafficFeeMappingDB().save(pid=pid, data=_data)
    for location, fee in saved['data'].items():
        result.append(ProjectTrafficLocationFeeItem.parse_obj({
            'location': location, 'fee': fee}))

    return result