180 lines
6.2 KiB
Python
180 lines
6.2 KiB
Python
# The Mia! Accounting Flask Project.
|
|
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/4
|
|
|
|
# Copyright (c) 2023 imacat.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""The period choosers.
|
|
|
|
This file is largely taken from the NanoParma ERP project, first written in
|
|
2021/9/16 by imacat (imacat@nanoparma.com).
|
|
|
|
"""
|
|
from abc import ABC, abstractmethod
|
|
from datetime import date
|
|
|
|
from accounting.models import Currency, Account, Transaction
|
|
from accounting.report.income_expense_account import IncomeExpensesAccount
|
|
from accounting.report.period import YearPeriod, Period, ThisMonth, \
|
|
LastMonth, SinceLastMonth, ThisYear, LastYear, Today, Yesterday, \
|
|
TemplatePeriod
|
|
from .urls import journal_url, ledger_url, income_expenses_url, \
|
|
trial_balance_url, income_statement_url, balance_sheet_url
|
|
|
|
|
|
class PeriodChooser(ABC):
|
|
"""The period chooser."""
|
|
|
|
def __init__(self):
|
|
"""Constructs a period chooser."""
|
|
|
|
# Shortcut periods
|
|
self.this_month_url: str = self._url_for(ThisMonth())
|
|
"""The URL for this month."""
|
|
self.last_month_url: str = self._url_for(LastMonth())
|
|
"""The URL for last month."""
|
|
self.since_last_month_url: str = self._url_for(SinceLastMonth())
|
|
"""The URL since last mint."""
|
|
self.this_year_url: str = self._url_for(ThisYear())
|
|
"""The URL for this year."""
|
|
self.last_year_url: str = self._url_for(LastYear())
|
|
"""The URL for last year."""
|
|
self.today_url: str = self._url_for(Today())
|
|
"""The URL for today."""
|
|
self.yesterday_url: str = self._url_for(Yesterday())
|
|
"""The URL for yesterday."""
|
|
self.all_url: str = self._url_for(Period(None, None))
|
|
"""The URL for all period."""
|
|
self.url_template: str = self._url_for(TemplatePeriod())
|
|
"""The URL template."""
|
|
|
|
first: Transaction | None \
|
|
= Transaction.query.order_by(Transaction.date).first()
|
|
start: date | None = None if first is None else first.date
|
|
|
|
# Attributes
|
|
self.data_start: date | None = start
|
|
"""The start of the data."""
|
|
self.has_data: bool = start is not None
|
|
"""Whether there is any data."""
|
|
self.has_last_month: bool = False
|
|
"""Where there is data in last month."""
|
|
self.has_last_year: bool = False
|
|
"""Whether there is data in last year."""
|
|
self.has_yesterday: bool = False
|
|
"""Whether there is data in yesterday."""
|
|
self.available_years: list[int] = []
|
|
"""The available years."""
|
|
|
|
if self.has_data is not None:
|
|
today: date = date.today()
|
|
self.has_last_month = start < date(today.year, today.month, 1)
|
|
self.has_last_year = start.year < today.year
|
|
self.has_yesterday = start < today
|
|
if start.year < today.year - 1:
|
|
self.available_years \
|
|
= reversed(range(start.year, today.year - 1))
|
|
|
|
@abstractmethod
|
|
def _url_for(self, period: Period) -> str:
|
|
"""Returns the URL for a period.
|
|
|
|
:param period: The period.
|
|
:return: The URL for the period.
|
|
"""
|
|
pass
|
|
|
|
def year_url(self, year: int) -> str:
|
|
"""Returns the period URL of a year.
|
|
|
|
:param year: The year
|
|
:return: The period URL of the year.
|
|
"""
|
|
return self._url_for(YearPeriod(year))
|
|
|
|
|
|
class JournalPeriodChooser(PeriodChooser):
|
|
"""The journal period chooser."""
|
|
|
|
def _url_for(self, period: Period) -> str:
|
|
return journal_url(period)
|
|
|
|
|
|
class LedgerPeriodChooser(PeriodChooser):
|
|
"""The ledger period chooser."""
|
|
|
|
def __init__(self, currency: Currency, account: Account):
|
|
"""Constructs the ledger period chooser."""
|
|
self.currency: Currency = currency
|
|
"""The currency."""
|
|
self.account: Account = account
|
|
"""The account."""
|
|
super().__init__()
|
|
|
|
def _url_for(self, period: Period) -> str:
|
|
return ledger_url(self.currency, self.account, period)
|
|
|
|
|
|
class IncomeExpensesPeriodChooser(PeriodChooser):
|
|
"""The income and expenses log period chooser."""
|
|
|
|
def __init__(self, currency: Currency, account: IncomeExpensesAccount):
|
|
"""Constructs the income and expenses log period chooser."""
|
|
self.currency: Currency = currency
|
|
"""The currency."""
|
|
self.account: IncomeExpensesAccount = account
|
|
"""The account."""
|
|
super().__init__()
|
|
|
|
def _url_for(self, period: Period) -> str:
|
|
return income_expenses_url(self.currency, self.account, period)
|
|
|
|
|
|
class TrialBalancePeriodChooser(PeriodChooser):
|
|
"""The trial balance period chooser."""
|
|
|
|
def __init__(self, currency: Currency):
|
|
"""Constructs the trial balance period chooser."""
|
|
self.currency: Currency = currency
|
|
"""The currency."""
|
|
super().__init__()
|
|
|
|
def _url_for(self, period: Period) -> str:
|
|
return trial_balance_url(self.currency, period)
|
|
|
|
|
|
class IncomeStatementPeriodChooser(PeriodChooser):
|
|
"""The income statement period chooser."""
|
|
|
|
def __init__(self, currency: Currency):
|
|
"""Constructs the income statement period chooser."""
|
|
self.currency: Currency = currency
|
|
"""The currency."""
|
|
super().__init__()
|
|
|
|
def _url_for(self, period: Period) -> str:
|
|
return income_statement_url(self.currency, period)
|
|
|
|
|
|
class BalanceSheetPeriodChooser(PeriodChooser):
|
|
"""The balance sheet period chooser."""
|
|
|
|
def __init__(self, currency: Currency):
|
|
"""Constructs the balance sheet period chooser."""
|
|
self.currency: Currency = currency
|
|
"""The currency."""
|
|
super().__init__()
|
|
|
|
def _url_for(self, period: Period) -> str:
|
|
return balance_sheet_url(self.currency, period)
|