Merge pull request #21 from chrisis58/dev-version

feat: 优化非交互式的输出

Author: chrisis58

.github/workflows/release-package.yml

@@ -15,6 +15,9 @@ jobs:
     steps:
     - name: Checkout code
       uses: actions/checkout@v4
+      with:
+        # Ensure full history for versioning tools `setuptools-scm`
+        fetch-depth: 0
 
     - name: Set up Python
       uses: actions/setup-python@v5

.gitignore

@@ -17,4 +17,7 @@ __pycache__/
 *$py.class
 
 *.egg-info/
-dist/
+dist/
+
+# version file generated by setuptools-scm
+src/kmdr/_version.py

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kmoe-manga-downloader"
-version = "1.2.2"
+dynamic = ["version"]
 authors = [
     { name="Chris Zheng", email="chrisis58@outlook.com" },
 ]
@@ -36,5 +36,12 @@ kmdr = "kmdr.main:entry_point"
 [tool.setuptools]
 package-dir = {"" = "src"}
 
+[build-system]
+requires = ["setuptools>=61.0", "setuptools-scm[toml]>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "src/kmdr/_version.py"
+
 [tool.pytest.ini_options]
 pythonpath = "src"

src/kmdr/__init__.py

@@ -0,0 +1,4 @@
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "unknown"

src/kmdr/core/__init__.py

@@ -2,8 +2,10 @@
 from .structure import VolInfo, BookInfo, VolumeType
 from .bases import AUTHENTICATOR, LISTERS, PICKERS, DOWNLOADER, CONFIGURER, SESSION_MANAGER
 
-from .defaults import argument_parser, console
+from .defaults import argument_parser, post_init
 
 from .error import KmdrError, LoginError
 
-from .session import KmdrSessionManager
+from .session import KmdrSessionManager
+
+from .console import info, debug, exception, log

src/kmdr/core/bases.py

@@ -4,6 +4,7 @@
 import asyncio
 from aiohttp import ClientSession
 
+from .console import *
 from .error import LoginError
 from .registry import Registry
 from .structure import VolInfo, BookInfo
@@ -41,8 +42,8 @@ async def authenticate(self) -> None:
             try:
                 assert await async_retry()(self._authenticate)()
             except LoginError as e:
-                self._console.print(f"[yellow]详细信息：{e}[/yellow]")
-                self._console.print("[red]认证失败。请检查您的登录凭据或会话 cookie。[/red]")
+                info(f"[yellow]详细信息：{e}[/yellow]")
+                info("[red]认证失败。请检查您的登录凭据或会话 cookie。[/red]")
                 exit(1)
 
     @abstractmethod
@@ -82,16 +83,24 @@ def __init__(self,
 
     async def download(self, book: BookInfo, volumes: list[VolInfo]):
         if not volumes:
-            self._console.print("没有可下载的卷。", style="blue")
+            info("没有可下载的卷。", style="blue")
             exit(0)
 
         try:
             with self._progress:
                 tasks = [self._download(book, volume) for volume in volumes]
-                await asyncio.gather(*tasks, return_exceptions=True)
+                results = await asyncio.gather(*tasks, return_exceptions=True)
+
+            exceptions = [res for res in results if isinstance(res, Exception)]
+            if exceptions:
+                info(f"[red]下载过程中出现 {len(exceptions)} 个错误：[/red]")
+                for exc in exceptions:
+                    info(f"[red]- {exc}[/red]")
+                    exception(exc)
+                exit(1)
 
         except KeyboardInterrupt:
-            self._console.print("\n操作已取消（KeyboardInterrupt）")
+            info("\n操作已取消（KeyboardInterrupt）")
             exit(130)
 
     @abstractmethod

src/kmdr/core/console.py

@@ -0,0 +1,67 @@
+"""
+KMDR 用于管理控制台输出的模块。
+
+提供信息、调试和日志记录功能，确保在交互式和非交互式环境中均能正确输出。
+"""
+from typing import Any
+import sys
+import io
+
+from rich.console import Console
+from rich.traceback import Traceback
+
+from kmdr.core.defaults import is_verbose
+
+_console_config = dict[str, Any](
+    log_time_format="[%Y-%m-%d %H:%M:%S]",
+)
+
+try:
+    utf8_stdout = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8', errors='backslashreplace')
+    _console_config['file'] = utf8_stdout
+except io.UnsupportedOperation:
+    pass
+
+_console = Console(**_console_config)
+
+def info(*args, **kwargs):
+    """
+    在终端中输出信息
+    
+    会根据终端是否为交互式选择合适的输出方式。
+    """
+    if _console.is_interactive:
+        _console.print(*args, **kwargs)
+    else:
+        _console.log(*args, **kwargs, _stack_offset=2)
+
+def debug(*args, **kwargs):
+    """
+    在终端中输出调试信息
+    
+    `info` 的条件版本，仅当启用详细模式时才会输出。
+    """
+    if is_verbose():
+        if _console.is_interactive:
+            _console.print("[dim]DEBUG:[/]", *args, **kwargs)
+        else:
+            _console.log("DEBUG:", *args, **kwargs, _stack_offset=2)
+
+def log(*args, debug=False, **kwargs):
+    """
+    仅在非交互式终端中记录日志信息
+
+    :warning: 仅在非交互式终端中输出日志信息，避免干扰交互式用户界面。
+    """
+    if _console.is_interactive:
+        # 如果是交互式终端，则不记录日志
+        return
+
+    if debug and is_verbose():
+        # 仅在调试模式和启用详细模式时记录调试日志
+        _console.log("DEBUG:", *args, **kwargs, _stack_offset=2)
+    else:
+        _console.log(*args, **kwargs, _stack_offset=2)
+
+def exception(exception: Exception):
+    _console.print((Traceback.from_exception(type(exception), exception, exception.__traceback__)))

src/kmdr/core/context.py

@@ -1,14 +1,25 @@
+from typing import Optional
+
 from aiohttp import ClientSession
+from rich.progress import Progress
 
+from .defaults import Configurer as InnerConfigurer, UserProfile, session_var, base_url_var, progress_definition
+from .console import _console
 
-from .defaults import Configurer as InnerConfigurer, UserProfile, session_var, progress, console, base_url_var
+_lazy_progress: Optional[Progress] = None
 
 class TerminalContext:
 
     def __init__(self, *args, **kwargs):
         super().__init__()
-        self._progress = progress
-        self._console = console
+        self._console = _console
+
+    @property
+    def _progress(self) -> Progress:
+        global _lazy_progress
+        if _lazy_progress is None:
+            _lazy_progress = Progress(*progress_definition, console=self._console)
+        return _lazy_progress
 
 class UserProfileContext:
 

src/kmdr/core/defaults.py

@@ -1,3 +1,5 @@
+import io
+import sys
 import os
 import json
 from typing import Optional, Any
@@ -21,12 +23,8 @@
     'User-Agent': 'kmdr/1.0 (https://github.com/chrisis58/kmoe-manga-downloader)'
 }
 
-console = Console()
 
-def console_print(*args, **kwargs):
-    console.print(*args, **kwargs)
-
-progress = Progress(
+progress_definition = (
     TextColumn("[blue]{task.fields[filename]}", justify="left"),
     TextColumn("{task.fields[status]}", justify="right"),
     TextColumn("{task.percentage:>3.1f}%"),
@@ -38,7 +36,6 @@ def console_print(*args, **kwargs):
     ",",
     TimeRemainingColumn(),
     "]",
-    console=console,
 )
 
 session_var = ContextVar('session')
@@ -52,8 +49,13 @@ def argument_parser():
         return parser
 
     parser = argparse.ArgumentParser(description='Kmoe 漫画下载器')
+
+    parser.add_argument('-v', '--verbose', action='store_true', help='启用详细输出')
+
     subparsers = parser.add_subparsers(title='可用的子命令', dest='command')
 
+    version_parser = subparsers.add_parser('version', help='显示当前版本信息')
+
     download_parser = subparsers.add_parser('download', help='下载指定的漫画')
     download_parser.add_argument('-d', '--dest', type=str, help='指定下载文件的保存路径，默认为当前目录', required=False)
     download_parser.add_argument('-l', '--book-url', type=str, help='漫画详情页面的 URL', required=False)
@@ -65,6 +67,7 @@ def argument_parser():
     download_parser.add_argument('-p', '--proxy', type=str, help='设置下载使用的代理服务器', required=False)
     download_parser.add_argument('-r', '--retry', type=int, help='网络请求失败时的重试次数', required=False)
     download_parser.add_argument('-c', '--callback', type=str, help='每个卷下载完成后执行的回调脚本，例如: `echo {v.name} downloaded!`', required=False)
+    download_parser.add_argument('-m', '--method', type=int, help='下载方法，对应网站上的不同下载方式', required=False, choices=[1, 2], default=1)
 
     login_parser = subparsers.add_parser('login', help='登录到 Kmoe')
     login_parser.add_argument('-u', '--username', type=str, help='用户名', required=True)
@@ -185,7 +188,7 @@ def set_base_url(self, value: str):
         self._config.base_url = value
         self.update()
 
-    def get_base_url(self) -> str:
+    def get_base_url(self) -> Optional[str]:
         return self._config.base_url
 
     def update(self):
@@ -237,3 +240,12 @@ def combine_args(dest: argparse.Namespace) -> argparse.Namespace:
     return __combine_args(dest, option)
 
 base_url_var = ContextVar('base_url', default=Configurer().base_url)
+
+_verbose = False
+
+def is_verbose() -> bool:
+    return _verbose
+
+def post_init(args) -> None:
+    global _verbose
+    _verbose = getattr(args, 'verbose', False)

src/kmdr/core/error.py

@@ -14,6 +14,13 @@ def __init__(self, message, solution: Optional[list[str]] = None):
     def __str__(self):
         return f"{self.message}\n{self._solution}"
 
+class ArgsResolveError(KmdrError):
+    def __init__(self, message, solution: Optional[list[str]] = None):
+        super().__init__(message, solution)
+
+    def __str__(self):
+        return f"{self.message}\n{self._solution}"
+
 class LoginError(KmdrError):
     def __init__(self, message, solution: Optional[list[str]] = None):
         super().__init__(message, solution)