Merge pull request #26 from Qwizi/menu

Added interactive menu

Author: Qwizi

task3_dsw/invoices.py

@@ -1,22 +1,32 @@
 """Invoices module."""
+from __future__ import annotations
+
 import csv
-import datetime
+import datetime  # noqa: TCH003
 import uuid
 from pathlib import Path
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, field_validator
 
 from task3_dsw import settings
 
 
 class Invoice(BaseModel):
     """Invoice model."""
 
-    id: uuid.UUID = Field(default_factory=uuid.uuid4)  # noqa: A003
+    id: uuid.UUID = Field(default_factory=uuid.uuid4)  # noqa: A003, RUF100
     amount: float
     currency: str
     date: datetime.date
 
+    @field_validator("currency")
+    def currency_is_valid(cls, v) -> str:  # noqa: N805, ANN001
+        """Validate currency code."""
+        if v not in settings.CURRENCIES:
+            msg = f"Currency code {v} is not valid."
+            raise ValueError(msg)
+        return v
+
 
 def create_invoices_file() -> None:
     """Create invoices file."""
@@ -30,6 +40,19 @@ def add_invoice_to_file(data: Invoice) -> Invoice:
     """
     Add invoice to file.
 
+    Example:
+    -------
+    ```python
+
+    from task3_dsw.invoices import add_invoice_to_file, Invoice
+
+    invoice = add_invoice_to_file(data=Invoice(
+        amount=100,
+        currency="USD",
+        date="2021-01-01",
+    ))
+    ```
+
     Args:
     ----
         data: Invoice to be added.
@@ -63,3 +86,20 @@ def get_invoice_from_file(invoice_id: uuid.UUID) -> Invoice or None:
             if row[0] == str(invoice_id):
                 return Invoice(id=row[0], amount=row[1], currency=row[2], date=row[3])
         return None
+
+
+def get_invoices_from_file() -> list[Invoice]:
+    """
+    Get invoices from file.
+
+    Returns
+    -------
+        List[Invoice]: List of invoices.
+    """
+    with Path.open(settings.INVOICES_FILE_PATH, "r", newline="") as invoices_file:
+        reader = csv.reader(invoices_file)
+        next(reader)
+        return [
+            Invoice(id=row[0], amount=row[1], currency=row[2], date=row[3])
+            for row in reader
+        ]

task3_dsw/logger.py

@@ -3,6 +3,8 @@
 import logging
 import sys
 
+from task3_dsw import settings
+
 logger = logging.getLogger("Task3 DSW Logger")
 
 stdout = logging.StreamHandler(stream=sys.stdout)
@@ -14,4 +16,7 @@
 stdout.setFormatter(fmt)
 logger.addHandler(stdout)
 
-logger.setLevel(logging.INFO)
+if settings.DEBUG:
+    logger.setLevel(logging.DEBUG)
+else:
+    logger.setLevel(logging.ERROR)

task3_dsw/main.py

@@ -8,6 +8,12 @@
     create_invoices_file,
 )
 from task3_dsw.logger import logger
+from task3_dsw.menu import (
+    AddInvoiceAction,
+    AddPaymentAction,
+    ExitAction,
+    InteractiveMenu,
+)
 from task3_dsw.payments import (
     create_payments_file,
 )
@@ -37,6 +43,7 @@ def create_parser() -> argparse.ArgumentParser:
         type=str,
         help="File with invoices",
     )
+    parser.add_argument("-v", "--verbose", action="store_true", help="Verbose mode.")
     return parser
 
 
@@ -54,14 +61,34 @@ def main() -> None:
     if args.currencies:
         settings.CURRENCIES = args.currencies
 
+    if args.verbose:
+        settings.DEBUG = args.verbose
+        logger.setLevel("DEBUG")
+
     # initialize NBPApiClient with settings
     nbp_api_client = nbp_api.NBPApiClient()
 
     if args.interactive:
-        logger.warning("We are in interactive mode.")
+        logger.debug("We are in interactive mode.")
+        # initialize InteractiveMenu with nbp_api_client
+        interactive_menu = InteractiveMenu()
+        interactive_menu.add_action(
+            AddInvoiceAction(
+                name="Add invoice", tag="add_invoice", description="Add invoice"
+            )
+        )
+        interactive_menu.add_action(
+            AddPaymentAction(
+                name="Add payment", tag="add_payment", description="Add payment"
+            )
+        )
+        interactive_menu.add_action(
+            ExitAction(name="Exit", tag="exit", description="Exit")
+        )
+        interactive_menu.run()
     else:
-        logger.info("We are in non-interactive mode.")
-        logger.info(
+        logger.debug("We are in non-interactive mode.")
+        logger.debug(
             nbp_api_client.get_exchange_rate(
                 data=nbp_api.ExchangeRateSchema(code="xD", date="2021-01-04")
             )

task3_dsw/menu.py

@@ -0,0 +1,134 @@
+"""Module for creating interactive menu in console."""
+import sys
+
+from task3_dsw.invoices import (
+    Invoice,
+    add_invoice_to_file,
+    get_invoice_from_file,
+)
+from task3_dsw.logger import logger
+from task3_dsw.payments import Payment, add_payment_to_file
+
+
+class Action:
+    """Action class for creating action in interactive menu."""
+
+    def __init__(self, name: str, tag: str, description: str) -> None:
+        """Initialize Action class."""
+        self.name = name
+        self.tag = tag
+        self.description = description
+
+    def __str__(self) -> str:
+        """Return name of action."""
+        return f"{self.name}: {self.description}"
+
+    def execute(self) -> None:
+        """Execute action."""
+        logger.debug("Execute action: %s", self.name)
+
+
+class ExitAction(Action):
+    """ExitAction class for creating exit action in interactive menu."""
+
+    def execute(self) -> None:
+        """Execute action."""
+        logger.debug("Execute action: %s", self.name)
+        sys.exit(0)
+
+
+class AddInvoiceAction(Action):
+    """AddInvoiceAction class for creating add invoice action in interactive menu."""
+
+    def execute(self) -> None:
+        """Execute action for adding invoice."""
+        try:
+            amount = float(input("Enter amount: "))
+            currency = input("Enter currency: ")
+            date = input("Enter date: ")
+            invoice_schema = add_invoice_to_file(
+                data=Invoice(amount=amount, currency=currency, date=date)
+            )
+            logger.debug("Added invoice: %s", invoice_schema)
+        except ValueError as e:
+            logger.error("Invalid value: %s", e)
+        except FileNotFoundError as e:
+            logger.error("Something went wrong: %s", e)
+
+
+class AddPaymentAction(Action):
+    """AddPaymentAction class for creating add payment action in interactive menu."""
+
+    def execute(self) -> None:
+        """Execute action for adding payment."""
+        try:
+            invoice_id = input("Enter invoice id: ")
+            amount = float(input("Enter amount: "))
+            currency = input("Enter currency: ")
+            date = input("Enter date: ")
+
+            invoice_from_file = get_invoice_from_file(invoice_id=invoice_id)
+            if invoice_from_file is None:
+                logger.error(f"Invoice with id {invoice_id} not exists.")
+                return
+            payment_schema = add_payment_to_file(
+                data=Payment(
+                    amount=amount, currency=currency, date=date, invoice_id=invoice_id
+                )
+            )
+            logger.debug("Added payment: %s", payment_schema)
+        except ValueError as e:
+            logger.error("Invalid value: %s", e)
+
+        except FileNotFoundError as e:
+            logger.error("Something went wrong: %s", e)
+
+
+class InteractiveMenu:
+    """InteractiveMenu class for creating interactive menu in console."""
+
+    def __init__(self) -> None:
+        """Initialize InteractiveMenu class."""
+        self.actions = []
+
+    def run(self) -> None:
+        """Run interactive menu."""
+        while True:
+            self.print_actions()
+            action_id = input("Choose action: ")
+            logger.debug("User choose action: %s", action_id)
+            self.run_action(int(action_id))
+
+    def add_action(self, action: Action) -> None:
+        """
+        Add action to interactive menu.
+
+        Args:
+        ----
+            action: action to add
+        """
+        self.actions.append(action)
+
+    def print_actions(self) -> None:
+        """Print all actions in interactive menu."""
+        for action in self.actions:
+            print("{}. {}".format(self.actions.index(action) + 1, action))  # noqa: UP032, T201
+
+    def run_action(self, action_id: int) -> None:
+        """
+        Run action from interactive menu.
+
+        Args:
+        ----
+            action_id: id of action
+
+        Raises:
+        ------
+            IndexError: if action with given id not exists
+        """
+        try:
+            action = self.actions[action_id - 1]
+            logger.debug("Run action: %s", action)
+            action.execute()
+        except IndexError:
+            logger.error("Action with id %s not exists.", action_id)

task3_dsw/payments.py

@@ -27,6 +27,19 @@ def add_payment_to_file(data: Payment) -> Payment:
     """
     Add payment to file.
 
+    Example:
+    -------
+    ```python
+    from task3_dsw.payments import add_payment_to_file, Payment
+
+    payment = add_payment_to_file(data=Payment(
+        invoice_id="123e4567-e89b-12d3-a456-426614174000",
+        amount=100,
+        currency="USD",
+        date="2021-01-01",
+    ))
+    ```
+
     Args:
     ----
         file_path: Path to file.

task3_dsw/settings.py

@@ -10,11 +10,13 @@ class Settings(BaseSettings):
 
     Attributes
     ----------
+        DEBUG: bool - debug mode
         CURRENCIES: list[str] - list of valid currencies
         INVOICES_FILE_PATH: str - path to invoices file
         PAYMENTS_FILE_PATH: str - path to payments file
     """
 
+    DEBUG: bool = False
     INVOICES_FILE_PATH: str = "./data/invoices.csv"
     PAYMENTS_FILE_PATH: str = "./data/payments.csv"
     CURRENCIES: list[str] = ["EUR", "USD", "GBP"]