69 lines
2.0 KiB
Python
69 lines
2.0 KiB
Python
|
# The Mia! Accounting Flask Project.
|
||
|
|
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/6
|
||
|
|
|
||
|
|
# 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 page parameters of a report.
|
||
|
|
|
||
|
|
"""
|
||
|
|
from abc import ABC, abstractmethod
|
||
|
|
from urllib.parse import urlparse, ParseResult, parse_qsl, urlencode, \
|
||
|
|
urlunparse
|
||
|
|
|
||
|
|
from flask import request
|
||
|
|
import typing as t
|
||
|
|
|
||
|
|
from accounting.report.report_chooser import ReportChooser
|
||
|
|
from accounting.utils.txn_types import TransactionType
|
||
|
|
|
||
|
|
|
||
|
|
class PageParams(ABC):
|
||
|
|
"""The page parameters of a report."""
|
||
|
|
|
||
|
|
@property
|
||
|
|
@abstractmethod
|
||
|
|
def has_data(self) -> bool:
|
||
|
|
"""Returns whether there is any data on the page.
|
||
|
|
|
||
|
|
:return: True if there is any data, or False otherwise.
|
||
|
|
"""
|
||
|
|
|
||
|
|
@property
|
||
|
|
@abstractmethod
|
||
|
|
def report_chooser(self) -> ReportChooser:
|
||
|
|
"""Returns the report chooser.
|
||
|
|
|
||
|
|
:return: The report chooser.
|
||
|
|
"""
|
||
|
|
|
||
|
|
@property
|
||
|
|
def txn_types(self) -> t.Type[TransactionType]:
|
||
|
|
"""Returns the transaction types.
|
||
|
|
|
||
|
|
:return: The transaction types.
|
||
|
|
"""
|
||
|
|
return TransactionType
|
||
|
|
|
||
|
|
@property
|
||
|
|
def csv_uri(self) -> str:
|
||
|
|
uri: str = request.full_path if request.query_string \
|
||
|
|
else request.path
|
||
|
|
uri_p: ParseResult = urlparse(uri)
|
||
|
|
params: list[tuple[str, str]] = parse_qsl(uri_p.query)
|
||
|
|
params = [x for x in params if x[0] != "as"]
|
||
|
|
params.append(("as", "csv"))
|
||
|
|
parts: list[str] = list(uri_p)
|
||
|
|
parts[4] = urlencode(params)
|
||
|
|
return urlunparse(parts)
|