Tidy up logging and settings

Author: Buried-In-Code

perdoo/__init__.py

@@ -58,7 +58,7 @@ def setup_logging(debug: bool = False) -> None:
         omit_repeated_times=False,
         show_level=True,
         show_time=False,
-        show_path=debug,
+        show_path=True,
         console=CONSOLE,
     )
     console_handler.setLevel(logging.DEBUG if debug else logging.INFO)
@@ -72,4 +72,6 @@ def setup_logging(debug: bool = False) -> None:
         handlers=[console_handler, file_handler],
     )
 
-    logging.getLogger("PIL").setLevel(logging.WARNING)
+    logging.getLogger("PIL").setLevel(logging.INFO if debug else logging.WARNING)
+    logging.getLogger("httpx").setLevel(logging.INFO if debug else logging.WARNING)
+    logging.getLogger("httpcore").setLevel(logging.INFO if debug else logging.WARNING)

perdoo/cli/process.py

@@ -17,7 +17,7 @@
 from perdoo.comic.metadata.metron_info import Id, InformationSource
 from perdoo.console import CONSOLE
 from perdoo.services import BaseService, Comicvine, Metron
-from perdoo.settings import Naming, Output, Service, Services, Settings
+from perdoo.settings import SETTINGS, Service
 from perdoo.utils import (
     IssueSearch,
     Search,
@@ -36,19 +36,19 @@ class SyncOption(str, Enum):
     SKIP = "Skip"
 
 
-def get_services(settings: Services) -> dict[Service, BaseService]:
+def get_services() -> dict[Service, BaseService]:
     output = {}
-    if settings.comicvine.api_key:
-        output[Service.COMICVINE] = Comicvine(api_key=settings.comicvine.api_key)
-    if settings.metron.username and settings.metron.password:
+    if SETTINGS.services.comicvine.api_key:
+        output[Service.COMICVINE] = Comicvine(api_key=SETTINGS.services.comicvine.api_key)
+    if SETTINGS.services.metron.username and SETTINGS.services.metron.password:
         output[Service.METRON] = Metron(
-            username=settings.metron.username, password=settings.metron.password
+            username=SETTINGS.services.metron.username, password=SETTINGS.services.metron.password
         )
     return output
 
 
 def setup_environment(
-    clean_cache: bool, sync: SyncOption, settings: Settings, debug: bool = False
+    clean_cache: bool, sync: SyncOption, debug: bool = False
 ) -> tuple[dict[Service, BaseService], SyncOption]:
     setup_logging(debug=debug)
     LOGGER.info("Python v%s", python_version())
@@ -58,7 +58,7 @@ def setup_environment(
         LOGGER.info("Cleaning Cache")
         recursive_delete(path=get_cache_root())
 
-    services = get_services(settings=settings.services)
+    services = get_services()
     if not services and sync is not SyncOption.SKIP:
         LOGGER.warning("No external services configured")
         sync = SyncOption.SKIP
@@ -76,9 +76,9 @@ def load_comics(target: Path) -> list[Comic]:
     return comics
 
 
-def prepare_comic(entry: Comic, settings: Settings, skip_convert: bool) -> bool:
+def prepare_comic(entry: Comic, skip_convert: bool) -> bool:
     if not skip_convert:
-        entry.convert_to(settings.output.format)
+        entry.convert_to(SETTINGS.output.format)
     if not entry.archive.IS_WRITEABLE:
         LOGGER.warning("Archive format %s is not writeable", entry.archive.EXTENSION)
         return False
@@ -163,29 +163,23 @@ def sync_metadata(
 
 
 def resolve_metadata(
-    entry: Comic,
-    session: ArchiveSession,
-    services: dict[Service, BaseService],
-    settings: Services,
-    sync: SyncOption,
+    entry: Comic, session: ArchiveSession, services: dict[Service, BaseService], sync: SyncOption
 ) -> tuple[MetronInfo | None, ComicInfo | None]:
     metron_info, comic_info = entry.read_metadata(session=session)
     if not should_sync_metadata(sync=sync, metron_info=metron_info):
         return metron_info, comic_info
     search = build_search(
         metron_info=metron_info, comic_info=comic_info, filename=entry.filepath.stem
     )
-    return sync_metadata(search=search, services=services, service_order=settings.order)
+    return sync_metadata(search=search, services=services, service_order=SETTINGS.services.order)
 
 
-def generate_naming(
-    settings: Naming, metron_info: MetronInfo | None, comic_info: ComicInfo | None
-) -> str | None:
+def generate_naming(metron_info: MetronInfo | None, comic_info: ComicInfo | None) -> str | None:
     filepath = None
     if metron_info:
-        filepath = metron_info.get_filename(settings=settings)
+        filepath = metron_info.get_filename()
     if not filepath and comic_info:
-        filepath = comic_info.get_filename(settings=settings)
+        filepath = comic_info.get_filename()
     return filepath.lstrip("/") if filepath else None
 
 
@@ -196,7 +190,6 @@ def apply_changes(
     comic_info: ComicInfo | None,
     skip_clean: bool,
     skip_rename: bool,
-    settings: Output,
 ) -> str | None:
     local_metron_info, local_comic_info = entry.read_metadata(session=session)
     if local_metron_info != metron_info:
@@ -212,16 +205,14 @@ def apply_changes(
             session.delete(filename=ComicInfo.FILENAME)
 
     if not skip_clean:
-        for extra in entry.list_extras():
+        for extra in entry.list_extras(image_extensions=SETTINGS.output.image_extensions):
             session.delete(filename=extra.name)
 
     naming = None
     if not skip_rename and (
-        naming := generate_naming(
-            settings=settings.naming, metron_info=metron_info, comic_info=comic_info
-        )
+        naming := generate_naming(metron_info=metron_info, comic_info=comic_info)
     ):
-        images = entry.list_images()
+        images = entry.list_images(image_extensions=SETTINGS.output.image_extensions)
         stem = Path(naming).stem
         pad = len(str(len(images)))
         for idx, img in enumerate(images):
@@ -268,11 +259,7 @@ def process(
         bool, Option("--debug", help="Enable debug mode to show extra information.")
     ] = False,
 ) -> None:
-    settings = Settings.load()
-    settings.save()
-    services, sync = setup_environment(
-        clean_cache=clean_cache, sync=sync, settings=settings, debug=debug
-    )
+    services, sync = setup_environment(clean_cache=clean_cache, sync=sync, debug=debug)
 
     comics = load_comics(target=target)
     total = len(comics)
@@ -281,15 +268,11 @@ def process(
             f"[{index}/{total}] Importing {entry.filepath.name}", align="left", style="subtitle"
         )
 
-        if not prepare_comic(entry=entry, settings=settings, skip_convert=skip_convert):
+        if not prepare_comic(entry=entry, skip_convert=skip_convert):
             continue
         with entry.open_session() as session:
             metron_info, comic_info = resolve_metadata(
-                entry=entry,
-                session=session,
-                services=services,
-                settings=settings.services,
-                sync=sync,
+                entry=entry, session=session, services=services, sync=sync
             )
             naming = apply_changes(
                 entry=entry,
@@ -298,10 +281,9 @@ def process(
                 comic_info=comic_info,
                 skip_clean=skip_clean,
                 skip_rename=skip_rename,
-                settings=settings.output,
             )
         if naming:
-            entry.move_to(naming=naming, output_folder=settings.output.folder)
+            entry.move_to(naming=naming, output_folder=SETTINGS.output.folder)
     with CONSOLE.status("Cleaning up empty folders"):
         delete_empty_folders(folder=target)
 

perdoo/cli/settings.py

@@ -1,10 +1,9 @@
 __all__ = []
 
 from perdoo.cli._typer import app
-from perdoo.settings import Settings
+from perdoo.settings import SETTINGS
 
 
 @app.command(help="Display app settings and defaults.")
 def settings() -> None:
-    settings = Settings.load()
-    settings.display()
+    SETTINGS.display()

perdoo/comic/comic.py

@@ -1,4 +1,4 @@
-__all__ = ["IMAGE_EXTENSIONS", "Comic"]
+__all__ = ["Comic"]
 
 import logging
 import shutil
@@ -13,7 +13,6 @@
 LOGGER = logging.getLogger(__name__)
 
 METADATA_FILENAMES: Final[frozenset[str]] = frozenset([MetronInfo.FILENAME, ComicInfo.FILENAME])
-IMAGE_EXTENSIONS: Final[frozenset[str]] = frozenset([".png", ".jpg", ".jpeg", ".webp", ".jxl"])
 
 
 class Comic:
@@ -45,33 +44,38 @@ def read_metadata(self, session: ArchiveSession) -> tuple[MetronInfo | None, Com
             comic_info = ComicInfo.from_bytes(content=session.read(filename=ComicInfo.FILENAME))
         return metron_info, comic_info
 
-    def list_images(self) -> list[Path]:
+    def list_images(self, image_extensions: tuple[str, ...]) -> list[Path]:
         return humansorted(
             [
                 Path(name)
                 for name in self.archive.list_filenames()
-                if Path(name).suffix.lower() in IMAGE_EXTENSIONS
+                if Path(name).suffix.lower() in image_extensions
             ],
             alg=ns.NA | ns.G | ns.P,
         )
 
-    def list_extras(self) -> list[Path]:
+    def list_extras(self, image_extensions: tuple[str, ...]) -> list[Path]:
         return humansorted(
             [
                 Path(name)
                 for name in self.archive.list_filenames()
                 if name not in METADATA_FILENAMES
-                and Path(name).suffix.lower() not in IMAGE_EXTENSIONS
+                and Path(name).suffix.lower() not in image_extensions
             ],
             alg=ns.NA | ns.G | ns.P,
         )
 
-    def validate_naming(self, naming: str) -> bool:
+    def validate_naming(self, naming: str, image_extensions: tuple[str, ...]) -> bool:
         template = Path(naming).stem
-        return all(img.name.startswith(template) for img in self.list_images())
+        return all(
+            img.name.startswith(template)
+            for img in self.list_images(image_extensions=image_extensions)
+        )
 
     def move_to(self, naming: str, output_folder: Path) -> None:
         output = output_folder / (naming + self.archive.EXTENSION)
+        if output == self.archive.filepath.resolve():
+            return
         if output.exists():
             LOGGER.warning("'%s' already exists, skipping", output)
             return

perdoo/comic/metadata/_base.py

@@ -13,7 +13,6 @@
 from rich.panel import Panel
 
 from perdoo.console import CONSOLE
-from perdoo.settings import Naming
 from perdoo.utils import flatten_dict
 
 try:
@@ -52,7 +51,7 @@ class Metadata(PascalModel, ABC):
     FILENAME: ClassVar[str] = ""
 
     @abstractmethod
-    def get_filename(self, settings: Naming) -> str: ...
+    def get_filename(self) -> str: ...
 
     @classmethod
     def from_bytes(cls, content: bytes) -> Self:

perdoo/comic/metadata/comic_info.py

@@ -11,7 +11,7 @@
 from pydantic_xml import attr, computed_attr, element, wrapped
 
 from perdoo.comic.metadata._base import Metadata, PascalModel
-from perdoo.settings import Naming
+from perdoo.settings import SETTINGS
 
 LOGGER = logging.getLogger(__name__)
 
@@ -280,9 +280,11 @@ def story_arc_list(self) -> list[str]:
     def story_arc_list(self, value: list[str]) -> None:
         self.story_arc = list_to_str(value=value)
 
-    def get_filename(self, settings: Naming) -> str:
+    def get_filename(self) -> str:
         from perdoo.comic.metadata.metron_info import Format  # noqa: PLC0415
 
+        settings = SETTINGS.output.naming
+
         return self.evaluate_pattern(
             pattern_map=PATTERN_MAP,
             pattern={

perdoo/comic/metadata/metron_info.py

@@ -28,7 +28,7 @@
 from pydantic_xml import attr, computed_attr, element, wrapped
 
 from perdoo.comic.metadata._base import Metadata, PascalModel
-from perdoo.settings import Naming
+from perdoo.settings import SETTINGS
 
 LOGGER = logging.getLogger(__name__)
 T = TypeVar("T")
@@ -369,7 +369,9 @@ class MetronInfo(Metadata):
     def schema_location(self) -> str:
         return "https://raw.githubusercontent.com/Metron-Project/metroninfo/master/schema/v1.0/MetronInfo.xsd"
 
-    def get_filename(self, settings: Naming) -> str:
+    def get_filename(self) -> str:
+        settings = SETTINGS.output.naming
+
         return self.evaluate_pattern(
             pattern_map=PATTERN_MAP,
             pattern={

perdoo/services/metron.py

@@ -44,7 +44,7 @@ def _search_series(
         try:
             options = sorted(
                 self.session.list_series(name=name, volume=volume, year_began=year),
-                key=lambda x: (x.display_name, x.volume),
+                key=lambda x: (x.name, x.volume),
             )
             if options:
                 search = name
@@ -56,7 +56,7 @@ def _search_series(
                     Choice(
                         title=[
                             ("class:dim", f"{x.id} | "),
-                            ("class:title", f"{x.display_name} v{x.volume}"),
+                            ("class:title", f"{x.name} v{x.volume}"),
                         ],
                         description=f"https://metron.cloud/series/{x.id}",
                         value=x,
@@ -124,13 +124,13 @@ def _search_issue(self, series_id: int, number: str | None, filename: str) -> in
         try:
             options = humansorted(
                 self.session.list_issues(series_id=series_id, number=number),
-                key=lambda x: (x.number, x.issue_name),
+                key=lambda x: (x.number, x.name),
                 alg=ns.NA | ns.G,
             )
             if options:
                 choices = [
                     Choice(
-                        title=[("class:dim", f"{x.id} | "), ("class:title", x.issue_name)],
+                        title=[("class:dim", f"{x.id} | "), ("class:title", x.name)],
                         description=f"https://metron.cloud/issues/{x.id}",
                         value=x,
                     )

perdoo/settings.py

@@ -1,14 +1,4 @@
-__all__ = [
-    "ComicInfo",
-    "Comicvine",
-    "Metron",
-    "MetronInfo",
-    "Naming",
-    "Output",
-    "Service",
-    "Services",
-    "Settings",
-]
+__all__ = ["SETTINGS"]
 
 from enum import Enum
 from pathlib import Path
@@ -75,6 +65,7 @@ class Output(SettingsModel):
     comic_info: ComicInfo = ComicInfo()
     folder: Path = get_data_root()
     format: Literal["cbz", "cbt", "cb7"] = "cbz"
+    image_extensions: tuple[str, ...] = (".png", ".jpg", ".jpeg", ".webp", ".jxl")
     metron_info: MetronInfo = MetronInfo()
     naming: Naming = Naming()
 
@@ -163,3 +154,6 @@ def display(cls) -> None:
 
         CONSOLE.print(Panel.fit("\n".join(default_vals), title="Default"))
         CONSOLE.print(Panel.fit("\n".join(override_vals), title=str(cls._file)))
+
+
+SETTINGS = Settings.load().save()

tests/comic/comic_test.py

@@ -37,7 +37,9 @@ def test_clean_archive(cbz_comic: Comic) -> None:
     )
     cbz_comic.archive.delete_file = MagicMock()
     with cbz_comic.open_session() as session:
-        for extra in cbz_comic.list_extras():
+        for extra in cbz_comic.list_extras(
+            image_extensions=(".png", ".jpg", ".jpeg", ".webp", ".jxl")
+        ):
             session.delete(filename=extra.name)
     cbz_comic.archive.delete_file.assert_called_once_with(filename="info.txt")