kmoe-manga-downloader 1.2.1__tar.gz → 1.2.3__tar.gz

kmoe_manga_downloader-1.2.3/.github/workflows/release-package.yml

@@ -0,0 +1,45 @@
+name: Release Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: write
+
+    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
+      with:
+        python-version: '3.9'
+
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build package
+      run: python -m build
+
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+    - name: Upload assets to GitHub Release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: dist/*
+        tag: ${{ github.ref }}
+        overwrite: true
+        file_glob: true

kmoe_manga_downloader-1.2.3/.github/workflows/unit-test.yml

@@ -0,0 +1,31 @@
+name: Unit Tests
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+
+    - name: Install dependencies and project
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest
+        pip install -e .
+
+    - name: Run tests with pytest
+      env:
+        KMOE_USERNAME: ${{ secrets.KMOE_USERNAME }}
+        KMOE_PASSWORD: ${{ secrets.KMOE_PASSWORD }}
+      run: |
+        pytest

kmoe_manga_downloader-1.2.3/.gitignore

@@ -0,0 +1,23 @@
+# ---> VisualStudioCode
+.vscode/*
+.vscode/settings.json
+.vscode/tasks.json
+.vscode/launch.json
+.vscode/extensions.json
+.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+__pycache__/
+*.py[codz]
+*$py.class
+
+*.egg-info/
+dist/
+
+# version file generated by setuptools-scm
+src/kmdr/_version.py

{kmoe_manga_downloader-1.2.1/src/kmoe_manga_downloader.egg-info → kmoe_manga_downloader-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kmoe-manga-downloader
-Version: 1.2.1
+Version: 1.2.3
 Summary: A CLI-downloader for site @kox.moe.
 Author-email: Chris Zheng <chrisis58@outlook.com>
 License: MIT License
@@ -50,9 +50,26 @@ Dynamic: license-file
 
 `kmdr (Kmoe Manga Downloader)` 是一个 Python 终端应用，用于从 [Kmoe](https://kxx.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定漫画及其卷，并支持回调脚本执行。
 
-<p align="center">
-  <img src="assets/kmdr-demo.gif" alt="kmdr 使用演示" width="720">
-</p>
+<table style="min-width: 600px;">
+  <tbody>
+    <tr>
+      <td style="text-align: center;" width="100">
+        交互模式
+      </td>
+      <td style="text-align: center;">
+        <img src="assets/kmdr-demo.gif" alt="kmdr 使用演示" />
+      </td>
+    </tr>
+    <tr>
+      <td style="text-align: center;" width="100">
+        日志模式
+      </td>
+      <td style="text-align: center;">
+        <img src="assets/kmdr-log-demo.gif" alt="kmdr 日志使用演示" />
+      </td>
+    </tr>
+  </tbody>
+</table>
 
 ## ✨功能特性
 

{kmoe_manga_downloader-1.2.1 → kmoe_manga_downloader-1.2.3}/README.md

@@ -4,9 +4,26 @@
 
 `kmdr (Kmoe Manga Downloader)` 是一个 Python 终端应用，用于从 [Kmoe](https://kxx.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定漫画及其卷，并支持回调脚本执行。
 
-<p align="center">
-  <img src="assets/kmdr-demo.gif" alt="kmdr 使用演示" width="720">
-</p>
+<table style="min-width: 600px;">
+  <tbody>
+    <tr>
+      <td style="text-align: center;" width="100">
+        交互模式
+      </td>
+      <td style="text-align: center;">
+        <img src="assets/kmdr-demo.gif" alt="kmdr 使用演示" />
+      </td>
+    </tr>
+    <tr>
+      <td style="text-align: center;" width="100">
+        日志模式
+      </td>
+      <td style="text-align: center;">
+        <img src="assets/kmdr-log-demo.gif" alt="kmdr 日志使用演示" />
+      </td>
+    </tr>
+  </tbody>
+</table>
 
 ## ✨功能特性
 

kmoe_manga_downloader-1.2.3/mirror/mirrors.json

@@ -0,0 +1,11 @@
+{
+    "default": "https://kxx.moe",
+    "alternatives": [
+        "https://kxo.moe",
+        "https://mox.moe",
+        "https://koz.moe"
+    ],
+    "deprecated": [
+        "https://kox.moe"
+    ]
+}

{kmoe_manga_downloader-1.2.1 → kmoe_manga_downloader-1.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kmoe-manga-downloader"
-version = "1.2.1"
+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"

kmoe_manga_downloader-1.2.3/src/kmdr/__init__.py

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

kmoe_manga_downloader-1.2.3/src/kmdr/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '1.2.3'
+__version_tuple__ = version_tuple = (1, 2, 3)
+
+__commit_id__ = commit_id = 'g8e5af2188'

{kmoe_manga_downloader-1.2.1 → kmoe_manga_downloader-1.2.3}/src/kmdr/core/__init__.py

@@ -1,9 +1,11 @@
-from .bases import Authenticator, Lister, Picker, Downloader, Configurer
+from .bases import Authenticator, Lister, Picker, Downloader, Configurer, SessionManager
 from .structure import VolInfo, BookInfo, VolumeType
-from .bases import AUTHENTICATOR, LISTERS, PICKERS, DOWNLOADER, CONFIGURER, KMDR_SESSION
+from .bases import AUTHENTICATOR, LISTERS, PICKERS, DOWNLOADER, CONFIGURER, SESSION_MANAGER
 
-from .defaults import argument_parser, session_var
+from .defaults import argument_parser, post_init
 
 from .error import KmdrError, LoginError
 
-from .session import KmdrSession
+from .session import KmdrSessionManager
+
+from .console import info, debug, exception, log

{kmoe_manga_downloader-1.2.1 → kmoe_manga_downloader-1.2.3}/src/kmdr/core/bases.py

@@ -4,6 +4,7 @@ from abc import abstractmethod
 import asyncio
 from aiohttp import ClientSession
 
+from .console import *
 from .error import LoginError
 from .registry import Registry
 from .structure import VolInfo, BookInfo
@@ -19,12 +20,18 @@ class Configurer(ConfigContext, TerminalContext):
     @abstractmethod
     def operate(self) -> None: ...
 
+class SessionManager(SessionContext, ConfigContext, TerminalContext):
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    @abstractmethod
+    async def session(self) -> ClientSession: ...
+
 class Authenticator(SessionContext, ConfigContext, UserProfileContext, TerminalContext):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        # 这里的 base url 可能会在认证过程中被更新
-        self._inner_base_url: Optional[str] = None
 
     # 在使用代理登录时，可能会出现问题，但是现在还不清楚是不是代理的问题。
     # 主站正常情况下不使用代理也能登录成功。但是不排除特殊的网络环境下需要代理。
@@ -33,21 +40,11 @@ class Authenticator(SessionContext, ConfigContext, UserProfileContext, TerminalC
     async def authenticate(self) -> None:
         with self._console.status("认证中..."):
             try:
-                # 这里添加了 base_url_setter，以便在重定向时更新 base_url
-                assert await async_retry(
-                    base_url_setter=self._configurer.set_base_url
-                )(self._authenticate)()
-
-                # 登录成功后，更新 base_url
-                self._base_url = self.base_url
+                assert await async_retry()(self._authenticate)()
             except LoginError as e:
-                self._console.print("[red]认证失败。请检查您的登录凭据或会话 cookie。[/red]")
-                self._console.print(f"[yellow]详细信息：{e}[/yellow]")
+                info(f"[yellow]详细信息：{e}[/yellow]")
+                info("[red]认证失败。请检查您的登录凭据或会话 cookie。[/red]")
                 exit(1)
-    
-    @property
-    def base_url(self) -> str:
-        return self._inner_base_url or self._configurer.base_url
 
     @abstractmethod
     async def _authenticate(self) -> bool: ...
@@ -86,22 +83,30 @@ class Downloader(SessionContext, UserProfileContext, TerminalContext):
 
     async def download(self, book: BookInfo, volumes: list[VolInfo]):
         if not volumes:
-            self._console.print("No volumes to download.")
+            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
     async def _download(self, book: BookInfo, volume: VolInfo): ...
 
-KMDR_SESSION = Registry[ClientSession]('KmdrSession', True)
+SESSION_MANAGER = Registry[SessionManager]('SessionManager', True)
 AUTHENTICATOR = Registry[Authenticator]('Authenticator')
 LISTERS = Registry[Lister]('Lister')
 PICKERS = Registry[Picker]('Picker')

kmoe_manga_downloader-1.2.3/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__)))

{kmoe_manga_downloader-1.2.1 → kmoe_manga_downloader-1.2.3}/src/kmdr/core/constants.py

@@ -1,37 +1,30 @@
 from dataclasses import dataclass
 from enum import Enum
-from typing_extensions import deprecated
+from typing import Union
 
+from typing_extensions import deprecated
 
-@dataclass(frozen=True)
-class _BaseUrl:
+class BASE_URL(Enum):
 
     @property
     @deprecated("KOX 已过时，请使用 KXO 或 KOZ。")
     def KOX(self) -> str:
         return 'https://kox.moe'
     
-    @property
-    def KXX(self) -> str:
-        return 'https://kxx.moe'
+    KXX = 'https://kxx.moe'
 
-    @property
-    def KXO(self) -> str:
-        return 'https://kxo.moe'
+    KXO = 'https://kxo.moe'
 
-    @property
-    def KOZ(self) -> str:
-        return 'https://koz.moe'
+    KOZ = 'https://koz.moe'
 
-    @property
-    def MOX(self) -> str:
-        return 'https://mox.moe'
+    MOX = 'https://mox.moe'
 
-    @property
-    def DEFAULT(self) -> str:
-        """默认基础 URL"""
-        return self.KXX
+    @classmethod
+    def alternatives(cls) -> set[str]:
+        """返回备用的基础 URL 列表"""
+        return {cls.KXO.value, cls.KOZ.value, cls.MOX.value}
 
+    DEFAULT = KXX
 
 @dataclass(frozen=True)
 class _ApiRoute():
@@ -71,9 +64,11 @@ class LoginResponse(Enum):
     def from_code(cls, code: str) -> 'LoginResponse':
         return cls.__members__.get(code, cls.unknown)
 
+    @classmethod
+    def ok(cls, code: Union[str, 'LoginResponse']) -> bool:
+        if isinstance(code, LoginResponse):
+            return code == cls.m100
+        return cls.from_code(code) == cls.m100
 
 API_ROUTE = _ApiRoute()
 """API 路由常量实例"""
-
-BASE_URL = _BaseUrl()
-"""基础 URL 实例"""

{kmoe_manga_downloader-1.2.1 → kmoe_manga_downloader-1.2.3}/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:
 
@@ -30,6 +41,10 @@ class SessionContext:
     @property
     def _session(self) -> ClientSession:
         return session_var.get()
+    
+    @_session.setter
+    def _session(self, value: ClientSession):
+        session_var.set(value)
 
     @property
     def _base_url(self) -> str:

{kmoe_manga_downloader-1.2.1 → kmoe_manga_downloader-1.2.3}/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 @@ HEADERS = {
     '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 @@ progress = Progress(
     ",",
     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)
@@ -176,7 +179,7 @@ class Configurer:
     @property
     def base_url(self) -> str:
         if self._config is None or self._config.base_url is None:
-            return BASE_URL.DEFAULT 
+            return BASE_URL.DEFAULT.value
         return self._config.base_url
     
     def set_base_url(self, value: str):
@@ -185,6 +188,9 @@ class Configurer:
         self._config.base_url = value
         self.update()
     
+    def get_base_url(self) -> Optional[str]:
+        return self._config.base_url
+    
     def update(self):
         with open(os.path.join(os.path.expanduser("~"), self.__filename), 'w') as f:
             json.dump(self._config.__dict__, f, indent=4, ensure_ascii=False)
@@ -234,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)

{kmoe_manga_downloader-1.2.1 → kmoe_manga_downloader-1.2.3}/src/kmdr/core/error.py

@@ -7,6 +7,20 @@ class KmdrError(RuntimeError):
 
         self._solution = "" if solution is None else "\n[bold cyan]推荐解决方法:[/bold cyan] \n" + "\n".join(f"[cyan]>>> {sol}[/cyan]" for sol in solution)
 
+class InitializationError(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 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)
@@ -20,4 +34,12 @@ class RedirectError(KmdrError):
         self.new_base_url = new_base_url
 
     def __str__(self):
-        return f"{self.message} 新的地址: {self.new_base_url}"
+        return f"{self.message} 新的地址: {self.new_base_url}"
+
+class ResponseError(KmdrError):
+    def __init__(self, message, status_code: int):
+        super().__init__(message)
+        self.status_code = status_code
+
+    def __str__(self):
+        return f"{self.message} (状态码: {self.status_code})"

kmoe_manga_downloader-1.2.3/src/kmdr/core/protocol.py

@@ -0,0 +1,10 @@
+from typing import Protocol, TypeVar
+
+S = TypeVar('S', covariant=True)
+T = TypeVar('T', contravariant=True)
+
+class Supplier(Protocol[S]):
+    def __call__(self) -> S: ...
+
+class Consumer(Protocol[T]):
+    def __call__(self, value: T) -> None: ...