Start services refactor

Author: Buried-In-Code

perdoo/cli/rename.py

@@ -157,7 +157,7 @@ def rename_comic(comic: Comic, new_filename: str, image_exts: Sequence[str]) ->
                 idx += 1
                 if filename != new_name:
                     CONSOLE.print(f"Renaming {filename!r} to {new_name!r}")
-                    comic.rename_file(filename=filename, new_name=new_filename, override=True)
+                    comic.rename_file(filename=filename, new_name=new_name, override=True)
     except ArchiveCapabilityError as err:
         CONSOLE.print(
             f"{err}: Consider converting to another format first", style="logging.level.warning"

perdoo/services/__init__.py

@@ -1,5 +1,6 @@
-__all__ = ["BaseService", "Comicvine", "Metron"]
+__all__ = ["Comicvine", "MetadataResult", "Metron", "Search", "Service"]
 
-from perdoo.services._base import BaseService
+from perdoo.services._base import Service
+from perdoo.services._models import MetadataResult, Search
 from perdoo.services.comicvine import Comicvine
 from perdoo.services.metron import Metron

perdoo/services/_base.py

@@ -1,53 +1,28 @@
-__all__ = ["BaseService"]
+__all__ = ["Service", "prompt_select"]
 
-from abc import ABC, abstractmethod
-from typing import Any, Generic, TypeVar
+from typing import Any, Protocol
 
-from comic_archive.metadata import ComicInfo, MetronInfo
 from prompt_toolkit.styles import Style
 from questionary import Choice, select
 
-from perdoo.utils import IssueSearch, Search, SeriesSearch
+from perdoo.services._models import MetadataResult, Search
 
-S = TypeVar("S")
-C = TypeVar("C")
 DEFAULT_CHOICE = Choice(title="None of the Above", value=None)
 
 
-class BaseService(ABC, Generic[S, C]):
-    @staticmethod
-    def _prompt_select(message: str, choices: list[Choice]) -> Any:  # noqa: ANN401
-        if not choices:
-            return None
-        selected = select(
-            message,
-            default=DEFAULT_CHOICE,
-            choices=[*choices, DEFAULT_CHOICE],
-            style=Style([("dim", "dim")]),
-        ).ask()
-        if select and selected != DEFAULT_CHOICE.title:
-            return selected
+def prompt_select(message: str, choices: list[Choice]) -> Any:  # noqa: ANN401
+    if not choices:
         return None
-
-    @abstractmethod
-    def _search_series(
-        self, name: str | None, volume: int | None, year: int | None, filename: str
-    ) -> int | None: ...
-
-    @abstractmethod
-    def fetch_series(self, search: SeriesSearch, filename: str) -> S | None: ...
-
-    @abstractmethod
-    def _search_issue(self, series_id: int, number: str | None, filename: str) -> int | None: ...
-
-    @abstractmethod
-    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: ...
-
-    @abstractmethod
-    def _process_comic_info(self, series: S, issue: C) -> ComicInfo | None: ...
-
-    @abstractmethod
-    def fetch(self, search: Search) -> tuple[MetronInfo | None, ComicInfo | None]: ...
+    selected = select(
+        message,
+        default=DEFAULT_CHOICE,
+        choices=[*choices, DEFAULT_CHOICE],
+        style=Style([("dim", "dim")]),
+    ).ask()
+    if select and selected != DEFAULT_CHOICE.title:
+        return selected
+    return None
+
+
+class Service(Protocol):
+    def fetch(self, search: Search) -> MetadataResult: ...

perdoo/services/_models.py

@@ -0,0 +1,94 @@
+__all__ = ["MetadataResult", "Search"]
+
+from dataclasses import dataclass
+
+from comic_archive import Comic
+from comic_archive.metadata import ComicInfo, MetronInfo
+from comic_archive.metadata.metron_info import Id, InformationSource
+from comicfn2dict import comicfn2dict
+
+
+@dataclass(frozen=True)
+class MetadataResult:
+    comic_info: ComicInfo | None = None
+    metron_info: MetronInfo | None = None
+
+
+@dataclass
+class SeriesSearch:
+    name: str
+    volume: int | None = None
+    year: int | None = None
+    comicvine: int | None = None
+    metron: int | None = None
+
+
+@dataclass
+class IssueSearch:
+    number: str | None = None
+    comicvine: int | None = None
+    metron: int | None = None
+
+
+@dataclass
+class Search:
+    series: SeriesSearch
+    issue: IssueSearch
+    filename: str
+
+    @staticmethod
+    def build(comic: Comic) -> "Search":
+        if (
+            (metron_info := comic.get_metadata(MetronInfo))
+            and metron_info.series
+            and metron_info.series.name
+        ):
+            return search_from_metron_info(metadata=metron_info, filename=comic.file.stem)
+        if (comic_info := comic.get_metadata(ComicInfo)) and comic_info.series:
+            return search_from_comic_info(metadata=comic_info, filename=comic.file.stem)
+        return search_from_filename(filename=comic.file.stem)
+
+
+def get_id(ids: list[Id], source: InformationSource) -> str | None:
+    return next((x.value for x in ids if x.source is source), None)
+
+
+def search_from_metron_info(metadata: MetronInfo, filename: str) -> Search:
+    series_id = metadata.series.id
+    comicvine_id = get_id(metadata.ids, InformationSource.COMIC_VINE)
+    metron_id = get_id(metadata.ids, InformationSource.METRON)
+    source = next((x.source for x in metadata.ids if x.primary), None)
+    return Search(
+        series=SeriesSearch(
+            name=metadata.series.name,
+            volume=metadata.series.volume,
+            year=metadata.series.start_year,
+            comicvine=int(series_id)
+            if series_id and source == InformationSource.COMIC_VINE
+            else None,
+            metron=int(series_id) if series_id and source == InformationSource.METRON else None,
+        ),
+        issue=IssueSearch(
+            number=metadata.number,
+            comicvine=int(comicvine_id) if comicvine_id else None,
+            metron=int(metron_id) if metron_id else None,
+        ),
+        filename=filename,
+    )
+
+
+def search_from_comic_info(metadata: ComicInfo, filename: str) -> Search:
+    volume = metadata.volume
+    year = volume if volume and volume > 1900 else None
+    volume = volume if volume and volume < 1900 else None
+    return Search(
+        series=SeriesSearch(name=metadata.series or filename, volume=volume, year=year),
+        issue=IssueSearch(number=metadata.number),
+        filename=filename,
+    )
+
+
+def search_from_filename(filename: str) -> Search:
+    series_name = comicfn2dict(filename).get("series", filename)
+    series_name = str(series_name).replace("-", " ")
+    return Search(series=SeriesSearch(name=series_name), issue=IssueSearch(), filename=filename)

perdoo/services/comicvine.py

@@ -14,13 +14,13 @@
 from simyan.schemas.volume import Volume
 
 from perdoo import get_cache_home
-from perdoo.services._base import BaseService
-from perdoo.utils import IssueSearch, Search, SeriesSearch
+from perdoo.services._base import prompt_select
+from perdoo.services._models import IssueSearch, MetadataResult, Search, SeriesSearch
 
 LOGGER = logging.getLogger(__name__)
 
 
-class Comicvine(BaseService[Volume, Issue]):
+class Comicvine:
     def __init__(self, api_key: str):
         self.session = Simyan(
             api_key=api_key,
@@ -63,7 +63,7 @@ def _search_series(
                     )
                     for x in options
                 ]
-                selected = self._prompt_select(
+                selected = prompt_select(
                     message=f"Searching Comicvine for Volumes matching '{filename}'"
                     if not year
                     else f"Searching Comicvine for Volume '{search}'",
@@ -124,7 +124,7 @@ def _search_issue(self, series_id: int, number: str | None, filename: str) -> in
                     )
                     for x in options
                 ]
-                selected = self._prompt_select(
+                selected = prompt_select(
                     message=f"Searching Comicvine for Issues matching '{filename}'"
                     if not number
                     else f"Searching Comicvine for Issues with number '{number}'",
@@ -160,7 +160,7 @@ def fetch_issue(self, series_id: int, search: IssueSearch, filename: str) -> Iss
             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:
+    def _build_metron_info(self, series: Volume, issue: Issue) -> MetronInfo | None:
         from comic_archive.metadata.metron_info import (  # noqa: PLC0415
             Arc,
             Credit,
@@ -224,7 +224,7 @@ def load_role(value: str) -> Role:
             universes=[],
         )
 
-    def _process_comic_info(self, series: Volume, issue: Issue) -> ComicInfo | None:
+    def _build_comic_info(self, series: Volume, issue: Issue) -> ComicInfo | None:
         comic_info = ComicInfo(
             title=issue.name,
             series=series.name,
@@ -248,7 +248,7 @@ def _process_comic_info(self, series: Volume, issue: Issue) -> ComicInfo | None:
 
         return comic_info
 
-    def fetch(self, search: Search) -> tuple[MetronInfo | None, ComicInfo | None]:
+    def fetch(self, search: Search) -> MetadataResult:
         if not search.series.comicvine and search.issue.comicvine:
             try:
                 temp = self.session.get_issue(issue_id=search.issue.comicvine)
@@ -258,13 +258,13 @@ def fetch(self, search: Search) -> tuple[MetronInfo | None, ComicInfo | None]:
 
         series = self.fetch_series(search=search.series, filename=search.filename)
         if not series:
-            return None, None
+            return MetadataResult()
 
         issue = self.fetch_issue(series_id=series.id, search=search.issue, filename=search.filename)
         if not issue:
-            return None, None
+            return MetadataResult()
 
-        metron_info = self._process_metron_info(series=series, issue=issue)
-        comic_info = self._process_comic_info(series=series, issue=issue)
-
-        return metron_info, comic_info
+        return MetadataResult(
+            comic_info=self._build_comic_info(series=series, issue=issue),
+            metron_info=self._build_metron_info(series=series, issue=issue),
+        )

perdoo/utils.py

@@ -1,55 +1,23 @@
 __all__ = [
-    "IssueSearch",
-    "Search",
-    "SeriesSearch",
     "delete_empty_folders",
     "display",
     "flatten_dict",
-    "get_id",
     "list_files",
     "recursive_delete",
     "sanitize",
 ]
 
-import logging
 import re
-from dataclasses import dataclass
 from pathlib import Path
 from typing import Any, Literal
 
 from comic_archive.metadata import ComicInfo, MetronInfo
-from comic_archive.metadata.metron_info import Id, InformationSource
 from msgspec import to_builtins
 from natsort import humansorted, ns
 from rich.panel import Panel
 
 from perdoo.console import CONSOLE
 
-LOGGER = logging.getLogger(__name__)
-
-
-@dataclass
-class SeriesSearch:
-    name: str
-    volume: int | None = None
-    year: int | None = None
-    comicvine: int | None = None
-    metron: int | None = None
-
-
-@dataclass
-class IssueSearch:
-    number: str | None = None
-    comicvine: int | None = None
-    metron: int | None = None
-
-
-@dataclass
-class Search:
-    series: SeriesSearch
-    issue: IssueSearch
-    filename: str
-
 
 def list_files(path: Path, *extensions: str) -> list[Path]:
     files = []
@@ -94,7 +62,7 @@ def delete_empty_folders(folder: Path) -> None:
                 delete_empty_folders(subfolder)
         if not any(folder.iterdir()):
             folder.rmdir()
-            LOGGER.info("Deleted empty folder: %s", folder)
+            CONSOLE.print(f"Deleted empty folder: {folder.name!r}")
 
 
 def display(data: ComicInfo | MetronInfo, title: str | None = None) -> None:
@@ -110,10 +78,6 @@ def encoder(obj: object) -> object:
     CONSOLE.print(Panel.fit("\n".join(data_vals), title=title))
 
 
-def get_id(ids: list[Id], source: InformationSource) -> str | None:
-    return next((x.value for x in ids if x.source is source), None)
-
-
 def sanitize(value: str | int | None, seperator: Literal["-", "_", ".", " "]) -> str | None:
     if value is None:
         return value