anipy-cli 3.5.9__tar.gz → 3.6.0__tar.gz

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: anipy-cli
-Version: 3.5.9
+Version: 3.6.0
 Summary: Watch and Download anime from the comfort of your Terminal
 License: GPL-3.0
 Keywords: anime,cli
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: anipy-api (>=3.5.9,<4.0.0)
+Requires-Dist: anipy-api (>=3.6.0,<4.0.0)
 Requires-Dist: appdirs (>=1.4.4,<2.0.0)
 Requires-Dist: inquirerpy (>=0.3.4,<0.4.0)
 Requires-Dist: pypresence (>=4.3.0,<5.0.0)

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "anipy-cli"
-version = "3.5.9"
+version = "3.6.0"
 description = "Watch and Download anime from the comfort of your Terminal"
 authors = ["sdaqo <sdaqo.dev@protonmail.com>"]
 license = "GPL-3.0"
@@ -20,7 +20,7 @@ yaspin = "^3.0.2"
 inquirerpy = "^0.3.4"
 appdirs = "^1.4.4"
 pypresence = "^4.3.0"
-anipy-api = "^3.5.9"
+anipy-api = "^3.6.0"
 
 [tool.poetry.scripts]
 anipy-cli = "anipy_cli.cli:run_cli"

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/__init__.py

@@ -1,2 +1,2 @@
 __appname__ = "anipy-cli"
-__version__ = "3.5.9"
+__version__ = "3.6.0"

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/arg_parser.py

@@ -22,6 +22,8 @@ class CliArgs:
     optional_player: Optional[str]
     search: Optional[str]
     location: Optional[Path]
+    verbosity: int
+    stack_always: bool
     mal_password: Optional[str]
     config: bool
     seasonal_search: Optional[str]
@@ -176,6 +178,24 @@ def parse_args(override_args: Optional[list[str]] = None) -> CliArgs:
         help="Override all configured download locations",
     )
 
+    options_group.add_argument(
+        "-V",
+        "--verbose",
+        required=False,
+        dest="verbosity",
+        action="count",
+        default=0,
+        help="Verbosity levels in the console: -V = 'fatal' -VV = 'warnings' -VVV = 'info'",
+    )
+
+    options_group.add_argument(
+        "--stack-always",
+        required=False,
+        dest="stack_always",
+        action="store_true",
+        help="Always show the stack trace on any log outputs.",
+    )
+
     options_group.add_argument(
         "-so",
         "--sub-only",

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/cli.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+from types import TracebackType
 from typing import Optional
 
 from pypresence.exceptions import DiscordNotFound
@@ -5,16 +7,34 @@ from pypresence.exceptions import DiscordNotFound
 from anipy_api.locallist import LocalList
 from anipy_cli.prompts import migrate_provider
 
-from anipy_cli.arg_parser import parse_args
+from anipy_cli.arg_parser import CliArgs, parse_args
 from anipy_cli.clis import *
-from anipy_cli.colors import colors, cprint
+from anipy_cli.colors import color, colors, cprint
 from anipy_cli.util import error, DotSpinner, migrate_locallist
 from anipy_cli.config import Config
 from anipy_cli.discord import DiscordPresence
+import anipy_cli.logger as logger
 
 
 def run_cli(override_args: Optional[list[str]] = None):
     args = parse_args(override_args)
+
+    logger.set_cli_verbosity(args.verbosity)
+    logger.set_stack_always(args.stack_always)
+
+    def fatal_handler(exc_val: BaseException, exc_tb: TracebackType, logs_location: Path):
+        print(
+            color(
+                colors.RED,
+                f'A fatal error of type [{exc_val.__class__.__name__}] has occurred with message "{exc_val.args[0]}". Logs can be found at {logs_location}.',
+            )
+        )
+
+    with logger.safe(fatal_handler):
+        _safe_cli(args)
+
+
+def _safe_cli(args: CliArgs):
     config = Config()
     # This updates the config, adding new values doc changes and the like.
     config._create_config()

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/colors.py

@@ -1,4 +1,7 @@
-class colors:
+from typing import Any
+
+
+class colors: # noqa: N801
     """Just a class for colors."""
 
     GREEN = "\033[92m"
@@ -14,7 +17,7 @@ class colors:
     RESET = "\033[0m"
 
 
-def color(*values, sep: str = "") -> str:
+def color(*values: Any, sep: str = "") -> str:
     """Decorate a string with color codes.
 
     Basically just ensures that the color doesn't "leak"
@@ -24,13 +27,13 @@ def color(*values, sep: str = "") -> str:
     return sep.join(map(str, values)) + colors.END
 
 
-def cinput(*prompt, input_color: str = "") -> str:
+def cinput(*prompt: Any, input_color: str = "") -> str:
     """An input function that handles coloring input."""
     inp = input(color(*prompt) + input_color)
     print(colors.END, end="")
     return inp
 
 
-def cprint(*values, sep: str = "", **kwargs) -> None:
+def cprint(*values: Any, sep: str = "", **kwargs: Any) -> None:
     """Prints colored text."""
     print(color(*values, sep=sep), **kwargs)

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/config.py

@@ -419,7 +419,7 @@ class Config:
         except RuntimeError:
             return fallback
 
-    def _get_value(self, key: str, fallback, _type: Type) -> Any:
+    def _get_value(self, key: str, fallback: Any, _type: Type) -> Any:
         value = self._yaml_conf.get(key, fallback)
         if isinstance(value, _type):
             return value

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/download_component.py

@@ -4,6 +4,7 @@ from anipy_cli.arg_parser import CliArgs
 from anipy_cli.colors import color, colors
 from anipy_cli.config import Config
 from anipy_cli.util import DotSpinner, get_download_path, get_post_download_scripts_hook
+import anipy_cli.logger as logger
 
 from anipy_api.anime import Anime
 from anipy_api.download import Downloader
@@ -54,11 +55,13 @@ class DownloadComponent:
             def progress_indicator(percentage: float):
                 s.set_text(f"Progress: {percentage:.1f}%")
 
-            def info_display(message: str):
+            def info_display(message: str, exc_info: BaseException | None = None):
+                logger.info(message, exc_info, exc_info is not None)
                 s.write(f"> {message}")
 
-            def error_display(message: str):
-                s.write(color(colors.RED, "! ", message))
+            def error_display(message: str, exc_info: BaseException | None = None):
+                logger.error(message, exc_info)
+                s.write(f"{colors.RED}! {message}{colors.END}")
 
             downloader = Downloader(progress_indicator, info_display, error_display)
 
@@ -93,7 +96,12 @@ class DownloadComponent:
         for ep in eps:
             try:
                 self.download_ep(spinner, downloader, anime, lang, ep, sub_only)
-            except Exception as e:
+            except Exception as anime_download_error:
+                # Log it first so we don't run into another error below
+                logger.error(
+                    f"Error downloading episode {ep} of {anime.name}. Skipped.",
+                    anime_download_error,
+                )
                 if only_skip_ep_on_err:
                     error_msg = f"! Issues downloading episode {ep} of {anime.name}. Skipping..."
                 else:
@@ -101,7 +109,7 @@ class DownloadComponent:
                 spinner.write(
                     color(
                         colors.RED,
-                        f"! Error: {e}\n",
+                        f"! Error: {anime_download_error}\n",
                         error_msg,
                     )
                 )
@@ -136,9 +144,11 @@ class DownloadComponent:
 
         stream = anime.get_video(ep, lang, preferred_quality=self.options.quality)
 
-        spinner.write(
-            f"> Downloading Episode {stream.episode} of {anime.name} ({lang})"
+        download_message_update = (
+            f"Downloading Episode {stream.episode} of {anime.name} ({lang})"
         )
+        logger.info(download_message_update)
+        spinner.write(f"> {download_message_update}")
 
         spinner.set_text("Downloading...")
 

anipy_cli-3.6.0/src/anipy_cli/logger.py

@@ -0,0 +1,199 @@
+from __future__ import annotations
+
+import logging
+import logging.handlers
+from pathlib import Path
+import sys
+from types import TracebackType
+from typing import Protocol
+import datetime
+
+from anipy_cli.config import Config
+from anipy_cli import __appname__
+from appdirs import user_data_dir
+
+
+class FatalHandler(Protocol):
+    def __call__(
+        self, exc_val: BaseException, exc_tb: TracebackType, logs_location: Path
+    ): ...
+
+
+class FatalCatcher:
+    def __init__(
+        self,
+        logs_location: Path,
+        fatal_handler: FatalHandler | None = None,
+        ignore_system_exit: bool = True,
+    ):
+        self._fatal_handler = fatal_handler
+
+        self.logs_location = logs_location
+        self.ignore_system_exit = ignore_system_exit
+
+    def __enter__(self):
+        info("Initializing program...")
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ):
+        if (not exc_type) or (not exc_val) or (not exc_tb):
+            info("Program exited successfully...")
+            return True
+
+        if exc_type is SystemExit and self.ignore_system_exit:
+            return True
+
+        try:
+            # Attempt to let a handler know something is up
+            # so it can get to the user
+            if self._fatal_handler:
+                self._fatal_handler(exc_val, exc_tb, self.logs_location)
+        except Exception:
+            # If that fails, at least get something to the user
+            sys.stderr.write("An extra fatal error occurred...")
+
+        fatal(f"A fatal error has occurred - {','.join(exc_val.args)}", exc_val)
+        info("Program exited with fatal errors...")
+
+        return True  # Return true because we have processed the error
+
+
+LOGGER_NAME = "cli_logger"
+MAX_LOGS = 5
+DEFAULT_FILE_LOG_LEVEL = 10
+DEFAULT_CONSOLE_LOG_LEVEL = 60
+
+
+def get_logs_location():
+    user_file_path = Path()
+    try:
+        user_file_path = Config().user_files_path
+    except Exception:
+        user_file_path = Path(user_data_dir(__appname__, appauthor=False))
+    finally:
+        return user_file_path / "logs"
+
+_logger = logging.getLogger(LOGGER_NAME)
+
+_logger.setLevel(10)
+
+file_formatter = logging.Formatter(
+    "{asctime} - {levelname} - {message}", style="{", datefmt=r"%Y-%m-%d %H:%M:%S"
+)
+console_formatter = logging.Formatter("{levelname} -> {message}", style="{")
+
+console_handler = logging.StreamHandler()
+console_handler.setFormatter(console_formatter)
+console_handler.setLevel(DEFAULT_CONSOLE_LOG_LEVEL)
+_logger.addHandler(console_handler)
+
+log_dir = get_logs_location()
+log_dir.mkdir(parents=True, exist_ok=True)
+
+current_time = datetime.datetime.now()
+file_handler = logging.handlers.RotatingFileHandler(
+    get_logs_location() / f"{current_time.isoformat().replace(':', '.')}.log",
+    backupCount=5,
+    encoding="utf-8",
+)
+file_handler.setFormatter(file_formatter)
+file_handler.setLevel(DEFAULT_FILE_LOG_LEVEL)
+_logger.addHandler(file_handler)
+
+
+def get_console_log_level():
+    return console_handler.level
+
+
+def set_console_log_level(value: logging._Level):
+    console_handler.setLevel(value)
+
+
+def get_file_log_level():
+    return file_handler.level
+
+
+def set_file_log_level(value: logging._Level):
+    file_handler.setLevel(value)
+
+
+def set_cli_verbosity(level: int):
+    """
+    Set how extreme the error has to
+    be for it to be printed in the CLI.
+
+    Default is 0.
+
+    0 = No Statements To CLI
+    1 = Fatal
+    2 = Warnings
+    3 = Info
+    """
+    level_conversion = {
+        0: 60,
+        1: 50,
+        2: 30,
+        3: 20,
+    }
+    other = 10  # If anything else, default to debug.
+    console_handler.setLevel(level_conversion.get(level, other))
+
+
+def safe(fatal_handler: FatalHandler | None = None):
+    return FatalCatcher(get_logs_location(), fatal_handler)
+
+
+_stack_always = False
+
+
+def set_stack_always(value: bool):
+    global _stack_always
+
+    _stack_always = value
+
+
+def is_stack_always(passthrough: bool):
+    """
+    If _stack_always is true, return true.
+
+    Otherwise return passthrough.
+    """
+    return True if _stack_always else passthrough
+
+
+def debug(
+    content: str, exc_info: logging._ExcInfoType = None, stack_info: bool = False
+):
+    _logger.debug(content, exc_info=exc_info, stack_info=is_stack_always(stack_info))
+
+
+def info(content: str, exc_info: logging._ExcInfoType = None, stack_info: bool = False):
+    _logger.info(content, exc_info=exc_info, stack_info=is_stack_always(stack_info))
+
+
+def warn(content: str, exc_info: logging._ExcInfoType = None, stack_info: bool = False):
+    _logger.warning(content, exc_info=exc_info, stack_info=is_stack_always(stack_info))
+
+
+def error(content: str, exc_info: logging._ExcInfoType = None):
+    _logger.error(content, exc_info=exc_info, stack_info=True)
+
+
+def fatal(content: str, exc_info: logging._ExcInfoType = None):
+    _logger.critical(content, exc_info=exc_info, stack_info=True)
+
+
+def log(
+    level: int,
+    content: str,
+    exc_info: logging._ExcInfoType = None,
+    stack_info: bool = False,
+):
+    _logger.log(
+        level, content, exc_info=exc_info, stack_info=is_stack_always(stack_info)
+    )

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/menus/base_menu.py

@@ -1,10 +1,9 @@
-import os
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from typing import Callable, List
 
 from anipy_cli.colors import color, colors
-from anipy_cli.util import error
+from anipy_cli.util import clear_screen, error
 
 
 @dataclass(frozen=True)
@@ -40,9 +39,9 @@ class MenuBase(ABC):
 
             op.callback()
 
-    def print_options(self, clear_screen=True):
-        if clear_screen:
-            os.system("cls" if os.name == "nt" else "clear")
+    def print_options(self, should_clear_screen: bool = True):
+        if should_clear_screen:
+            clear_screen()
 
         self.print_header()
         for op in self.menu_options:

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/menus/mal_menu.py

@@ -275,7 +275,7 @@ class MALMenu(MenuBase):
         )
         DownloadComponent.serve_download_errors(errors)
 
-        self.print_options(clear_screen=len(errors) == 0)
+        self.print_options(should_clear_screen=len(errors) == 0)
 
     def binge_latest(self):
         picked = self._choose_latest()

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/menus/menu.py

@@ -6,6 +6,7 @@ from InquirerPy.base.control import Choice
 from anipy_api.download import Downloader
 from anipy_api.provider import LanguageTypeEnum, ProviderStream
 from anipy_api.locallist import LocalList
+import anipy_cli.logger as logger
 
 from anipy_cli.colors import colors, cprint
 from anipy_cli.config import Config
@@ -221,10 +222,12 @@ class Menu(MenuBase):
             def progress_indicator(percentage: float):
                 s.set_text(f"Downloading ({percentage:.1f}%)")
 
-            def info_display(message: str):
+            def info_display(message: str, exc_info: BaseException | None = None):
+                logger.info(message, exc_info, exc_info is not None)
                 s.write(f"> {message}")
 
-            def error_display(message: str):
+            def error_display(message: str, exc_info: BaseException | None = None):
+                logger.error(message, exc_info)
                 s.write(f"{colors.RED}! {message}{colors.END}")
 
             downloader = Downloader(progress_indicator, info_display, error_display)

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/menus/seasonal_menu.py

@@ -8,7 +8,7 @@ from anipy_api.anime import Anime
 from anipy_api.provider import LanguageTypeEnum
 from anipy_api.provider.base import Episode
 from anipy_api.locallist import LocalList, LocalListEntry
-from anipy_api.error import ProviderNotAvailable
+from anipy_api.error import ProviderNotAvailableError
 from InquirerPy import inquirer
 from InquirerPy.base.control import Choice
 from InquirerPy.utils import get_style
@@ -67,7 +67,7 @@ class SeasonalMenu(MenuBase):
             for s in self.seasonal_list.get_all():
                 try:
                     anime = Anime.from_local_list_entry(s)
-                except ProviderNotAvailable:
+                except ProviderNotAvailableError:
                     error(
                         f"Can not load '{s.name}' because the configured provider"
                         f" '{s.provider}' was not found, maybe try to migrate"
@@ -212,7 +212,7 @@ class SeasonalMenu(MenuBase):
 
     def migrate_provider(self):
         migrate_provider("seasonal", self.seasonal_list)
-        self.print_options(clear_screen=True)
+        self.print_options(should_clear_screen=True)
 
     def download_latest(self):
         picked = self._choose_latest()
@@ -232,7 +232,7 @@ class SeasonalMenu(MenuBase):
 
         if not self.options.auto_update:
             # Clear screen only if there were no issues
-            self.print_options(clear_screen=len(failed_series) == 0)
+            self.print_options(should_clear_screen=len(failed_series) == 0)
 
     def binge_latest(self):
         picked = self._choose_latest()

{anipy_cli-3.5.9 → anipy_cli-3.6.0}/src/anipy_cli/util.py

@@ -1,8 +1,11 @@
+import logging
+import os
 import sys
 import subprocess as sp
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
+    Any,
     Iterator,
     List,
     Literal,
@@ -12,6 +15,8 @@ from typing import (
     overload,
 )
 
+import anipy_cli.logger as logger
+
 from anipy_api.anime import Anime
 from anipy_api.download import Downloader, PostDownloadCallback
 from anipy_api.locallist import LocalListData
@@ -31,7 +36,7 @@ if TYPE_CHECKING:
 
 
 class DotSpinner(Yaspin):
-    def __init__(self, *text_and_colors, **spinner_args):
+    def __init__(self, *text_and_colors: Any, **spinner_args: Any):
         super().__init__(
             text=color(*text_and_colors),
             color="cyan",
@@ -43,21 +48,26 @@ class DotSpinner(Yaspin):
         self.start()
         return self
 
-    def set_text(self, *text_and_colors):
+    def set_text(self, *text_and_colors: Any):
         self.text = color(*text_and_colors)
 
 
 @overload
 def error(error: str, fatal: Literal[True]) -> NoReturn: ...
 @overload
-def error(error: str, fatal: Literal[False] = ...) -> None: ...
+def error(
+    error: str, fatal: Literal[False] = ..., log_level: int = logging.INFO
+) -> None: ...
 
 
-def error(error: str, fatal: bool = False) -> Union[NoReturn, None]:
+def error(
+    error: str, fatal: bool = False, log_level: int = logging.INFO
+) -> Union[NoReturn, None]:
     if not fatal:
         sys.stderr.write(
             color(colors.RED, "anipy-cli: error: ", colors.END, f"{error}\n")
         )
+        logger.log(log_level, error)
         return
 
     sys.stderr.write(
@@ -68,9 +78,16 @@ def error(error: str, fatal: bool = False) -> Union[NoReturn, None]:
             f"{error}, exiting\n",
         )
     )
+    logger.warn(error)
     sys.exit(1)
 
 
+def clear_screen():
+    if logger.get_console_log_level() < 60:
+        return
+    os.system("cls" if os.name == "nt" else "clear")
+
+
 def get_prefered_providers(mode: str) -> Iterator["BaseProvider"]:
     config = Config()
     preferred_providers = config.providers[mode]
@@ -206,7 +223,7 @@ def get_configured_player(player_override: Optional[str] = None) -> "PlayerBase"
     return get_player(player, args, discord_cb)
 
 
-def get_anime_season(month):
+def get_anime_season(month: int):
     if 1 <= month <= 3:
         return "Winter"
     elif 4 <= month <= 6: