Skip to content

models/budgetdb.py

models.budgetdb

BudgetDB

BudgetDB

Bases: DBBase

Budget Collection

Source code in models/budgetdb.py 
 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
class BudgetDB(DBBase):
    ''' Budget Collection '''

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

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

        Indexs:
            - `pid`, `tid`
            - `pid`, `bid`

        '''
        self.create_index([('pid', 1), ('tid', 1)])
        self.create_index([('pid', 1), ('bid', 1)])

    @staticmethod
    def new(pid: str, tid: str, uid: str) -> dict[str, Any]:
        ''' Create new

        Struct:

            - ``_id``: Unique budget id.
            - ``pid``: Project id.
            - ``tid``: Team id.
            - ``bid``: This buDget id is from the google spreadsheet
                       by serials in manually.
            - ``name``: Team name.
            - ``uid``: User id.
            - ``currency``: Now only support in `TWD`, `USD`.
            - ``total``: 0.00
            - ``paydate``: `str` In ISO8601 format or `YYYY-MM-DD`.
            - ``desc``: Descrption.
            - ``estimate``: more descriptions in how to estimate the total.
            - ``code``: Random shorter code for reference in batch.
            - ``enabled``: `bool`.
            - ``create_at``: The created date.

        Args:
            pid (str): project id
            tid (str): team id
            uid (str): user id

        Returns:
            Return an base data object in `dict`.

        TODO:
            Need refactor in pydantic.

        '''
        return {
            '_id': f'{uuid4().node:x}',
            'pid': pid,
            'tid': tid,
            'bid': '',
            'name': '',
            'uid': uid,
            'currency': 'TWD',
            'total': 0,
            'paydate': '',
            'desc': '',
            'estimate': '',
            'code': f"B-{''.join(choices(string.ascii_uppercase+string.digits, k=4))}",
            'enabled': True,
            'create_at': datetime.today(),
        }

    def add(self, data: dict[str, Any]) -> dict[str, Any]:
        ''' Add data, using `pid`, `tid`, `_id` as the key to insert / update.

        Args:
            data (dict): the data to insert / update.

        Returns:
            Return the inserted / updated data.

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

    def edit(self, _id: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Edit data, using the `_id` as the key.

        Args:
            _id (str): the budget id.
            data (dict): the data need to update.

        Returns:
            Return the updated data.

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

add 

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

Add data, using pid, tid, _id as the key to insert / update.

Parameters:

Name Type Description Default
data dict

the data to insert / update.

 required

Returns:

Type Description
dict[str, Any]

Return the inserted / updated data.
Source code in models/budgetdb.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def add(self, data: dict[str, Any]) -> dict[str, Any]:
    ''' Add data, using `pid`, `tid`, `_id` as the key to insert / update.

    Args:
        data (dict): the data to insert / update.

    Returns:
        Return the inserted / updated data.

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

edit 

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

Edit data, using the _id as the key.

Parameters:

Name Type Description Default
_id str

the budget id.

 required
data dict

the data need to update.

 required

Returns:

Type Description
dict[str, Any]

Return the updated data.
Source code in models/budgetdb.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def edit(self, _id: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Edit data, using the `_id` as the key.

    Args:
        _id (str): the budget id.
        data (dict): the data need to update.

    Returns:
        Return the updated data.

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

index 

index() -> None

To make collection's index

Indexs
  • pid, tid
  • pid, bid
Source code in models/budgetdb.py 
19
20
21
22
23
24
25
26
27
28
def index(self) -> None:
    ''' To make collection's index

    Indexs:
        - `pid`, `tid`
        - `pid`, `bid`

    '''
    self.create_index([('pid', 1), ('tid', 1)])
    self.create_index([('pid', 1), ('bid', 1)])

new staticmethod 

new(pid: str, tid: str, uid: str) -> dict[str, Any]

Create new

Struct:

- ``_id``: Unique budget id.
- ``pid``: Project id.
- ``tid``: Team id.
- ``bid``: This buDget id is from the google spreadsheet
           by serials in manually.
- ``name``: Team name.
- ``uid``: User id.
- ``currency``: Now only support in `TWD`, `USD`.
- ``total``: 0.00
- ``paydate``: `str` In ISO8601 format or `YYYY-MM-DD`.
- ``desc``: Descrption.
- ``estimate``: more descriptions in how to estimate the total.
- ``code``: Random shorter code for reference in batch.
- ``enabled``: `bool`.
- ``create_at``: The created date.

Parameters:

Name Type Description Default
pid str

project id

 required
tid str

team id

 required
uid str

user id

 required

Returns:

Type Description
dict[str, Any]

Return an base data object in dict.
TODO

Need refactor in pydantic.

Source code in models/budgetdb.py 
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
@staticmethod
def new(pid: str, tid: str, uid: str) -> dict[str, Any]:
    ''' Create new

    Struct:

        - ``_id``: Unique budget id.
        - ``pid``: Project id.
        - ``tid``: Team id.
        - ``bid``: This buDget id is from the google spreadsheet
                   by serials in manually.
        - ``name``: Team name.
        - ``uid``: User id.
        - ``currency``: Now only support in `TWD`, `USD`.
        - ``total``: 0.00
        - ``paydate``: `str` In ISO8601 format or `YYYY-MM-DD`.
        - ``desc``: Descrption.
        - ``estimate``: more descriptions in how to estimate the total.
        - ``code``: Random shorter code for reference in batch.
        - ``enabled``: `bool`.
        - ``create_at``: The created date.

    Args:
        pid (str): project id
        tid (str): team id
        uid (str): user id

    Returns:
        Return an base data object in `dict`.

    TODO:
        Need refactor in pydantic.

    '''
    return {
        '_id': f'{uuid4().node:x}',
        'pid': pid,
        'tid': tid,
        'bid': '',
        'name': '',
        'uid': uid,
        'currency': 'TWD',
        'total': 0,
        'paydate': '',
        'desc': '',
        'estimate': '',
        'code': f"B-{''.join(choices(string.ascii_uppercase+string.digits, k=4))}",
        'enabled': True,
        'create_at': datetime.today(),
    }