Improve questionary titles

Replace rich.prompt with questionary

Author: Buried-In-Code

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.13.1
+    rev: v0.13.2
     hooks:
       - id: ruff-format
       - id: ruff-check

perdoo/__init__.py

@@ -6,15 +6,14 @@
     "get_state_root",
     "setup_logging",
 ]
-__version__ = "0.6.0"
+__version__ = "0.6.1"
 
 import logging
 import os
 from functools import cache
 from pathlib import Path
 
 from rich.logging import RichHandler
-from rich.traceback import install
 
 from perdoo.console import CONSOLE
 
@@ -52,15 +51,14 @@ def get_state_root() -> Path:
 
 
 def setup_logging(debug: bool = False) -> None:
-    install(show_locals=debug, max_frames=3, console=CONSOLE)
-
     console_handler = RichHandler(
         rich_tracebacks=True,
-        tracebacks_show_locals=True,
+        tracebacks_show_locals=debug,
+        tracebacks_max_frames=3,
         omit_repeated_times=False,
         show_level=True,
         show_time=False,
-        show_path=True,
+        show_path=debug,
         console=CONSOLE,
     )
     console_handler.setLevel(logging.DEBUG if debug else logging.INFO)

perdoo/__main__.py

@@ -44,9 +44,6 @@ def load(value: str) -> "SyncOption":
                 return entry
         raise ValueError(f"'{value}' isn't a valid SyncOption")
 
-    def __str__(self) -> str:
-        return self.value
-
 
 @app.callback(invoke_without_command=True)
 def common(
@@ -109,30 +106,30 @@ def _create_search_from_metron(metron_info: MetronInfo) -> Search:
     )
 
 
-def _create_search_from_comic_info(comic_info: ComicInfo) -> Search:
+def _create_search_from_comic_info(comic_info: ComicInfo, filename: str) -> Search:
     volume = comic_info.volume if comic_info.volume else None
     year = volume if volume and volume > 1900 else None
     volume = volume if volume and volume < 1900 else None
     return Search(
-        series=SeriesSearch(name=comic_info.series, volume=volume, year=year),
+        series=SeriesSearch(name=comic_info.series or filename, volume=volume, year=year),
         issue=IssueSearch(number=comic_info.number),
     )
 
 
-def _create_search_from_filename(fallback_title: str) -> Search:
-    series_name = comicfn2dict(fallback_title).get("series", fallback_title).replace("-", " ")
+def _create_search_from_filename(filename: str) -> Search:
+    series_name = comicfn2dict(filename).get("series", filename).replace("-", " ")
     return Search(series=SeriesSearch(name=series_name), issue=IssueSearch())
 
 
 def get_search_details(
-    metadata: tuple[MetronInfo | None, ComicInfo | None], fallback_title: str
+    metadata: tuple[MetronInfo | None, ComicInfo | None], filename: str
 ) -> Search:
     metron_info, comic_info = metadata
     if metron_info and metron_info.series and metron_info.series.name:
-        return _create_search_from_metron(metron_info)
+        return _create_search_from_metron(metron_info=metron_info)
     if comic_info and comic_info.series:
-        return _create_search_from_comic_info(comic_info)
-    return _create_search_from_filename(fallback_title)
+        return _create_search_from_comic_info(comic_info=comic_info, filename=filename)
+    return _create_search_from_filename(filename=filename)
 
 
 def load_page_info(entry: Comic, comic_info: ComicInfo) -> list[Page]:
@@ -181,7 +178,7 @@ def run(
             case_sensitive=False,
             help="Sync ComicInfo/MetronInfo with online services.",
         ),
-    ] = SyncOption.OUTDATED.value,
+    ] = SyncOption.OUTDATED,
     skip_clean: Annotated[
         bool,
         Option(
@@ -251,7 +248,8 @@ def run(
         metadata: tuple[MetronInfo | None, ComicInfo | None] = (entry.metron_info, entry.comic_info)
 
         if sync != SyncOption.SKIP:
-            search = get_search_details(metadata=metadata, fallback_title=entry.path.stem)
+            search = get_search_details(metadata=metadata, filename=entry.path.stem)
+            search.filename = entry.path.stem
             last_modified = date(1900, 1, 1)
             if sync == SyncOption.OUTDATED:
                 metron_info, _ = metadata

perdoo/comic.py

@@ -20,6 +20,7 @@
     ComicMetadataError,
     MetadataFormat,
 )
+from natsort import humansorted, ns
 
 from perdoo.metadata import ComicInfo, MetronInfo
 from perdoo.settings import Naming
@@ -101,17 +102,17 @@ def read_metadata(self, metadata_format: MetadataFormat) -> None:
             raise ComicMetadataError(f"Unsupported metadata format: {metadata_format}")
 
     def convert(self, extension: Literal["cbt", "cbz"]) -> None:
-        check, archiver = {
-            "cbt": (self.is_cbt, TarArchiver),
-            "cbz": (self.is_cbz, ZipArchiver),
-        }.get(extension)
+        check, archiver = {"cbt": (self.is_cbt, TarArchiver), "cbz": (self.is_cbz, ZipArchiver)}[
+            extension
+        ]
         if check():
             return
         output_file = self.path.with_suffix(f".{extension}")
         with self.archive as source, archiver(path=output_file) as destination:
             LOGGER.debug("Converting '%s' to '%s'", source.path.name, destination.path.name)
             if destination.copy_from_archive(other_archive=source):
                 self._archiver = destination
+            source.path.unlink()
 
     def clean_archive(self) -> None:
         with self.archive as source:
@@ -148,11 +149,14 @@ def _get_filepath_from_metadata(self, naming: Naming) -> str | None:
 
     def _rename_images(self, base_name: str) -> None:
         with self.archive as source:
-            files = [
-                x
-                for x in source.get_filename_list()
-                if Path(x).suffix.lower() in SUPPORTED_IMAGE_EXTENSIONS
-            ]
+            files = humansorted(
+                [
+                    x
+                    for x in source.get_filename_list()
+                    if Path(x).suffix.lower() in SUPPORTED_IMAGE_EXTENSIONS
+                ],
+                alg=ns.NA | ns.G | ns.P,
+            )
             pad_count = len(str(len(files))) if files else 1
             for idx, filename in enumerate(files):
                 img_file = Path(filename)
@@ -171,7 +175,7 @@ def rename(self, naming: Naming, output_folder: Path) -> None:
         new_filepath = new_filepath.lstrip("/")
 
         output = output_folder / f"{new_filepath}.cbz"
-        if output == self.path:
+        if output.relative_to(output_folder) == self.path.resolve().relative_to(output_folder):
             return
         if output.exists():
             LOGGER.warning("'%s' already exists, skipping", output.relative_to(output_folder))

perdoo/metadata/comic_info.py

@@ -343,12 +343,12 @@ def get_filename(self, settings: Naming) -> str:
     "series-id": lambda _: None,
     "series-name": lambda x: x.series,
     "series-sort-name": lambda _: None,
-    "series-year": lambda x: x.volume if x.volume > 1900 else None,
+    "series-year": lambda x: x.volume if x.volume and x.volume > 1900 else None,
     "store-date": lambda _: None,
     "store-day": lambda _: None,
     "store-month": lambda _: None,
     "store-year": lambda _: None,
     "title": lambda x: x.title,
     "upc": lambda _: None,
-    "volume": lambda x: x.volume if x.volume < 1900 else None,
+    "volume": lambda x: x.volume if x.volume and x.volume < 1900 else None,
 }

perdoo/services/_base.py

@@ -1,6 +1,6 @@
 __all__ = ["BaseService"]
 
-from abc import abstractmethod
+from abc import ABC, abstractmethod
 from typing import Generic, TypeVar
 
 from perdoo.metadata import ComicInfo, MetronInfo
@@ -10,20 +10,20 @@
 C = TypeVar("C")
 
 
-class BaseService(Generic[S, C]):
+class BaseService(ABC, Generic[S, C]):
     @abstractmethod
     def _search_series(
-        self, name: str | None, volume: int | None, year: int | None
+        self, name: str | None, volume: int | None, year: int | None, filename: str
     ) -> int | None: ...
 
     @abstractmethod
-    def fetch_series(self, search: SeriesSearch) -> S | None: ...
+    def fetch_series(self, search: SeriesSearch, filename: str) -> S | None: ...
 
     @abstractmethod
-    def _search_issue(self, series_id: int, number: str | None) -> int | None: ...
+    def _search_issue(self, series_id: int, number: str | None, filename: str) -> int | None: ...
 
     @abstractmethod
-    def fetch_issue(self, series_id: int, search: IssueSearch) -> C | None: ...
+    def fetch_issue(self, series_id: int, search: IssueSearch, filename: str) -> C | None: ...
 
     @abstractmethod
     def _process_metron_info(self, series: S, issue: C) -> MetronInfo | None: ...

perdoo/services/comicvine.py

@@ -6,17 +6,15 @@
 
 from natsort import humansorted, ns
 from prompt_toolkit.styles import Style
-from questionary import Choice, select
+from questionary import Choice, confirm, select, text
 from requests.exceptions import JSONDecodeError
-from rich.prompt import Confirm, Prompt
 from simyan.comicvine import Comicvine as Simyan
 from simyan.exceptions import ServiceError
 from simyan.schemas.issue import Issue
 from simyan.schemas.volume import Volume
 from simyan.sqlite_cache import SQLiteCache
 
 from perdoo import get_cache_root
-from perdoo.console import CONSOLE
 from perdoo.metadata import ComicInfo, MetronInfo
 from perdoo.metadata.metron_info import InformationSource
 from perdoo.services._base import BaseService
@@ -32,8 +30,10 @@ def __init__(self, settings: ComicvineSettings):
         cache = SQLiteCache(path=get_cache_root() / "simyan.sqlite", expiry=14)
         self.session = Simyan(api_key=settings.api_key, cache=cache)
 
-    def _search_series(self, name: str | None, volume: int | None, year: int | None) -> int | None:
-        name = name or Prompt.ask("Volume Name", console=CONSOLE)
+    def _search_series(
+        self, name: str | None, volume: int | None, year: int | None, filename: str
+    ) -> int | None:
+        name = name or text(message="Volume Name").ask()
         try:
             options = sorted(
                 self.session.list_volumes({"filter": f"name:{name}"}),
@@ -67,31 +67,31 @@ def _search_series(self, name: str | None, volume: int | None, year: int | None)
                 ]
                 choices.append(DEFAULT_CHOICE)
                 selected = select(
-                    f"Searching for Comicvine Volume '{search}'",
+                    f"Searching Comicvine for Volumes matching '{filename}'"
+                    if not year
+                    else f"Searching Comicvine for Volume '{search}'",
                     default=DEFAULT_CHOICE,
                     choices=choices,
                     style=Style([("dim", "dim")]),
                 ).ask()
                 if selected and selected != DEFAULT_CHOICE.title:
                     return selected.id
             else:
-                LOGGER.warning(
-                    "Unable to find any Volumes with the Name and StartYear: '%s %s'", name, year
-                )
+                LOGGER.warning("Unable to find any Volumes for the file: '%s'", filename)
             if year:
                 LOGGER.info("Searching again without the StartYear")
-                return self._search_series(name=name, volume=volume, year=None)
-            if Confirm.ask("Search Again", console=CONSOLE):
-                return self._search_series(name=None, volume=None, year=None)
+                return self._search_series(name=name, volume=volume, year=None, filename=filename)
+            if confirm(message="Search Again", default=False).ask():
+                return self._search_series(name=None, volume=None, year=None, filename=filename)
         except ServiceError as err:
             LOGGER.error(err)
         except JSONDecodeError:
             LOGGER.error("Unable to get response from Comicvine")
         return None
 
-    def fetch_series(self, search: SeriesSearch) -> Volume | None:
+    def fetch_series(self, search: SeriesSearch, filename: str) -> Volume | None:
         series_id = search.comicvine or self._search_series(
-            name=search.name, volume=search.volume, year=search.year
+            name=search.name, volume=search.volume, year=search.year, filename=filename
         )
         if not series_id:
             return None
@@ -106,10 +106,10 @@ def fetch_series(self, search: SeriesSearch) -> Volume | None:
             return None
         if search.comicvine:
             search.comicvine = None
-            return self.fetch_series(search=search)
+            return self.fetch_series(search=search, filename=filename)
         return None
 
-    def _search_issue(self, series_id: int, number: str | None) -> int | None:
+    def _search_issue(self, series_id: int, number: str | None, filename: str) -> int | None:
         try:
             options = humansorted(
                 self.session.list_issues(
@@ -120,12 +120,6 @@ def _search_issue(self, series_id: int, number: str | None) -> int | None:
                 key=lambda x: (x.number, x.name),
                 alg=ns.NA | ns.G,
             )
-            if not options:
-                LOGGER.warning(
-                    "Unable to find any Issues with the Volume and IssueNumber: '%s %s'",
-                    series_id,
-                    number,
-                )
             if options:
                 choices = [
                     Choice(
@@ -140,30 +134,30 @@ def _search_issue(self, series_id: int, number: str | None) -> int | None:
                 ]
                 choices.append(DEFAULT_CHOICE)
                 selected = select(
-                    f"Searching for Comicvine Issue #{number}",
+                    f"Searching Comicvine for Issues matching '{filename}'"
+                    if not number
+                    else f"Searching Comicvine for Issues with number '{number}'",
                     default=DEFAULT_CHOICE,
                     choices=choices,
                     style=Style([("dim", "dim")]),
                 ).ask()
                 if selected and selected != DEFAULT_CHOICE.title:
                     return selected.id
             else:
-                LOGGER.warning(
-                    "Unable to find any Issues with the Volume and IssueNumber: '%s %s'",
-                    series_id,
-                    number,
-                )
+                LOGGER.warning("Unable to find any Issues for the file: '%s'", filename)
             if number:
                 LOGGER.info("Searching again without the IssueNumber")
-                return self._search_issue(series_id=series_id, number=None)
+                return self._search_issue(series_id=series_id, number=None, filename=filename)
         except ServiceError as err:
             LOGGER.error(err)
         except JSONDecodeError:
             LOGGER.error("Unable to get response from Comicvine")
         return None
 
-    def fetch_issue(self, series_id: int, search: IssueSearch) -> Issue | None:
-        issue_id = search.comicvine or self._search_issue(series_id=series_id, number=search.number)
+    def fetch_issue(self, series_id: int, search: IssueSearch, filename: str) -> Issue | None:
+        issue_id = search.comicvine or self._search_issue(
+            series_id=series_id, number=search.number, filename=filename
+        )
         if not issue_id:
             return None
         try:
@@ -177,7 +171,7 @@ def fetch_issue(self, series_id: int, search: IssueSearch) -> Issue | None:
             return None
         if search.comicvine:
             search.comicvine = None
-            return self.fetch_issue(series_id=series_id, search=search)
+            return self.fetch_issue(series_id=series_id, search=search, filename=filename)
         return None
 
     def _process_metron_info(self, series: Volume, issue: Issue) -> MetronInfo | None:
@@ -256,11 +250,11 @@ def fetch(self, search: Search) -> tuple[MetronInfo | None, ComicInfo | None]:
             except (ServiceError, JSONDecodeError):
                 pass
 
-        series = self.fetch_series(search=search.series)
+        series = self.fetch_series(search=search.series, filename=search.filename)
         if not series:
             return None, None
 
-        issue = self.fetch_issue(series_id=series.id, search=search.issue)
+        issue = self.fetch_issue(series_id=series.id, search=search.issue, filename=search.filename)
         if not issue:
             return None, None