imacat/mia-accounting
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 41 Wiki Activity

Revised the documentation of the EntryCollector class in the ledger and income and expenses log.

Browse Source
This commit is contained in:
依瑪貓 2023-03-08 17:59:56 +08:00
parent f277010991
commit 7b10eb68bc
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/accounting/report/reports/income_expenses.py
View File

@ -76,11 +76,11 @@ class ReportEntry:
class EntryCollector: class EntryCollector:
"""The income and expenses log entry collector.""" """The report entry collector."""
def __init__(self, currency: Currency, account: IncomeExpensesAccount, def __init__(self, currency: Currency, account: IncomeExpensesAccount,
period: Period): period: Period):
"""Constructs the income and expenses log entry collector. """Constructs the report entry collector.
:param currency: The currency. :param currency: The currency.
:param account: The account. :param account: The account.

12
src/accounting/report/reports/ledger.py
View File

@ -75,10 +75,10 @@ class ReportEntry:
class EntryCollector: class EntryCollector:
"""The ledger entry collector.""" """The report entry collector."""
def __init__(self, currency: Currency, account: Account, period: Period): def __init__(self, currency: Currency, account: Account, period: Period):
"""Constructs the ledger entry collector. """Constructs the report entry collector.
:param currency: The currency. :param currency: The currency.
:param account: The account. :param account: The account.
@ -93,7 +93,7 @@ class EntryCollector:
self.brought_forward: ReportEntry | None self.brought_forward: ReportEntry | None
"""The brought-forward entry.""" """The brought-forward entry."""
self.entries: list[ReportEntry] self.entries: list[ReportEntry]
"""The ledger entries.""" """The report entries."""
self.total: ReportEntry | None self.total: ReportEntry | None
"""The total entry.""" """The total entry."""
self.brought_forward = self.__get_brought_forward_entry() self.brought_forward = self.__get_brought_forward_entry()
@ -104,7 +104,7 @@ class EntryCollector:
def __get_brought_forward_entry(self) -> ReportEntry | None: def __get_brought_forward_entry(self) -> ReportEntry | None:
"""Queries, composes and returns the brought-forward entry. """Queries, composes and returns the brought-forward entry.
:return: The brought-forward entry, or None if the ledger starts from :return: The brought-forward entry, or None if the report starts from
the beginning. the beginning.
""" """
if self.__period.start is None: if self.__period.start is None:
@ -131,9 +131,9 @@ class EntryCollector:
return entry return entry
def __query_entries(self) -> list[ReportEntry]: def __query_entries(self) -> list[ReportEntry]:
"""Queries and returns the ledger entries. """Queries and returns the report entries.
:return: The ledger entries. :return: The report entries.
""" """
conditions: list[sa.BinaryExpression] \ conditions: list[sa.BinaryExpression] \
= [JournalEntry.currency_code == self.__currency.code, = [JournalEntry.currency_code == self.__currency.code,