kmoe-manga-downloader 1.0.0__tar.gz → 1.1.0__tar.gz

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kmoe-manga-downloader
-Version: 1.0.0
+Version: 1.1.0
 Summary: A CLI-downloader for site @kox.moe.
 Author-email: Chris Zheng <chrisis58@outlook.com>
 License: MIT License
@@ -43,28 +43,24 @@ Dynamic: license-file
 
 # Kmoe Manga Downloader
 
-[![Unit Tests](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml/badge.svg)](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml) [![Interpretor](https://img.shields.io/badge/python-3.9+-blue)](https://www.python.org/) [![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/chrisis58/kmdr/blob/main/LICENSE)
+[![PyPI Downloads](https://static.pepy.tech/badge/kmoe-manga-downloader)](https://pepy.tech/projects/kmoe-manga-downloader) [![PyPI version](https://img.shields.io/pypi/v/kmoe-manga-downloader.svg)](https://pypi.org/project/kmoe-manga-downloader/) [![Unit Tests](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml/badge.svg)](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml) [![Interpretor](https://img.shields.io/badge/python-3.9+-blue)](https://www.python.org/) [![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/chrisis58/kmdr/blob/main/LICENSE)
 
-`kmdr (Kmoe Manga Downloader)` 是一个 Python 脚本，用于从 [Kmoe](https://kox.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定书籍及其卷，并支持回调脚本执行。
+`kmdr (Kmoe Manga Downloader)` 是一个 Python 应用，用于从 [Kmoe](https://kox.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定书籍及其卷，并支持回调脚本执行。
 
 ## ✨功能特性
 
-- 以命令行参数登录网站并持久化凭证
-- 支持多种方式筛选需要的内容
-- 支持网站上提供的不同的下载方式
-- 支持多线程下载，失败重试、断点续传
-- 提供自定义的下载完成回调命令
-- 提供通用配置持久化的实现
+- **凭证管理**: 命令行登录并持久化会话
+- **多种下载方式**: 支持通过书籍 URL 或从收藏列表下载
+- **高效下载**: 支持多线程、失败重试及断点续传
+- **配置持久化**: 保存常用下载目录、代理等设置
+- **回调支持**: 下载完成后自动执行自定义脚本
 
-## 🛠️安装依赖
+## 🛠️安装应用
 
-在使用本脚本之前，请确保你已经安装了项目所需要的依赖：
+你可以通过 PyPI 使用 `pip` 进行安装：
 
 ```bash
-git clone https://github.com/chrisis58/kmoe-manga-downloader.git
-cd kmoe-manga-downloader
-
-pip install -r requirements.txt
+pip install kmoe-manga-downloader
 ```
 
 ## 📋使用方法
@@ -74,35 +70,34 @@ pip install -r requirements.txt
 首先需要登录 `kox.moe` 并保存登录状态（Cookie）。
 
 ```bash
-python kmdr.py login -u <your_username> -p <your_password>
+kmdr login -u <your_username> -p <your_password>
+# 或者
+kmdr login -u <your_username>
 ```
 
-或者：
+第二种方式会在程序运行时获取登录密码，此时你输入的密码**不会显示**在终端中。
 
-```bash
-python kmdr.py login -u <your_username>
-```
-
-第二种方式会在程序运行时获取登录密码。如果登录成功，会同时显示当前登录用户及配额。
+如果登录成功，会同时显示当前登录用户及配额。
 
 ### 2. 下载漫画书籍
 
 你可以通过以下命令下载指定书籍或卷：
 
 ```bash
-# 在 path/to/destination 目录下载第一、二、三卷
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm --volume 1,2,3
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3
+# 在当前目录下载第一、二、三卷
+kmdr download --dest . --book-url https://kox.moe/c/50076.htm --volume 1,2,3
+kmdr download -l https://kox.moe/c/50076.htm -v 1-3
 ```
 
 ```bash
-# 在 path/to/download/destination 目录下载全部番外篇
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm --vol-type extra -v all
+# 在目标目录下载全部番外篇
+kmdr download --dest path/to/destination --book-url https://kox.moe/c/50076.htm --vol-type extra -v all
+kmdr download -d path/to/destination -l https://kox.moe/c/50076.htm -t extra -v all
 ```
 
 #### 常用参数说明：
 
-- `-d`, `--dest`: 下载的目标目录，在此基础上会额外添加一个为书籍名称的子目录
+- `-d`, `--dest`: 下载的目标目录（默认为当前目录），在此基础上会额外添加一个为书籍名称的子目录
 - `-l`, `--book-url`: 指定书籍的主页地址
 - `-v`, `--volume`: 指定卷的名称，多个名称使用逗号分隔，`all` 表示下载所有卷
 - `-t`, `--vol-type`: 卷类型，`vol`: 单行本（默认）；`extra`: 番外；`seri`: 连载话；`all`: 全部
@@ -115,10 +110,10 @@ python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/5007
 
 ### 3. 查看账户状态
 
-查看当前账户信息（例如：账户名和配额等）：
+查看当前账户信息（账户名和配额等）：
 
 ```bash
-python kmdr.py status
+kmdr status
 ```
 
 ### 4. 回调函数
@@ -126,7 +121,7 @@ python kmdr.py status
 你可以设置一个回调函数，下载完成后执行。回调可以是任何你想要的命令：
 
 ```bash
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3 \
+kmdr download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3 \
 	--callback "echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
 ```
 
@@ -146,11 +141,11 @@ python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/5007
 
 ### 5. 持久化配置
 
-重复设置下载的代理服务器、目标路径等参数，可能会降低脚本的使用效率。所以脚本也提供了通用配置的持久化命令：
+重复设置下载的代理服务器、目标路径等参数，可能会降低应用的使用效率。所以应用也提供了通用配置的持久化命令：
 
 ```bash
-python kmdr.py config --set proxy=http://localhost:7890 dest=/path/to/destination
-python kmdr.py config -s num_workers=5 "callback=echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
+kmdr config --set proxy=http://localhost:7890 dest=/path/to/destination
+kmdr config -s num_workers=5 "callback=echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
 ```
 
 只需要配置一次即可对之后的所有的下载指令生效。
@@ -175,8 +170,7 @@ python kmdr.py config -s num_workers=5 "callback=echo '{b.name} {v.name} downloa
 ---
 
 <div align=center> 
-💬任何使用中遇到的问题、希望添加的功能，都欢迎提交 issue 或开 discussion 交流！<br />
+💬任何使用中遇到的问题、希望添加的功能，都欢迎提交 issue 交流！<br />
 ⭐ 如果这个项目对你有帮助，请给它一个星标！<br /> <br /> 
 <img src="https://counter.seku.su/cmoe?name=kmdr&theme=mbs" />
 </div>
-

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/README.md

@@ -1,27 +1,23 @@
 # Kmoe Manga Downloader
 
-[![Unit Tests](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml/badge.svg)](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml) [![Interpretor](https://img.shields.io/badge/python-3.9+-blue)](https://www.python.org/) [![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/chrisis58/kmdr/blob/main/LICENSE)
+[![PyPI Downloads](https://static.pepy.tech/badge/kmoe-manga-downloader)](https://pepy.tech/projects/kmoe-manga-downloader) [![PyPI version](https://img.shields.io/pypi/v/kmoe-manga-downloader.svg)](https://pypi.org/project/kmoe-manga-downloader/) [![Unit Tests](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml/badge.svg)](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml) [![Interpretor](https://img.shields.io/badge/python-3.9+-blue)](https://www.python.org/) [![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/chrisis58/kmdr/blob/main/LICENSE)
 
-`kmdr (Kmoe Manga Downloader)` 是一个 Python 脚本，用于从 [Kmoe](https://kox.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定书籍及其卷，并支持回调脚本执行。
+`kmdr (Kmoe Manga Downloader)` 是一个 Python 应用，用于从 [Kmoe](https://kox.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定书籍及其卷，并支持回调脚本执行。
 
 ## ✨功能特性
 
-- 以命令行参数登录网站并持久化凭证
-- 支持多种方式筛选需要的内容
-- 支持网站上提供的不同的下载方式
-- 支持多线程下载，失败重试、断点续传
-- 提供自定义的下载完成回调命令
-- 提供通用配置持久化的实现
+- **凭证管理**: 命令行登录并持久化会话
+- **多种下载方式**: 支持通过书籍 URL 或从收藏列表下载
+- **高效下载**: 支持多线程、失败重试及断点续传
+- **配置持久化**: 保存常用下载目录、代理等设置
+- **回调支持**: 下载完成后自动执行自定义脚本
 
-## 🛠️安装依赖
+## 🛠️安装应用
 
-在使用本脚本之前，请确保你已经安装了项目所需要的依赖：
+你可以通过 PyPI 使用 `pip` 进行安装：
 
 ```bash
-git clone https://github.com/chrisis58/kmoe-manga-downloader.git
-cd kmoe-manga-downloader
-
-pip install -r requirements.txt
+pip install kmoe-manga-downloader
 ```
 
 ## 📋使用方法
@@ -31,35 +27,34 @@ pip install -r requirements.txt
 首先需要登录 `kox.moe` 并保存登录状态（Cookie）。
 
 ```bash
-python kmdr.py login -u <your_username> -p <your_password>
+kmdr login -u <your_username> -p <your_password>
+# 或者
+kmdr login -u <your_username>
 ```
 
-或者：
+第二种方式会在程序运行时获取登录密码，此时你输入的密码**不会显示**在终端中。
 
-```bash
-python kmdr.py login -u <your_username>
-```
-
-第二种方式会在程序运行时获取登录密码。如果登录成功，会同时显示当前登录用户及配额。
+如果登录成功，会同时显示当前登录用户及配额。
 
 ### 2. 下载漫画书籍
 
 你可以通过以下命令下载指定书籍或卷：
 
 ```bash
-# 在 path/to/destination 目录下载第一、二、三卷
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm --volume 1,2,3
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3
+# 在当前目录下载第一、二、三卷
+kmdr download --dest . --book-url https://kox.moe/c/50076.htm --volume 1,2,3
+kmdr download -l https://kox.moe/c/50076.htm -v 1-3
 ```
 
 ```bash
-# 在 path/to/download/destination 目录下载全部番外篇
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm --vol-type extra -v all
+# 在目标目录下载全部番外篇
+kmdr download --dest path/to/destination --book-url https://kox.moe/c/50076.htm --vol-type extra -v all
+kmdr download -d path/to/destination -l https://kox.moe/c/50076.htm -t extra -v all
 ```
 
 #### 常用参数说明：
 
-- `-d`, `--dest`: 下载的目标目录，在此基础上会额外添加一个为书籍名称的子目录
+- `-d`, `--dest`: 下载的目标目录（默认为当前目录），在此基础上会额外添加一个为书籍名称的子目录
 - `-l`, `--book-url`: 指定书籍的主页地址
 - `-v`, `--volume`: 指定卷的名称，多个名称使用逗号分隔，`all` 表示下载所有卷
 - `-t`, `--vol-type`: 卷类型，`vol`: 单行本（默认）；`extra`: 番外；`seri`: 连载话；`all`: 全部
@@ -72,10 +67,10 @@ python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/5007
 
 ### 3. 查看账户状态
 
-查看当前账户信息（例如：账户名和配额等）：
+查看当前账户信息（账户名和配额等）：
 
 ```bash
-python kmdr.py status
+kmdr status
 ```
 
 ### 4. 回调函数
@@ -83,7 +78,7 @@ python kmdr.py status
 你可以设置一个回调函数，下载完成后执行。回调可以是任何你想要的命令：
 
 ```bash
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3 \
+kmdr download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3 \
 	--callback "echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
 ```
 
@@ -103,11 +98,11 @@ python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/5007
 
 ### 5. 持久化配置
 
-重复设置下载的代理服务器、目标路径等参数，可能会降低脚本的使用效率。所以脚本也提供了通用配置的持久化命令：
+重复设置下载的代理服务器、目标路径等参数，可能会降低应用的使用效率。所以应用也提供了通用配置的持久化命令：
 
 ```bash
-python kmdr.py config --set proxy=http://localhost:7890 dest=/path/to/destination
-python kmdr.py config -s num_workers=5 "callback=echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
+kmdr config --set proxy=http://localhost:7890 dest=/path/to/destination
+kmdr config -s num_workers=5 "callback=echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
 ```
 
 只需要配置一次即可对之后的所有的下载指令生效。
@@ -132,8 +127,7 @@ python kmdr.py config -s num_workers=5 "callback=echo '{b.name} {v.name} downloa
 ---
 
 <div align=center> 
-💬任何使用中遇到的问题、希望添加的功能，都欢迎提交 issue 或开 discussion 交流！<br />
+💬任何使用中遇到的问题、希望添加的功能，都欢迎提交 issue 交流！<br />
 ⭐ 如果这个项目对你有帮助，请给它一个星标！<br /> <br /> 
 <img src="https://counter.seku.su/cmoe?name=kmdr&theme=mbs" />
 </div>
-

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kmoe-manga-downloader"
-version = "1.0.0"
+version = "1.1.0"
 authors = [
     { name="Chris Zheng", email="chrisis58@outlook.com" },
 ]

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/core/__init__.py

@@ -2,4 +2,6 @@ from .bases import Authenticator, Lister, Picker, Downloader, Configurer
 from .structure import VolInfo, BookInfo, VolumeType
 from .bases import AUTHENTICATOR, LISTERS, PICKERS, DOWNLOADER, CONFIGURER
 
-from .defaults import argument_parser
+from .defaults import argument_parser
+
+from .error import KmdrError, LoginError

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/core/bases.py

@@ -2,10 +2,11 @@ import os
 
 from typing import Callable, Optional
 
+from .error import LoginError
 from .registry import Registry
 from .structure import VolInfo, BookInfo
 from .utils import get_singleton_session, construct_callback
-from .defaults import Configurer as InnerConfigurer
+from .defaults import Configurer as InnerConfigurer, UserProfile
 
 class SessionContext:
 
@@ -13,6 +14,12 @@ class SessionContext:
         super().__init__()
         self._session = get_singleton_session()
 
+class UserProfileContext:
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+        self._profile = UserProfile()
+
 class ConfigContext:
 
     def __init__(self, *args, **kwargs):
@@ -26,7 +33,7 @@ class Configurer(ConfigContext):
     
     def operate(self) -> None: ...
 
-class Authenticator(SessionContext, ConfigContext):
+class Authenticator(SessionContext, ConfigContext, UserProfileContext):
 
     def __init__(self, proxy: Optional[str] = None, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -41,8 +48,13 @@ class Authenticator(SessionContext, ConfigContext):
     # 主站正常情况下不使用代理也能登录成功。但是不排除特殊的网络环境下需要代理。
     # 所以暂时保留代理登录的功能，如果后续确认是代理的问题，可以考虑启用 @no_proxy 装饰器。
     # @no_proxy
-    def authenticate(self) -> bool:
-        return self._authenticate()
+    def authenticate(self) -> None:
+        try:
+            assert self._authenticate()
+        except LoginError as e:
+            print("Authentication failed. Please check your login credentials or session cookies.")
+            print(f"Details: {e}")
+            exit(1)
 
     def _authenticate(self) -> bool: ...
 
@@ -60,7 +72,7 @@ class Picker(SessionContext):
 
     def pick(self, volumes: list[VolInfo]) -> list[VolInfo]: ...
 
-class Downloader(SessionContext):
+class Downloader(SessionContext, UserProfileContext):
 
     def __init__(self, 
             dest: str = '.',

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/core/defaults.py

@@ -58,6 +58,29 @@ def parse_args():
 
     return args
 
+@singleton
+class UserProfile:
+
+    def __init__(self):
+        self._is_vip: Optional[int] = None
+        self._user_level: Optional[int] = None
+
+    @property
+    def is_vip(self) -> Optional[int]:
+        return self._is_vip
+
+    @property
+    def user_level(self) -> Optional[int]:
+        return self._user_level
+    
+    @is_vip.setter
+    def is_vip(self, value: Optional[int]):
+        self._is_vip = value
+
+    @user_level.setter
+    def user_level(self, value: Optional[int]):
+        self._user_level = value
+
 @singleton
 class Configurer:
 

kmoe_manga_downloader-1.1.0/src/kmdr/core/error.py

@@ -0,0 +1,15 @@
+from typing import Optional
+
+class KmdrError(RuntimeError):
+    def __init__(self, message: str, solution: Optional[list[str]] = None, *args: object, **kwargs: object):
+        super().__init__(message, *args, **kwargs)
+        self.message = message
+
+        self._solution = "" if solution is None else "\nSuggested Solution: \n" + "\n".join(f">>> {sol}" for sol in solution)
+
+class LoginError(KmdrError):
+    def __init__(self, message, solution: Optional[list[str]] = None):
+        super().__init__(message, solution)
+
+    def __str__(self):
+        return f"{self.message}\n{self._solution}"

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/main.py

@@ -7,16 +7,13 @@ from kmdr.module import *
 def main(args: Namespace, fallback: Callable[[], None] = lambda: print('NOT IMPLEMENTED!')) -> None:
 
     if args.command == 'login':
-        if not AUTHENTICATOR.get(args).authenticate():
-            raise RuntimeError("Authentication failed. Please check your credentials.")
+        AUTHENTICATOR.get(args).authenticate()
 
     elif args.command == 'status':
-        if not AUTHENTICATOR.get(args).authenticate():
-            raise RuntimeError("Authentication failed. Please check your credentials.")
+        AUTHENTICATOR.get(args).authenticate()
 
-    elif args.command == 'download':    
-        if not AUTHENTICATOR.get(args).authenticate():
-            raise RuntimeError("Authentication failed. Please check your credentials.")
+    elif args.command == 'download':
+        AUTHENTICATOR.get(args).authenticate()
 
         book, volumes = LISTERS.get(args).list()
 

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/module/authenticator/CookieAuthenticator.py

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from kmdr.core import Authenticator, AUTHENTICATOR
+from kmdr.core import Authenticator, AUTHENTICATOR, LoginError
 
 from .utils import check_status
 
@@ -18,8 +18,12 @@ class CookieAuthenticator(Authenticator):
         cookie = self._configurer.cookie
         
         if not cookie:
-            print("No cookie found. Please login first.")
-            return False
+            raise LoginError("No cookie found, please login first.", ['kmdr login -u <username>'])
         
         self._session.cookies.update(cookie)
-        return check_status(self._session, show_quota=self._show_quota)
+        return check_status(
+            self._session,
+            show_quota=self._show_quota,
+            is_vip_setter=lambda value: setattr(self._profile, 'is_vip', value),
+            level_setter=lambda value: setattr(self._profile, 'user_level', value),
+        )

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/module/authenticator/LoginAuthenticator.py

@@ -1,10 +1,19 @@
 from typing import Optional
 import re
+from getpass import getpass
 
-from kmdr.core import Authenticator, AUTHENTICATOR
+from kmdr.core import Authenticator, AUTHENTICATOR, LoginError
 
 from .utils import check_status
 
+CODE_OK = 'm100'
+
+CODE_MAPPING = {
+    'e400': "帳號或密碼錯誤。",
+    'e401': "非法訪問，請使用瀏覽器正常打開本站",
+    'e402': "帳號已經註銷。不會解釋原因，無需提問。",
+    'e403': "驗證失效，請刷新頁面重新操作。",
+}
 
 @AUTHENTICATOR.register(
     hasvalues = {'command': 'login'}
@@ -16,7 +25,7 @@ class LoginAuthenticator(Authenticator):
         self._show_quota = show_quota
 
         if password is None:
-            password = input("please input your password: \n")
+            password = getpass("please input your password: ")
 
         self._password = password
 
@@ -31,22 +40,15 @@ class LoginAuthenticator(Authenticator):
             },
         )
         response.raise_for_status()
-        
-        match = re.search('"\w+"', response.text)
+        match = re.search(r'"\w+"', response.text)
+
         if not match:
-            raise RuntimeError("Failed to extract authentication code from response.")
-        code = match.group(0).split('"')[1]
-        if code != 'm100':
-            if code == 'e400':
-                print("帳號或密碼錯誤。")
-            elif code == 'e401':
-                print("非法訪問，請使用瀏覽器正常打開本站")
-            elif code == 'e402':
-                print("帳號已經註銷。不會解釋原因，無需提問。")
-            elif code == 'e403':
-                print("驗證失效，請刷新頁面重新操作。")
-            raise RuntimeError("Authentication failed with code: " + code)
+            raise LoginError("Failed to extract authentication code from response.")
         
+        code = match.group(0).split('"')[1]
+        if code != CODE_OK:
+            raise LoginError(f"Authentication failed with error code: {code} " + CODE_MAPPING.get(code, "Unknown error."))
+
         if check_status(self._session, show_quota=self._show_quota):
             self._configurer.cookie = self._session.cookies.get_dict()
             return True

kmoe_manga_downloader-1.1.0/src/kmdr/module/authenticator/utils.py

@@ -0,0 +1,79 @@
+from typing import Optional, Callable
+
+from requests import Session
+
+from kmdr.core.error import LoginError
+
+PROFILE_URL = 'https://kox.moe/my.php'
+LOGIN_URL = 'https://kox.moe/login.php'
+
+NICKNAME_ID = 'div_nickname_display'
+
+VIP_ID = 'div_user_vip'
+NOR_ID = 'div_user_nor'
+LV1_ID = 'div_user_lv1'
+
+def check_status(
+        session: Session,
+        show_quota: bool = False,
+        is_vip_setter: Optional[Callable[[int], None]] = None,
+        level_setter: Optional[Callable[[int], None]] = None
+) -> bool:
+    response = session.get(url = PROFILE_URL)
+
+    try:
+        response.raise_for_status()
+    except Exception as e:
+        print(f"Error: {type(e).__name__}: {e}")
+        return False
+    
+    if response.history and any(resp.status_code in (301, 302, 307) for resp in response.history) \
+        and response.url == LOGIN_URL:
+        raise LoginError("Invalid credentials, please login again.", ['kmdr config -c cookie', 'kmdr login -u <username>'])
+
+    if not is_vip_setter and not level_setter and not show_quota:
+        return True
+    
+    from bs4 import BeautifulSoup
+
+    soup = BeautifulSoup(response.text, 'html.parser')
+
+    script = soup.find('script', language="javascript")
+
+    if script:
+        var_define = extract_var_define(script.text[:100])
+
+        is_vip = int(var_define.get('is_vip', '0'))
+        user_level = int(var_define.get('user_level', '0'))
+
+        if is_vip_setter:
+            is_vip_setter(is_vip)
+        if level_setter:
+            level_setter(user_level)
+    
+    if not show_quota:
+        return True
+
+    nickname = soup.find('div', id=NICKNAME_ID).text.strip().split(' ')[0]
+    quota = soup.find('div', id=__resolve_quota_id(is_vip, user_level)).text.strip()
+
+    print(f"\n当前登录为 {nickname}\n\n{quota}")
+    return True
+
+def extract_var_define(script_text) -> dict[str, str]:
+    var_define = {}
+    for line in script_text.splitlines():
+        line = line.strip()
+        if line.startswith("var ") and "=" in line:
+            var_name, var_value = line[4:].split("=", 1)
+            var_define[var_name.strip()] = var_value.strip().strip(";").strip('"')
+    return var_define
+
+def __resolve_quota_id(is_vip: Optional[int] = None, user_level: Optional[int] = None):
+    if is_vip is not None and is_vip >= 1:
+        return VIP_ID
+    
+    if user_level is not None and user_level <= 1:
+        return LV1_ID
+    
+    return NOR_ID

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/module/configurer/ConfigUnsetter.py

@@ -1,5 +1,7 @@
 from kmdr.core import Configurer, CONFIGURER
 
+from .option_validate import check_key
+
 @CONFIGURER.register()
 class ConfigUnsetter(Configurer):
     def __init__(self, unset: str, *args, **kwargs):
@@ -10,6 +12,7 @@ class ConfigUnsetter(Configurer):
         if not self._unset:
             print("No option specified to unset.")
             return
-        
+
+        check_key(self._unset)
         self._configurer.unset_option(self._unset)
         print(f"Unset configuration: {self._unset}")

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/module/configurer/option_validate.py

@@ -1,27 +1,61 @@
 from typing import Optional
+from functools import wraps
 import os
 
 __OPTIONS_VALIDATOR = {}
 
 def validate(key: str, value: str) -> Optional[object]:
+    """
+    供外部调用的验证函数，根据键名调用相应的验证器。
+
+    :param key: 配置项的键名
+    :param value: 配置项的值
+    :return: 验证后的值或 None
+    """
     if key in __OPTIONS_VALIDATOR:
         return __OPTIONS_VALIDATOR[key](value)
     else:
         print(f"Unsupported option: {key}. Supported options are: {', '.join(__OPTIONS_VALIDATOR.keys())}")
         return None
 
-def _register_validator(func):
-    global __OPTIONS_VALIDATOR
+def check_key(key: str, exit_if_invalid: bool = True) -> None:
+    """
+    供外部调用的验证函数，用于检查配置项的键名是否有效。
+    如果键名无效，函数会打印错误信息并退出程序。
+
+    :param key: 配置项的键名
+    :param exit_if_invalid: 如果键名无效，是否退出程序
+    """
+    if key not in __OPTIONS_VALIDATOR:
+        print(f"Unknown option: {key}. Supported options are: {', '.join(__OPTIONS_VALIDATOR.keys())}")
+        if exit_if_invalid:
+            exit(1)
+
+def register_validator(arg_name):
+    """
+    验证函数的注册装饰器，用于将验证函数注册到全局验证器字典中。
+
+    :param arg_name: 配置项的键名
+    """
+
+    def wrapper(func):
+        global __OPTIONS_VALIDATOR
+        __OPTIONS_VALIDATOR[arg_name] = func
+
+        @wraps(func)
+        def inner(*args, **kwargs):
+            return func(*args, **kwargs)
+    
+        return inner
 
-    func_name = func.__name__
+    return wrapper
 
-    assert func_name.startswith('validate_'), \
-        f"Validator function name must start with 'validate_', got '{func_name}'"
 
-    __OPTIONS_VALIDATOR[func.__name__[9:]] = func
-    return func
+#############################################
+## 以下为各个配置项的验证函数。
+#############################################
 
-@_register_validator
+@register_validator('num_workers')
 def validate_num_workers(value: str) -> Optional[int]:
     try:
         num_workers = int(value)
@@ -32,7 +66,7 @@ def validate_num_workers(value: str) -> Optional[int]:
         print(f"Invalid value for num_workers: {value}. {str(e)}")
         return None
 
-@_register_validator
+@register_validator('dest')
 def validate_dest(value: str) -> Optional[str]:
     if not value:
         print("Destination cannot be empty.")
@@ -50,7 +84,7 @@ def validate_dest(value: str) -> Optional[str]:
 
     return value
 
-@_register_validator
+@register_validator('retry')
 def validate_retry(value: str) -> Optional[int]:
     try:
         retry = int(value)
@@ -61,14 +95,14 @@ def validate_retry(value: str) -> Optional[int]:
         print(f"Invalid value for retry: {value}. {str(e)}")
         return None
 
-@_register_validator
+@register_validator('callback')
 def validate_callback(value: str) -> Optional[str]:
     if not value:
         print("Callback cannot be empty.")
         return None
     return value
 
-@_register_validator
+@register_validator('proxy')
 def validate_proxy(value: str) -> Optional[str]:
     if not value:
         print("Proxy cannot be empty.")

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/module/downloader/DirectDownloader.py

@@ -25,4 +25,4 @@ class DirectDownloader(Downloader):
         )
 
     def construct_download_url(self, book: BookInfo, volume: VolInfo) -> str:
-        return f'https://kox.moe/dl/{book.id}/{volume.id}/1/2/0/'
+        return f'https://kox.moe/dl/{book.id}/{volume.id}/1/2/{self._profile.is_vip}/'

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/module/downloader/ReferViaDownloader.py

@@ -23,7 +23,7 @@ class ReferViaDownloader(Downloader):
 
         download_file(
             self._session if not self._scraper else self._scraper,
-            self.fetch_download_url(book=book, volume=volume),
+            self.fetch_download_url(book_id=book.id, volume_id=volume.id),
             download_path,
             f'[Kmoe][{book.name}][{volume.name}].epub',
             retry,
@@ -34,8 +34,8 @@ class ReferViaDownloader(Downloader):
         )
 
     @cached_by_kwargs
-    def fetch_download_url(self, book: BookInfo, volume: VolInfo) -> str:
-        response = self._session.get(f"https://kox.moe/getdownurl.php?b={book.id}&v={volume.id}&mobi=2&vip=0&json=1")
+    def fetch_download_url(self, book_id: str, volume_id: str) -> str:
+        response = self._session.get(f"https://kox.moe/getdownurl.php?b={book_id}&v={volume_id}&mobi=2&vip={self._profile.is_vip}&json=1")
         response.raise_for_status()
         data = response.json()
         if data.get('code') != 200:

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmdr/module/downloader/utils.py

@@ -1,6 +1,7 @@
 from typing import Callable, Optional
 import os
 import time
+from functools import wraps
 
 from requests import Session, HTTPError
 from requests.exceptions import ChunkedEncodingError
@@ -64,11 +65,6 @@ def download_file(
     except Exception as e:
         prefix = f"{type(e).__name__} occurred while downloading {filename}. "
 
-        if isinstance(e, HTTPError):
-            e.request.headers['Cookie'] = '***MASKED***'
-            tqdm.write(f"Request Headers: {e.request.headers}")
-            tqdm.write(f"Response Headers: {e.response.headers}")
-
         new_block_size = block_size
         if isinstance(e, ChunkedEncodingError):
             new_block_size = max(int(block_size * BLOCK_SIZE_REDUCTION_FACTOR), MIN_BLOCK_SIZE)
@@ -89,6 +85,8 @@ def safe_filename(name: str) -> str:
     return re.sub(r'[\\/:*?"<>|]', '_', name)
 
 
+function_cache = {}
+
 def cached_by_kwargs(func):
     """
     根据关键字参数缓存函数结果的装饰器。
@@ -101,18 +99,29 @@ def cached_by_kwargs(func):
     >>> result2 = add(3, 2, c=3)  # Uses cached result
     >>> assert result1 == result2  # Both results are the same
     """
-    cache = {}
 
+    global function_cache
+    if func not in function_cache:
+        function_cache[func] = {}
+
+    @wraps(func)
     def wrapper(*args, **kwargs):
         if not kwargs:
             return func(*args, **kwargs)
-        
-        nonlocal cache
 
         key = frozenset(kwargs.items())
 
-        if key not in cache:
-            cache[key] = func(*args, **kwargs)
-        return cache[key]
+        if key not in function_cache[func]:
+            function_cache[func][key] = func(*args, **kwargs)
+        return function_cache[func][key]
 
     return wrapper
+
+def clear_cache(func):
+    assert hasattr(func, "__wrapped__"), "Function is not wrapped"
+    global function_cache
+
+    wrapped = func.__wrapped__
+
+    if wrapped in function_cache:
+        function_cache[wrapped] = {}

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmoe_manga_downloader.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kmoe-manga-downloader
-Version: 1.0.0
+Version: 1.1.0
 Summary: A CLI-downloader for site @kox.moe.
 Author-email: Chris Zheng <chrisis58@outlook.com>
 License: MIT License
@@ -43,28 +43,24 @@ Dynamic: license-file
 
 # Kmoe Manga Downloader
 
-[![Unit Tests](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml/badge.svg)](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml) [![Interpretor](https://img.shields.io/badge/python-3.9+-blue)](https://www.python.org/) [![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/chrisis58/kmdr/blob/main/LICENSE)
+[![PyPI Downloads](https://static.pepy.tech/badge/kmoe-manga-downloader)](https://pepy.tech/projects/kmoe-manga-downloader) [![PyPI version](https://img.shields.io/pypi/v/kmoe-manga-downloader.svg)](https://pypi.org/project/kmoe-manga-downloader/) [![Unit Tests](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml/badge.svg)](https://github.com/chrisis58/kmdr/actions/workflows/unit-test.yml) [![Interpretor](https://img.shields.io/badge/python-3.9+-blue)](https://www.python.org/) [![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/chrisis58/kmdr/blob/main/LICENSE)
 
-`kmdr (Kmoe Manga Downloader)` 是一个 Python 脚本，用于从 [Kmoe](https://kox.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定书籍及其卷，并支持回调脚本执行。
+`kmdr (Kmoe Manga Downloader)` 是一个 Python 应用，用于从 [Kmoe](https://kox.moe/) 网站下载漫画。它支持在终端环境下的登录、下载指定书籍及其卷，并支持回调脚本执行。
 
 ## ✨功能特性
 
-- 以命令行参数登录网站并持久化凭证
-- 支持多种方式筛选需要的内容
-- 支持网站上提供的不同的下载方式
-- 支持多线程下载，失败重试、断点续传
-- 提供自定义的下载完成回调命令
-- 提供通用配置持久化的实现
+- **凭证管理**: 命令行登录并持久化会话
+- **多种下载方式**: 支持通过书籍 URL 或从收藏列表下载
+- **高效下载**: 支持多线程、失败重试及断点续传
+- **配置持久化**: 保存常用下载目录、代理等设置
+- **回调支持**: 下载完成后自动执行自定义脚本
 
-## 🛠️安装依赖
+## 🛠️安装应用
 
-在使用本脚本之前，请确保你已经安装了项目所需要的依赖：
+你可以通过 PyPI 使用 `pip` 进行安装：
 
 ```bash
-git clone https://github.com/chrisis58/kmoe-manga-downloader.git
-cd kmoe-manga-downloader
-
-pip install -r requirements.txt
+pip install kmoe-manga-downloader
 ```
 
 ## 📋使用方法
@@ -74,35 +70,34 @@ pip install -r requirements.txt
 首先需要登录 `kox.moe` 并保存登录状态（Cookie）。
 
 ```bash
-python kmdr.py login -u <your_username> -p <your_password>
+kmdr login -u <your_username> -p <your_password>
+# 或者
+kmdr login -u <your_username>
 ```
 
-或者：
+第二种方式会在程序运行时获取登录密码，此时你输入的密码**不会显示**在终端中。
 
-```bash
-python kmdr.py login -u <your_username>
-```
-
-第二种方式会在程序运行时获取登录密码。如果登录成功，会同时显示当前登录用户及配额。
+如果登录成功，会同时显示当前登录用户及配额。
 
 ### 2. 下载漫画书籍
 
 你可以通过以下命令下载指定书籍或卷：
 
 ```bash
-# 在 path/to/destination 目录下载第一、二、三卷
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm --volume 1,2,3
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3
+# 在当前目录下载第一、二、三卷
+kmdr download --dest . --book-url https://kox.moe/c/50076.htm --volume 1,2,3
+kmdr download -l https://kox.moe/c/50076.htm -v 1-3
 ```
 
 ```bash
-# 在 path/to/download/destination 目录下载全部番外篇
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm --vol-type extra -v all
+# 在目标目录下载全部番外篇
+kmdr download --dest path/to/destination --book-url https://kox.moe/c/50076.htm --vol-type extra -v all
+kmdr download -d path/to/destination -l https://kox.moe/c/50076.htm -t extra -v all
 ```
 
 #### 常用参数说明：
 
-- `-d`, `--dest`: 下载的目标目录，在此基础上会额外添加一个为书籍名称的子目录
+- `-d`, `--dest`: 下载的目标目录（默认为当前目录），在此基础上会额外添加一个为书籍名称的子目录
 - `-l`, `--book-url`: 指定书籍的主页地址
 - `-v`, `--volume`: 指定卷的名称，多个名称使用逗号分隔，`all` 表示下载所有卷
 - `-t`, `--vol-type`: 卷类型，`vol`: 单行本（默认）；`extra`: 番外；`seri`: 连载话；`all`: 全部
@@ -115,10 +110,10 @@ python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/5007
 
 ### 3. 查看账户状态
 
-查看当前账户信息（例如：账户名和配额等）：
+查看当前账户信息（账户名和配额等）：
 
 ```bash
-python kmdr.py status
+kmdr status
 ```
 
 ### 4. 回调函数
@@ -126,7 +121,7 @@ python kmdr.py status
 你可以设置一个回调函数，下载完成后执行。回调可以是任何你想要的命令：
 
 ```bash
-python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3 \
+kmdr download -d path/to/destination --book-url https://kox.moe/c/50076.htm -v 1-3 \
 	--callback "echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
 ```
 
@@ -146,11 +141,11 @@ python kmdr.py download -d path/to/destination --book-url https://kox.moe/c/5007
 
 ### 5. 持久化配置
 
-重复设置下载的代理服务器、目标路径等参数，可能会降低脚本的使用效率。所以脚本也提供了通用配置的持久化命令：
+重复设置下载的代理服务器、目标路径等参数，可能会降低应用的使用效率。所以应用也提供了通用配置的持久化命令：
 
 ```bash
-python kmdr.py config --set proxy=http://localhost:7890 dest=/path/to/destination
-python kmdr.py config -s num_workers=5 "callback=echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
+kmdr config --set proxy=http://localhost:7890 dest=/path/to/destination
+kmdr config -s num_workers=5 "callback=echo '{b.name} {v.name} downloaded!' >> ~/kmdr.log"
 ```
 
 只需要配置一次即可对之后的所有的下载指令生效。
@@ -175,8 +170,7 @@ python kmdr.py config -s num_workers=5 "callback=echo '{b.name} {v.name} downloa
 ---
 
 <div align=center> 
-💬任何使用中遇到的问题、希望添加的功能，都欢迎提交 issue 或开 discussion 交流！<br />
+💬任何使用中遇到的问题、希望添加的功能，都欢迎提交 issue 交流！<br />
 ⭐ 如果这个项目对你有帮助，请给它一个星标！<br /> <br /> 
 <img src="https://counter.seku.su/cmoe?name=kmdr&theme=mbs" />
 </div>
-

{kmoe_manga_downloader-1.0.0 → kmoe_manga_downloader-1.1.0}/src/kmoe_manga_downloader.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ src/kmdr/main.py
 src/kmdr/core/__init__.py
 src/kmdr/core/bases.py
 src/kmdr/core/defaults.py
+src/kmdr/core/error.py
 src/kmdr/core/registry.py
 src/kmdr/core/structure.py
 src/kmdr/core/utils.py
@@ -33,6 +34,7 @@ src/kmoe_manga_downloader.egg-info/dependency_links.txt
 src/kmoe_manga_downloader.egg-info/entry_points.txt
 src/kmoe_manga_downloader.egg-info/requires.txt
 src/kmoe_manga_downloader.egg-info/top_level.txt
+tests/test_cache_by_kwargs.py
 tests/test_kmdr_config_option.py
 tests/test_kmdr_download.py
 tests/test_kmdr_login.py

kmoe_manga_downloader-1.1.0/tests/test_cache_by_kwargs.py

@@ -0,0 +1,87 @@
+import unittest
+
+from kmdr.module.downloader.utils import cached_by_kwargs, clear_cache
+
+@cached_by_kwargs
+def add(a, b, c):
+    return a + b + c
+
+class TestAdder(object):
+
+    @cached_by_kwargs
+    def add(self, a, b, c):
+        return a + b + c
+    
+class AddUtil:
+
+    @staticmethod
+    @cached_by_kwargs
+    def add(a, b, c):
+        return a + b + c
+
+    @classmethod
+    @cached_by_kwargs
+    def mul(cls, a, b, c):
+        return a * b * c
+
+class TestCacheByKwargs(unittest.TestCase):
+
+    def tearDown(self):
+        clear_cache(add)
+        clear_cache(TestAdder.add)
+        clear_cache(AddUtil.add)
+        clear_cache(AddUtil.mul)
+
+    def test_function_cache(self):
+        result1 = add(1, 2, c=3)
+        result2 = add(3, 2, c=3)
+        self.assertEqual(result1, result2)
+
+    def test_classmethod_cache(self):
+        result1 = AddUtil.add(1, 2, c=6)
+        result2 = AddUtil.add(3, 2, c=6)
+        self.assertEqual(result1, result2)
+
+    def test_instance_method_cache(self):
+        instance = TestAdder()
+        result1 = instance.add(1, 2, c=9)
+        result2 = instance.add(3, 2, c=9)
+        self.assertEqual(result1, result2)
+
+    def test_different_definitions(self):
+        result1 = add(1, b=2, c=3)
+        result2 = AddUtil.add(2, b=2, c=3)
+        result3 = TestAdder().add(3, b=2, c=3)
+
+        self.assertNotEqual(result1, result2)
+        self.assertNotEqual(result1, result3)
+        self.assertNotEqual(result2, result3)
+
+    def test_classmethod_cache(self):
+        result1 = AddUtil.mul(1, 2, c=3)
+        result2 = AddUtil.mul(2, 2, c=3)
+        self.assertEqual(result1, result2)
+
+    def test_different_instance(self):
+        instance1 = TestAdder()
+        instance2 = TestAdder()
+        result1 = instance1.add(1, 2, c=12)
+        result2 = instance2.add(2, 3, c=12)
+
+        self.assertEqual(result1, result2)
+
+    def test_clear_cache(self):
+        result1 = add(1, 2, c=0)
+        clear_cache(add)
+        result2 = add(2, 3, c=0)
+        self.assertNotEqual(result1, result2)
+
+        result1 = AddUtil.add(1, 2, c=0)
+        clear_cache(AddUtil.add)
+        result2 = AddUtil.add(2, 3, c=0)
+        self.assertNotEqual(result1, result2)
+
+        result1 = TestAdder().add(1, 2, c=0)
+        clear_cache(TestAdder.add)
+        result2 = TestAdder().add(2, 3, c=0)
+        self.assertNotEqual(result1, result2)

kmoe_manga_downloader-1.0.0/src/kmdr/module/authenticator/utils.py

@@ -1,25 +0,0 @@
-from requests import Session
-
-def check_status(session: Session, show_quota: bool = False) -> bool:
-    response = session.get(url = 'https://kox.moe/my.php')
-
-    try:
-        response.raise_for_status()
-    except Exception as e:
-        print(f"Error: {type(e).__name__}: {e}")
-        return False
-
-    if not show_quota:
-        return True
-    
-    from bs4 import BeautifulSoup
-
-    soup = BeautifulSoup(response.text, 'html.parser')
-    
-    nickname = soup.find('div', id='div_nickname_display').text.strip().split(' ')[0]
-    print(f"=========================\n\nLogged in as {nickname}\n\n=========================\n")
-    
-    quota = soup.find('div', id='div_user_vip').text.strip()
-    print(f"=========================\n\n{quota}\n\n=========================\n")
-    return True
-