Revert py7zr dependency (#38)

Author: Buried-In-Code

.pre-commit-config.yaml

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

README.md

@@ -74,13 +74,13 @@ Unlike other tagging tools, Perdoo employs a manual approach when metadata files
 - .cbr
 - .cbt
 - .cbz
-- .cb7
+- .cb7 _(Requires installing `cb7` dependencies: `pipx install perdoo[cb7]`)_
 
 ### Output Extensions
 
 - .cbt
 - .cbz _(Default)_
-- .cb7
+- .cb7 _(Requires installing `cb7` dependencies: `pipx install perdoo[cb7]`)_
 
 ### Metadata Files
 

perdoo/archives/__init__.py

@@ -12,7 +12,6 @@
 from tarfile import is_tarfile
 from zipfile import is_zipfile
 
-from py7zr import is_7zfile
 from rarfile import is_rarfile
 
 from perdoo.archives._base import BaseArchive
@@ -21,6 +20,13 @@
 from perdoo.archives.cbt import CBTArchive
 from perdoo.archives.cbz import CBZArchive
 
+try:
+    from py7zr import is_7zfile
+
+    py7zr_loaded = True
+except ImportError:
+    py7zr_loaded = False
+
 
 def get_archive(path: Path) -> BaseArchive:
     if is_zipfile(path):
@@ -29,17 +35,15 @@ def get_archive(path: Path) -> BaseArchive:
         return CBRArchive(path=path)
     if is_tarfile(path):
         return CBTArchive(path=path)
-    if is_7zfile(path):
+    if py7zr_loaded and is_7zfile(path):
         return CB7Archive(path=path)
     raise NotImplementedError(f"{path.name} is an unsupported archive")
 
 
 def get_archive_class(extension: str) -> type[BaseArchive]:
-    if archive_class := {
-        "cbz": CBZArchive,
-        "cbr": CBRArchive,
-        "cbt": CBTArchive,
-        "cb7": CB7Archive,
-    }.get(extension):
-        return archive_class
+    archive_types = {"cbz": CBZArchive, "cbr": CBRArchive, "cbt": CBTArchive}
+    if extension == "cb7" and py7zr_loaded:
+        return CB7Archive
+    if extension in archive_types:
+        return archive_types[extension]
     raise NotImplementedError(f"{extension} is an unsupported archive")

perdoo/archives/cb7.py

@@ -6,15 +6,25 @@
 from tempfile import TemporaryDirectory
 from typing import Optional
 
-from py7zr import Bad7zFile, SevenZipFile
-
 from perdoo.archives._base import BaseArchive
 from perdoo.utils import list_files
 
+try:
+    from py7zr import Bad7zFile, SevenZipFile
+
+    py7zr_loaded = True
+except ImportError:
+    py7zr_loaded = False
+
 LOGGER = logging.getLogger(__name__)
 
 
 class CB7Archive(BaseArchive):
+    def __init__(self, path: Path):
+        if not py7zr_loaded:
+            raise ImportError("Install Perdoo with the cb7 dependency group to use CB7 files.")
+        super().__init__(path=path)
+
     def list_filenames(self) -> list[str]:
         try:
             with SevenZipFile(self.path, "r") as archive:
@@ -42,6 +52,9 @@ def extract_files(self, destination: Path) -> bool:
 
     @classmethod
     def archive_files(cls, src: Path, output_name: str, files: list[Path]) -> Path | None:
+        if not py7zr_loaded:
+            raise ImportError("Install Perdoo with the cb7 dependency group to use CB7 files.")
+
         output_file = src.parent / f"{output_name}.cb7"
         try:
             with SevenZipFile(output_file, "w") as archive:
@@ -54,6 +67,9 @@ def archive_files(cls, src: Path, output_name: str, files: list[Path]) -> Path |
 
     @staticmethod
     def convert(old_archive: BaseArchive) -> Optional["CB7Archive"]:
+        if not py7zr_loaded:
+            raise ImportError("Install Perdoo with the cb7 dependency group to use CB7 files.")
+
         with TemporaryDirectory(prefix=f"{old_archive.path.stem}_") as temp_str:
             temp_folder = Path(temp_str)
             if not old_archive.extract_files(destination=temp_folder):

perdoo/settings.py

@@ -12,11 +12,12 @@
 ]
 
 from enum import Enum
+from importlib.util import find_spec
 from pathlib import Path
 from typing import Any, ClassVar, Literal
 
 import tomli_w as tomlwriter
-from pydantic import BaseModel
+from pydantic import BaseModel, field_validator
 from rich.panel import Panel
 
 from perdoo import get_config_root, get_data_root
@@ -58,6 +59,12 @@ class Output(SettingsModel):
     format: Literal["cb7", "cbt", "cbz"] = "cbz"
     metadata: Metadata = Metadata()
 
+    @field_validator("format", mode="before")
+    def validate_format(cls, value: str) -> str:
+        if value == "cb7" and find_spec("py7zr") is None:
+            raise ImportError("Install Perdoo with the cb7 dependency group to use CB7 files.")
+        return value
+
 
 class Comicvine(SettingsModel):
     api_key: str | None = None

pyproject.toml

@@ -10,7 +10,7 @@ tests = [
   "pytest >= 8.3.4",
   "pytest-cov >= 6.0.0",
   "tox >= 4.23.2",
-  "tox-uv >= 1.16.1"
+  "tox-uv >= 1.17.0"
 ]
 
 [project]
@@ -39,9 +39,8 @@ dependencies = [
   "lxml >= 5.3.0",
   "mokkari >= 3.5.0",
   "natsort >= 8.4.0",
-  "pillow >= 11.0.0",
-  "py7zr >= 0.22.0",
-  "pydantic >= 2.10.4",
+  "pillow >= 11.1.0",
+  "pydantic >= 2.10.5",
   "pydantic-xml >= 2.14.1",
   "rarfile >= 4.2",
   "rich >= 13.9.4",
@@ -58,6 +57,11 @@ name = "perdoo"
 readme = "README.md"
 requires-python = ">= 3.10"
 
+[project.optional-dependencies]
+cb7 = [
+  "py7zr >= 0.22.0"
+]
+
 [project.scripts]
 Perdoo = "perdoo.__main__:app"