module/budget.py¶

module.budget ¶

Budget

Action ¶

Bases: Enum

Action

Attributes:

Name	Type	Description
`ADD`	`str`	`add`
`UPDATE`	`str`	`update`

Source code in module/budget.py

class Action(Enum):
    ''' Action

    Attributes:
        ADD (str): `add`
        UPDATE (str): `update`

    '''
    ADD = 'add'
    UPDATE = 'update'

Budget ¶

Budget class

Source code in module/budget.py

class Budget:
    ''' Budget class '''

    @staticmethod
    def is_admin(pid: str, uid: str) -> bool:
        ''' check user is admin

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

        Returns:
            What cases will return `true`:

                - Project owner
                - Finace team chiefs and members
                - coordinator chiefs

        '''
        if TeamDB(pid='', tid='').count_documents({
                'pid': pid,
                'tid': {'$in': ['finance', 'coordinator']},
                '$or': [{'chiefs': uid}, {'members': uid}],
        }):
            return True

        if ProjectDB(pid='').count_documents({'_id': pid, 'owners': uid}):
            return True

        return False

    @staticmethod
    def add(pid: str, tid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Add new data

        Args:
            pid (str): Project id.
            tid (str): Team id.
            data (dict): The data to add.

        Returns:
            Return the added data.

        '''
        save = BudgetDB.new(pid=pid, tid=tid, uid=data['uid'])

        for key in save.copy():
            if key in data:
                save[key] = data[key]

        return BudgetDB().add(save)

    @staticmethod
    def edit(pid: str, data: dict[str, Any]) -> dict[str, Any]:
        ''' Edit new data

        Args:
            pid (str): Project id.
            data (dict): The data to edit. Only in those fields
                could be update: `name`, `tid`, `uid`, `bid`, `currency`, `total`,
                `desc`, `estimate`, `enabled`, `paydate`.

        Returns:
            Return the updated data.

        '''
        save: dict[str, Any]
        save = {'pid': pid}

        for key in ('name', 'tid', 'uid', 'bid', 'currency', 'total',
                    'desc', 'estimate', 'enabled', 'paydate'):
            if key in data:
                save[key] = data[key]

        if 'enabled' in save:
            save['enabled'] = bool(save['enabled'])

        return BudgetDB().edit(_id=data['_id'], data=save)

    @staticmethod
    def get(buids: list[str], pid: Optional[str] = None) -> Cursor[dict[str, Any]]:
        ''' Get by buid

        Args:
            buids (list): Budget unique ids.
            pid (str): Project id.

        Returns:
            [pymongo.cursor.Cursor][]

        '''
        query: dict[str, Any]
        query = {'_id': {'$in': buids}}
        if pid is not None:
            query['pid'] = pid

        return BudgetDB().find(query)

    @staticmethod
    def get_by_pid(pid: str) -> Cursor[dict[str, Any]]:
        ''' Get by pid

        Args:
            pid (str): Project id.

        Returns:
            [pymongo.cursor.Cursor][]

        '''
        return BudgetDB().find({'pid': pid}, sort=(('tid', 1), ))

    @staticmethod
    def get_by_tid(pid: str, tid: str, only_enable: bool = False) -> Cursor[dict[str, Any]]:
        ''' Get by pid

        Args:
            pid (str): Project id.
            tid (str): Team id.
            only_enable (bool): Only query the enabled.

        Returns:
            [pymongo.cursor.Cursor][]

        '''
        if not only_enable:
            return BudgetDB().find({'pid': pid, 'tid': tid})

        return BudgetDB().find({'pid': pid, 'tid': tid, 'enabled': True})

    @staticmethod
    def get_by_bid(pid: str, bid: str) -> Optional[dict[str, Any]]:
        ''' Get a item according to the specified ``pid`` and ``bid``.

        Args:
            pid (str): Project id.
            bid (str): Budget id.

        Returns:
            Only return the budget unique id (`_id`).

        '''
        for raw in BudgetDB().find({'pid': pid, 'bid': bid}, {'_id': 1}):
            return raw

        return None

    @staticmethod
    def verify_batch_items(items: list[dict[str, Any]]) -> \
            tuple[list[dict[str, Any]], list[tuple[int, Optional[list[dict[str, Any]]]]]]:
        ''' verify the batch items by [module.budget.BudgetImportItem][].

        Args:
            items (dict): The items may from the front-end datas.

        Returns:
            Return a tuple in (list of `result`, list of `error_resut`)

        '''
        result: list[dict[str, Any]] = []
        error_result: list[tuple[int, Optional[list[dict[str, Any]]]]] = []
        for (serial_no, raw) in enumerate(items):
            try:
                item = BudgetImportItem.parse_obj(raw)
                result.append(item.dict())
            except error_wrappers.ValidationError as error:
                error_infos = [
                    {'loc': error_info['loc'], 'msg': error_info['msg']}
                    for error_info in error.errors()
                ]
                error_result.append((serial_no, error_infos))

        return result, error_result

add `staticmethod` ¶

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

Add new data

Parameters:

Name	Type	Description	Default
`pid`	`str`	Project id.	required
`tid`	`str`	Team id.	required
`data`	`dict`	The data to add.	required

Returns:

Type	Description
`dict[str, Any]`	Return the added data.

Source code in module/budget.py

@staticmethod
def add(pid: str, tid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Add new data

    Args:
        pid (str): Project id.
        tid (str): Team id.
        data (dict): The data to add.

    Returns:
        Return the added data.

    '''
    save = BudgetDB.new(pid=pid, tid=tid, uid=data['uid'])

    for key in save.copy():
        if key in data:
            save[key] = data[key]

    return BudgetDB().add(save)

edit `staticmethod` ¶

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

Edit new data

Parameters:

Name	Type	Description	Default
`pid`	`str`	Project id.	required
`data`	`dict`	The data to edit. Only in those fields could be update: `name`, `tid`, `uid`, `bid`, `currency`, `total`, `desc`, `estimate`, `enabled`, `paydate`.	required

Returns:

Type	Description
`dict[str, Any]`	Return the updated data.

Source code in module/budget.py

@staticmethod
def edit(pid: str, data: dict[str, Any]) -> dict[str, Any]:
    ''' Edit new data

    Args:
        pid (str): Project id.
        data (dict): The data to edit. Only in those fields
            could be update: `name`, `tid`, `uid`, `bid`, `currency`, `total`,
            `desc`, `estimate`, `enabled`, `paydate`.

    Returns:
        Return the updated data.

    '''
    save: dict[str, Any]
    save = {'pid': pid}

    for key in ('name', 'tid', 'uid', 'bid', 'currency', 'total',
                'desc', 'estimate', 'enabled', 'paydate'):
        if key in data:
            save[key] = data[key]

    if 'enabled' in save:
        save['enabled'] = bool(save['enabled'])

    return BudgetDB().edit(_id=data['_id'], data=save)

get `staticmethod` ¶

get(
    buids: list[str], pid: Optional[str] = None
) -> Cursor[dict[str, Any]]

Get by buid

Parameters:

Name	Type	Description	Default
`buids`	`list`	Budget unique ids.	required
`pid`	`str`	Project id.	`None`

Returns:

Type	Description
`Cursor[dict[str, Any]]`	pymongo.cursor.Cursor

Source code in module/budget.py

@staticmethod
def get(buids: list[str], pid: Optional[str] = None) -> Cursor[dict[str, Any]]:
    ''' Get by buid

    Args:
        buids (list): Budget unique ids.
        pid (str): Project id.

    Returns:
        [pymongo.cursor.Cursor][]

    '''
    query: dict[str, Any]
    query = {'_id': {'$in': buids}}
    if pid is not None:
        query['pid'] = pid

    return BudgetDB().find(query)

get_by_bid `staticmethod` ¶

get_by_bid(pid: str, bid: str) -> Optional[dict[str, Any]]

Get a item according to the specified pid and bid.

Parameters:

Name	Type	Description	Default
`pid`	`str`	Project id.	required
`bid`	`str`	Budget id.	required

Returns:

Type	Description
`Optional[dict[str, Any]]`	Only return the budget unique id (`_id`).

Source code in module/budget.py

@staticmethod
def get_by_bid(pid: str, bid: str) -> Optional[dict[str, Any]]:
    ''' Get a item according to the specified ``pid`` and ``bid``.

    Args:
        pid (str): Project id.
        bid (str): Budget id.

    Returns:
        Only return the budget unique id (`_id`).

    '''
    for raw in BudgetDB().find({'pid': pid, 'bid': bid}, {'_id': 1}):
        return raw

    return None

get_by_pid `staticmethod` ¶

get_by_pid(pid: str) -> Cursor[dict[str, Any]]

Get by pid

Parameters:

Name	Type	Description	Default
`pid`	`str`	Project id.	required

Returns:

Type	Description
`Cursor[dict[str, Any]]`	pymongo.cursor.Cursor

Source code in module/budget.py

@staticmethod
def get_by_pid(pid: str) -> Cursor[dict[str, Any]]:
    ''' Get by pid

    Args:
        pid (str): Project id.

    Returns:
        [pymongo.cursor.Cursor][]

    '''
    return BudgetDB().find({'pid': pid}, sort=(('tid', 1), ))

get_by_tid `staticmethod` ¶

get_by_tid(
    pid: str, tid: str, only_enable: bool = False
) -> Cursor[dict[str, Any]]

Get by pid

Parameters:

Name	Type	Description	Default
`pid`	`str`	Project id.	required
`tid`	`str`	Team id.	required
`only_enable`	`bool`	Only query the enabled.	`False`

Returns:

Type	Description
`Cursor[dict[str, Any]]`	pymongo.cursor.Cursor

Source code in module/budget.py

@staticmethod
def get_by_tid(pid: str, tid: str, only_enable: bool = False) -> Cursor[dict[str, Any]]:
    ''' Get by pid

    Args:
        pid (str): Project id.
        tid (str): Team id.
        only_enable (bool): Only query the enabled.

    Returns:
        [pymongo.cursor.Cursor][]

    '''
    if not only_enable:
        return BudgetDB().find({'pid': pid, 'tid': tid})

    return BudgetDB().find({'pid': pid, 'tid': tid, 'enabled': True})

is_admin `staticmethod` ¶

is_admin(pid: str, uid: str) -> bool

check user is admin

Parameters:

Name	Type	Description	Default
`pid`	`str`	Project id.	required
`uid`	`str`	User id.	required

Returns:

Type	Description
`bool`	What cases will return `true`: Project owner Finace team chiefs and members coordinator chiefs

Source code in module/budget.py

@staticmethod
def is_admin(pid: str, uid: str) -> bool:
    ''' check user is admin

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

    Returns:
        What cases will return `true`:

            - Project owner
            - Finace team chiefs and members
            - coordinator chiefs

    '''
    if TeamDB(pid='', tid='').count_documents({
            'pid': pid,
            'tid': {'$in': ['finance', 'coordinator']},
            '$or': [{'chiefs': uid}, {'members': uid}],
    }):
        return True

    if ProjectDB(pid='').count_documents({'_id': pid, 'owners': uid}):
        return True

    return False

verify_batch_items `staticmethod` ¶

verify_batch_items(
    items: list[dict[str, Any]]
) -> tuple[
    list[dict[str, Any]],
    list[tuple[int, Optional[list[dict[str, Any]]]]],
]

verify the batch items by module.budget.BudgetImportItem.

Parameters:

Name	Type	Description	Default
`items`	`dict`	The items may from the front-end datas.	required

Returns:

Type	Description
`tuple[list[dict[str, Any]], list[tuple[int, Optional[list[dict[str, Any]]]]]]`	Return a tuple in (list of `result`, list of `error_resut`)

Source code in module/budget.py

@staticmethod
def verify_batch_items(items: list[dict[str, Any]]) -> \
        tuple[list[dict[str, Any]], list[tuple[int, Optional[list[dict[str, Any]]]]]]:
    ''' verify the batch items by [module.budget.BudgetImportItem][].

    Args:
        items (dict): The items may from the front-end datas.

    Returns:
        Return a tuple in (list of `result`, list of `error_resut`)

    '''
    result: list[dict[str, Any]] = []
    error_result: list[tuple[int, Optional[list[dict[str, Any]]]]] = []
    for (serial_no, raw) in enumerate(items):
        try:
            item = BudgetImportItem.parse_obj(raw)
            result.append(item.dict())
        except error_wrappers.ValidationError as error:
            error_infos = [
                {'loc': error_info['loc'], 'msg': error_info['msg']}
                for error_info in error.errors()
            ]
            error_result.append((serial_no, error_infos))

    return result, error_result

BudgetImportItem ¶

Bases: BaseModel

Base Item

Attributes:

Name	Type	Description
`action`	`Action`	`匯入行為`
`bid`	`str`	`編號（預算表編號）`
`uid`	`str`	User name, not relate to `uid`. `申請人`
`name`	`str`	The name of budget. `項目名稱`
`desc`	`str`	Description. `項目說明`
`total`	`str \| int \| float`	Total of budget. `核定金額`
`currency`	`Currency`	Currency. `核定貨幣 (ISO4217)`
`paydate`	`str`	`預定支出日期 (YYYY-MM-DD)`
`estimate`	`str`	`估算方式`

Source code in module/budget.py

class BudgetImportItem(BaseModel):
    ''' Base Item

    Attributes:
        action (Action): `匯入行為`
        bid (str): `編號（預算表編號）`
        uid (str): User name, not relate to `uid`. `申請人`
        name (str): The name of budget. `項目名稱`
        desc (str): Description. `項目說明`
        total (str | int | float): Total of budget. `核定金額`
        currency (Currency): Currency. `核定貨幣 (ISO4217)`
        paydate (str): `預定支出日期 (YYYY-MM-DD)`
        estimate (str): `估算方式`

    '''
    # pylint: disable=no-self-argument
    action: Action
    bid: str
    tid: str
    uid: str
    name: str
    desc: str
    total: Union[str, int, float]
    currency: Currency
    paydate: str
    estimate: str

    class Config:  # pylint: disable=too-few-public-methods
        ''' Model config '''
        use_enum_values = True

    @validator('total')
    def verify_total(cls, value: str) -> Union[int, float]:
        ''' verify total.

        If is string, turn to int | float.

        Returns:
            int or float

        '''
        value = re.sub('[^0-9.]', '', value)
        if '.' in value:
            return float(value)

        return int(value)

    @validator('paydate')
    def verify_paydate(cls, value: str, **kwargs: Any) -> str:
        ''' verify paydate

        Check if the type is date format (`YYYY-MM-DD`) or empty string.
            If the strings can not be parsed, the original strings
            will insert into the `desc` at the beginning with `預計付款時間：{paydate}`.

        Returns:
            `''` or `YYYY-MM-DD`

        '''
        if not value:
            return ''

        try:
            date = arrow.get(value)
            return date.format('YYYY-MM-DD')
        except arrow.parser.ParserError:
            kwargs['values']['desc'] = f"預計付款時間：{value}\n{kwargs['values']['desc']}"
            return ''

Config ¶

Model config

Source code in module/budget.py

class Config:  # pylint: disable=too-few-public-methods
    ''' Model config '''
    use_enum_values = True

verify_paydate ¶

verify_paydate(value: str, **kwargs: Any) -> str

verify paydate

Check if the type is date format (YYYY-MM-DD) or empty string. If the strings can not be parsed, the original strings will insert into the desc at the beginning with 預計付款時間：{paydate}.

Returns:

Type	Description
`str`	`''` or `YYYY-MM-DD`

Source code in module/budget.py

@validator('paydate')
def verify_paydate(cls, value: str, **kwargs: Any) -> str:
    ''' verify paydate

    Check if the type is date format (`YYYY-MM-DD`) or empty string.
        If the strings can not be parsed, the original strings
        will insert into the `desc` at the beginning with `預計付款時間：{paydate}`.

    Returns:
        `''` or `YYYY-MM-DD`

    '''
    if not value:
        return ''

    try:
        date = arrow.get(value)
        return date.format('YYYY-MM-DD')
    except arrow.parser.ParserError:
        kwargs['values']['desc'] = f"預計付款時間：{value}\n{kwargs['values']['desc']}"
        return ''

verify_total ¶

verify_total(value: str) -> Union[int, float]

verify total.

If is string, turn to int | float.

Returns:

Type	Description
`Union[int, float]`	int or float

Source code in module/budget.py

@validator('total')
def verify_total(cls, value: str) -> Union[int, float]:
    ''' verify total.

    If is string, turn to int | float.

    Returns:
        int or float

    '''
    value = re.sub('[^0-9.]', '', value)
    if '.' in value:
        return float(value)

    return int(value)

Currency ¶

Bases: Enum

Currency

Format in ISO4217

Attributes:

Name	Type	Description
`TWD`	`str`	TWD
`USD`	`str`	USD

Source code in module/budget.py

class Currency(Enum):
    ''' Currency

    Format in ISO4217

    Attributes:
        TWD (str): TWD
        USD (str): USD

    '''
    TWD = 'TWD'
    USD = 'USD'

module/budget.py¶

module.budget ¶

Action ¶

Budget ¶

add staticmethod ¶

edit staticmethod ¶

get staticmethod ¶

get_by_bid staticmethod ¶

get_by_pid staticmethod ¶

get_by_tid staticmethod ¶

is_admin staticmethod ¶

verify_batch_items staticmethod ¶

BudgetImportItem ¶

Config ¶

verify_paydate ¶

verify_total ¶

Currency ¶

add `staticmethod` ¶

edit `staticmethod` ¶

get `staticmethod` ¶

get_by_bid `staticmethod` ¶

get_by_pid `staticmethod` ¶

get_by_tid `staticmethod` ¶

is_admin `staticmethod` ¶

verify_batch_items `staticmethod` ¶