summaryrefslogtreecommitdiff
path: root/finance/flow.py
blob: fb282285a0f79319182866bf949cef9da04a4d30 (plain)
1
2
3
4
5
6
7
8
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
import dataclasses
from datetime import datetime
from decimal import Decimal


@dataclasses.dataclass(kw_only=True, frozen=True)
class Flow:
    """Time-discrete flow of money paid on the first day of a month"""

    amount: Decimal

    def integrate(self, start: datetime, end: datetime) -> Decimal:
        """Integrate the flow between two dates to an amount of money"""

        retval = Decimal(0.0)

        current = datetime(start.year, start.month, 1)

        if start == current:
            retval += self.amount

        while True:
            if current.month == 12:
                current = datetime(current.year + 1, 1, 1)
            else:
                current = datetime(current.year, current.month + 1, 1)

            if current <= end:
                retval += self.amount
            else:
                break

        return retval