jmcomic 2.5.14__tar.gz → 2.5.16__tar.gz

{jmcomic-2.5.14/src/jmcomic.egg-info → jmcomic-2.5.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jmcomic
-Version: 2.5.14
+Version: 2.5.16
 Summary: Python API For JMComic (禁漫天堂)
 Home-page: https://github.com/hect0x7/JMComic-Crawler-Python
 Author: hect0x7
@@ -40,24 +40,26 @@ Requires-Dist: pycryptodome
 
 ## 项目介绍
 
-本项目的核心功能是下载本子，基于此，设计了一套方便使用、便于扩展，能满足一些特殊下载需求的框架。
+本项目的核心功能是下载本子。
 
-目前核心功能实现较为稳定，项目也处于维护阶段。
+基于此，设计了一套方便使用、便于扩展，能满足一些特殊下载需求的框架。
 
-除了下载功能以外，也实现了其他的一些禁漫接口，按需实现，具体如下。
+目前核心功能实现较为稳定，项目也处于维护阶段。
 
-### 已实现的禁漫API：
+除了下载功能以外，也实现了其他的一些禁漫接口，按需实现。目前已有功能：
 
 - 登录
-- 搜本
-- 分类 (排行榜)
-- 本子章节详情
+- 搜索本子（支持所有搜索项）
 - 图片下载解码
-- 收藏夹
-- 移动端接口加解密
+- 分类/排行榜
+- 本子/章节详情
+- 个人收藏夹
+- 接口加解密（APP的接口）
 
 ## 安装教程
 
+> ⚠如果你没有安装过Python，需要先安装Python再执行下面的步骤，且版本需要>=3.7（[点我去python官网下载](https://www.python.org/downloads/)）
+
 * 通过pip官方源安装（推荐，并且更新也是这个命令）
 
   ```shell
@@ -72,7 +74,9 @@ Requires-Dist: pycryptodome
 ## 快速上手
 
 ### 1. 下载本子方法
+
 只需要使用如下代码，就可以下载本子`JM422866`的所有章节的图片：
+
 ```python
 import jmcomic  # 导入此模块，需要先安装.
 jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载整个album到本地.
@@ -85,10 +89,10 @@ jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载
 ### 2. 使用option配置来下载本子
 
 1. 首先，创建一个配置文件，假设文件名为 `option.yml`
-   
-    该文件有特定的写法，你需要参考这个文档 → [option配置](./assets/docs/sources/option_file_syntax.md)
-    
-    下面做一个演示，假设你需要把下载的图片转为png格式，你应该把以下内容写进`option.yml`
+
+   该文件有特定的写法，你需要参考这个文档 → [配置文件指南](./assets/docs/sources/option_file_syntax.md)
+
+   下面做一个演示，假设你需要把下载的图片转为png格式，你应该把以下内容写进`option.yml`
 
 ```yml
 download:
@@ -97,6 +101,7 @@ download:
 ```
 
 2. 第二步，运行下面的python代码
+
 ```python
 import jmcomic
 
@@ -104,24 +109,14 @@ import jmcomic
 option = jmcomic.create_option_by_file('你的配置文件路径，例如 D:/option.yml')
 # 使用option对象来下载本子
 jmcomic.download_album(422866, option)
+# 等价写法: option.download_album(422866)
 ```
 
-
-
 ## 进阶使用
 
-文档网站：[jmcomic.readthedocs.io](https://jmcomic.readthedocs.io/en/latest)
-
-首先，就下载功能，jmcomic提供了很多配置项，大部分的下载需求你都可以通过上文介绍的配置文件来配置。
+请查阅文档首页→[jmcomic.readthedocs.io](https://jmcomic.readthedocs.io/zh-cn/latest)
 
-如果你不满足于下载，还有其他的使用需求，推荐你先看看以下文档：
-
-* [jmcomic常用类和方法演示](assets/docs/sources/tutorial/0_demo.md)
-* [option配置文件语法（包含插件配置）](./assets/docs/sources/option_file_syntax.md)
-* [GitHub Actions使用教程](./assets/docs/sources/tutorial/1_github_actions.md)
-* [命令行使用教程](assets/docs/sources/tutorial/2_command_line.md)
-* [插件机制](assets/docs/sources/tutorial/6_plugin.md)
-* [下载过滤器机制](assets/docs/sources/tutorial/5_filter.md)
+（提示：jmcomic提供了很多下载配置项，大部分的下载需求你都可以尝试寻找相关配置项或插件来实现。）
 
 ## 项目特点
 
@@ -129,35 +124,35 @@ jmcomic.download_album(422866, option)
 - **实现禁漫APP接口最新的加解密算法 (1.6.3)**
 - 用法多样：
 
-    - GitHub
-      Actions：网页上直接输入本子id就能下载（[教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)）
-    - 命令行：无需写Python代码，简单易用（[教程：使用命令行下载禁漫本子](./assets/docs/sources/tutorial/2_command_line.md)）
-    - Python代码：最本质、最强大的使用方式，需要你有一定的python编程基础
+  - GitHub
+    Actions：网页上直接输入本子id就能下载（[教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)）
+  - 命令行：无需写Python代码，简单易用（[教程：使用命令行下载禁漫本子](./assets/docs/sources/tutorial/2_command_line.md)）
+  - Python代码：最本质、最强大的使用方式，需要你有一定的python编程基础
 - 支持**网页端**和**移动端**两种客户端实现，可通过配置切换（**移动端不限ip兼容性好，网页端限制ip地区但效率高**）
 - 支持**自动重试和域名切换**机制
 - **多线程下载**（可细化到一图一线程，效率极高）
 - **可配置性强**
 
-    - 不配置也能使用，十分方便
-    - 配置可以从配置文件生成，支持多种文件格式
-    - 配置点有：`请求域名` `客户端实现` `是否使用磁盘缓存` `同时下载的章节/图片数量` `图片格式转换` `下载路径规则` `请求元信息（headers,cookies,proxies）`
-  等
+  - 不配置也能使用，十分方便
+  - 配置可以从配置文件生成，支持多种文件格式
+  - 配置点有：`请求域名` `客户端实现` `是否使用磁盘缓存` `同时下载的章节/图片数量` `图片格式转换` `下载路径规则` `请求元信息（headers,cookies,proxies）`
+    等
 - **可扩展性强**
 
-    - 支持自定义本子/章节/图片下载前后的回调函数
-    - 支持自定义类：`Downloader（负责调度）` `Option（负责配置）` `Client（负责请求）` `实体类`等
-    - 支持自定义日志、异常监听器
-    - **支持Plugin插件，可以方便地扩展功能，以及使用别人的插件，目前内置插件有**：
-        - `登录插件`
-        - `硬件占用监控插件`
-        - `只下载新章插件`
-        - `压缩文件插件`
-        - `下载特定后缀图片插件`
-        - `发送QQ邮件插件`
-        - `日志主题过滤插件`
-        - `自动使用浏览器cookies插件`
-        - `jpg图片合成为一个pdf插件`
-        - `导出收藏夹为csv文件插件`
+  - 支持自定义本子/章节/图片下载前后的回调函数
+  - 支持自定义类：`Downloader（负责调度）` `Option（负责配置）` `Client（负责请求）` `实体类`等
+  - 支持自定义日志、异常监听器
+  - **支持Plugin插件，可以方便地扩展功能，以及使用别人的插件，目前内置插件有**：
+    - `登录插件`
+    - `硬件占用监控插件`
+    - `只下载新章插件`
+    - `压缩文件插件`
+    - `下载特定后缀图片插件`
+    - `发送QQ邮件插件`
+    - `日志主题过滤插件`
+    - `自动使用浏览器cookies插件`
+    - `jpg图片合成为一个pdf插件`
+    - `导出收藏夹为csv文件插件`
 
 ## 使用小说明
 
@@ -169,13 +164,11 @@ jmcomic.download_album(422866, option)
 * .github：GitHub Actions配置文件
 * assets：存放一些非代码的资源文件
 
-    * docs：项目文档
-    * option：存放配置文件
-
+  * docs：项目文档
+  * option：存放配置文件
 * src：存放源代码
 
-    * jmcomic：`jmcomic`模块
-
+  * jmcomic：`jmcomic`模块
 * tests：测试目录，存放测试代码，使用unittest
 * usage：用法目录，存放示例/使用代码
 
@@ -183,4 +176,10 @@ jmcomic.download_album(422866, option)
 
 ### 图片分割算法代码+禁漫移动端API
 
-[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt)](https://github.com/tonquer/JMComic-qt)
+<a href="https://github.com/tonquer/JMComic-qt">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt&theme=radical" />
+    <source media="(prefers-color-scheme: light)" srcset="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt" />
+    <img alt="Repo Card" src="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt" />
+  </picture>
+</a>

jmcomic-2.5.16/README.md

@@ -0,0 +1,157 @@
+# Python API For JMComic (禁漫天堂)
+
+本项目封装了一套可用于爬取JM的Python API.
+
+你可以通过简单的几行Python代码，实现下载JM上的本子到本地，并且是处理好的图片。
+
+[【指路】教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)
+
+[【指路】教程：导出并下载你的禁漫收藏夹数据](./assets/docs/sources/tutorial/10_export_favorites.md)
+
+**友情提示：珍爱JM，为了减轻JM的服务器压力，请不要一次性爬取太多本子，西门🙏🙏🙏**.
+
+## 项目介绍
+
+本项目的核心功能是下载本子。
+
+基于此，设计了一套方便使用、便于扩展，能满足一些特殊下载需求的框架。
+
+目前核心功能实现较为稳定，项目也处于维护阶段。
+
+除了下载功能以外，也实现了其他的一些禁漫接口，按需实现。目前已有功能：
+
+- 登录
+- 搜索本子（支持所有搜索项）
+- 图片下载解码
+- 分类/排行榜
+- 本子/章节详情
+- 个人收藏夹
+- 接口加解密（APP的接口）
+
+## 安装教程
+
+> ⚠如果你没有安装过Python，需要先安装Python再执行下面的步骤，且版本需要>=3.7（[点我去python官网下载](https://www.python.org/downloads/)）
+
+* 通过pip官方源安装（推荐，并且更新也是这个命令）
+
+  ```shell
+  pip install jmcomic -i https://pypi.org/project -U
+  ```
+* 通过源代码安装
+
+  ```shell
+  pip install git+https://github.com/hect0x7/JMComic-Crawler-Python
+  ```
+
+## 快速上手
+
+### 1. 下载本子方法
+
+只需要使用如下代码，就可以下载本子`JM422866`的所有章节的图片：
+
+```python
+import jmcomic  # 导入此模块，需要先安装.
+jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载整个album到本地.
+```
+
+上面的 `download_album`方法还有一个参数`option`，可用于控制下载配置，配置包括禁漫域名、网络代理、图片格式转换、插件等等。
+
+你可能需要这些配置项。推荐使用配置文件创建option，用option下载本子，见下章：
+
+### 2. 使用option配置来下载本子
+
+1. 首先，创建一个配置文件，假设文件名为 `option.yml`
+
+   该文件有特定的写法，你需要参考这个文档 → [配置文件指南](./assets/docs/sources/option_file_syntax.md)
+
+   下面做一个演示，假设你需要把下载的图片转为png格式，你应该把以下内容写进`option.yml`
+
+```yml
+download:
+  image:
+    suffix: .png # 该配置用于把下载的图片转为png格式
+```
+
+2. 第二步，运行下面的python代码
+
+```python
+import jmcomic
+
+# 创建配置对象
+option = jmcomic.create_option_by_file('你的配置文件路径，例如 D:/option.yml')
+# 使用option对象来下载本子
+jmcomic.download_album(422866, option)
+# 等价写法: option.download_album(422866)
+```
+
+## 进阶使用
+
+请查阅文档首页→[jmcomic.readthedocs.io](https://jmcomic.readthedocs.io/zh-cn/latest)
+
+（提示：jmcomic提供了很多下载配置项，大部分的下载需求你都可以尝试寻找相关配置项或插件来实现。）
+
+## 项目特点
+
+- **绕过Cloudflare的反爬虫**
+- **实现禁漫APP接口最新的加解密算法 (1.6.3)**
+- 用法多样：
+
+  - GitHub
+    Actions：网页上直接输入本子id就能下载（[教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)）
+  - 命令行：无需写Python代码，简单易用（[教程：使用命令行下载禁漫本子](./assets/docs/sources/tutorial/2_command_line.md)）
+  - Python代码：最本质、最强大的使用方式，需要你有一定的python编程基础
+- 支持**网页端**和**移动端**两种客户端实现，可通过配置切换（**移动端不限ip兼容性好，网页端限制ip地区但效率高**）
+- 支持**自动重试和域名切换**机制
+- **多线程下载**（可细化到一图一线程，效率极高）
+- **可配置性强**
+
+  - 不配置也能使用，十分方便
+  - 配置可以从配置文件生成，支持多种文件格式
+  - 配置点有：`请求域名` `客户端实现` `是否使用磁盘缓存` `同时下载的章节/图片数量` `图片格式转换` `下载路径规则` `请求元信息（headers,cookies,proxies）`
+    等
+- **可扩展性强**
+
+  - 支持自定义本子/章节/图片下载前后的回调函数
+  - 支持自定义类：`Downloader（负责调度）` `Option（负责配置）` `Client（负责请求）` `实体类`等
+  - 支持自定义日志、异常监听器
+  - **支持Plugin插件，可以方便地扩展功能，以及使用别人的插件，目前内置插件有**：
+    - `登录插件`
+    - `硬件占用监控插件`
+    - `只下载新章插件`
+    - `压缩文件插件`
+    - `下载特定后缀图片插件`
+    - `发送QQ邮件插件`
+    - `日志主题过滤插件`
+    - `自动使用浏览器cookies插件`
+    - `jpg图片合成为一个pdf插件`
+    - `导出收藏夹为csv文件插件`
+
+## 使用小说明
+
+* Python >= 3.7
+* 个人项目，文档和示例会有不及时之处，可以Issue提问
+
+## 项目文件夹介绍
+
+* .github：GitHub Actions配置文件
+* assets：存放一些非代码的资源文件
+
+  * docs：项目文档
+  * option：存放配置文件
+* src：存放源代码
+
+  * jmcomic：`jmcomic`模块
+* tests：测试目录，存放测试代码，使用unittest
+* usage：用法目录，存放示例/使用代码
+
+## 感谢以下项目
+
+### 图片分割算法代码+禁漫移动端API
+
+<a href="https://github.com/tonquer/JMComic-qt">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt&theme=radical" />
+    <source media="(prefers-color-scheme: light)" srcset="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt" />
+    <img alt="Repo Card" src="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt" />
+  </picture>
+</a>

{jmcomic-2.5.14 → jmcomic-2.5.16}/src/jmcomic/__init__.py

@@ -2,7 +2,7 @@
 # 被依赖方 <--- 使用方
 # config <--- entity <--- toolkit <--- client <--- option <--- downloader
 
-__version__ = '2.5.14'
+__version__ = '2.5.16'
 
 from .api import *
 from .jm_plugin import *

{jmcomic-2.5.14 → jmcomic-2.5.16}/src/jmcomic/api.py

@@ -2,6 +2,7 @@ from .jm_downloader import *
 
 __DOWNLOAD_API_RET = Tuple[JmAlbumDetail, JmDownloader]
 
+
 def download_batch(download_api,
                    jm_id_iter: Union[Iterable, Generator],
                    option=None,

{jmcomic-2.5.14 → jmcomic-2.5.16}/src/jmcomic/jm_client_impl.py

@@ -27,7 +27,7 @@ class AbstractJmClient(
         self.retry_times = retry_times
         self.domain_list = domain_list
         self.CLIENT_CACHE = None
-        self.__username = None  # help for favorite_folder method
+        self._username = None  # help for favorite_folder method
         self.enable_cache()
         self.after_init()
 
@@ -402,7 +402,7 @@ class JmHtmlClient(AbstractJmClient):
                          allow_redirects=False,
                          )
 
-        if resp.status_code != 301:
+        if resp.status_code != 200:
             ExceptionTool.raises_resp(f'登录失败，状态码为{resp.status_code}', resp)
 
         orig_cookies = self.get_meta_data('cookies') or {}
@@ -412,7 +412,7 @@ class JmHtmlClient(AbstractJmClient):
             return resp
 
         self['cookies'] = new_cookies
-        self.__username = username
+        self._username = username
 
         return resp
 
@@ -423,8 +423,8 @@ class JmHtmlClient(AbstractJmClient):
                         username='',
                         ) -> JmFavoritePage:
         if username == '':
-            ExceptionTool.require_true(self.__username is not None, 'favorite_folder方法需要传username参数')
-            username = self.__username
+            ExceptionTool.require_true(self._username is not None, 'favorite_folder方法需要传username参数')
+            username = self._username
 
         resp = self.get_jm_html(
             f'/user/{username}/favorite/albums',
@@ -973,6 +973,11 @@ class JmApiClient(AbstractJmClient):
             # 例如图片请求
             return resp
 
+        code = resp.status_code
+        if code >= 500:
+            msg = JmModuleConfig.JM_ERROR_STATUS_CODE.get(code, f'HTTP状态码: {code}')
+            ExceptionTool.raises_resp(f"禁漫API异常响应, {msg}", resp)
+
         url = resp.request.url
 
         if self.API_SCRAMBLE in url:

{jmcomic-2.5.14 → jmcomic-2.5.16}/src/jmcomic/jm_config.py

@@ -123,6 +123,7 @@ class JmModuleConfig:
     # JM的异常网页code
     JM_ERROR_STATUS_CODE = {
         403: 'ip地区禁止访问/爬虫被识别',
+        500: '500: 禁漫服务器内部异常（可能是服务器过载，可以换个ip或稍后重试）',
         520: '520: Web server is returning an unknown error (禁漫服务器内部报错)',
         524: '524: The origin web server timed out responding to this request. (禁漫服务器处理超时)',
     }

{jmcomic-2.5.14 → jmcomic-2.5.16}/src/jmcomic/jm_entity.py

@@ -1,3 +1,5 @@
+from functools import lru_cache
+
 from common import *
 
 from .jm_config import *
@@ -400,6 +402,7 @@ class JmPhotoDetail(DetailEntity, Downloadable):
     def id(self):
         return self.photo_id
 
+    @lru_cache(None)
     def getindex(self, index) -> JmImageDetail:
         return self.create_image_detail(index)
 
@@ -514,6 +517,7 @@ class JmAlbumDetail(DetailEntity, Downloadable):
 
         return photo
 
+    @lru_cache(None)
     def getindex(self, item) -> JmPhotoDetail:
         return self.create_photo_detail(item)
 

{jmcomic-2.5.14 → jmcomic-2.5.16}/src/jmcomic/jm_option.py

@@ -270,15 +270,7 @@ class JmOption:
         )
 
         if ensure_exists:
-            try:
-                mkdir_if_not_exists(save_dir)
-            except OSError as e:
-                if e.errno == 36:
-                    # 目录名过长
-                    limit = JmModuleConfig.VAR_FILE_NAME_LENGTH_LIMIT
-                    jm_log('error', f'目录名过长，无法创建目录，强制缩短到{limit}个字符并重试')
-                    save_dir = save_dir[0:limit]
-                    mkdir_if_not_exists(save_dir)
+            save_dir = JmcomicText.try_mkdir(save_dir)
 
         return save_dir
 
@@ -517,13 +509,21 @@ class JmOption:
 
     # 下面的方法提供面向对象的调用风格
 
-    def download_album(self, album_id):
+    def download_album(self,
+                       album_id,
+                       downloader=None,
+                       callback=None,
+                       ):
         from .api import download_album
-        download_album(album_id, self)
+        download_album(album_id, self, downloader, callback)
 
-    def download_photo(self, photo_id):
+    def download_photo(self,
+                       photo_id,
+                       downloader=None,
+                       callback=None
+                       ):
         from .api import download_photo
-        download_photo(photo_id, self)
+        download_photo(photo_id, self, downloader, callback)
 
     # 下面的方法为调用插件提供支持
 

{jmcomic-2.5.14 → jmcomic-2.5.16}/src/jmcomic/jm_plugin.py

@@ -734,13 +734,17 @@ class Img2pdfPlugin(JmOptionPlugin):
     plugin_key = 'img2pdf'
 
     def invoke(self,
-               photo: JmPhotoDetail,
+               photo: JmPhotoDetail = None,
+               album: JmAlbumDetail = None,
                downloader=None,
                pdf_dir=None,
                filename_rule='Pid',
                delete_original_file=False,
                **kwargs,
                ):
+        if photo is None and album is None:
+            jm_log('wrong_usage', 'img2pdf必须运行在after_photo或after_album时')
+
         try:
             import img2pdf
         except ImportError:
@@ -749,28 +753,50 @@ class Img2pdfPlugin(JmOptionPlugin):
 
         self.delete_original_file = delete_original_file
 
-        # 处理文件夹配置
-        filename = DirRule.apply_rule_directly(None, photo, filename_rule)
-        photo_dir = self.option.decide_image_save_dir(photo)
-
         # 处理生成的pdf文件的路径
-        if pdf_dir is None:
-            pdf_dir = photo_dir
-        else:
-            pdf_dir = fix_filepath(pdf_dir, True)
-            mkdir_if_not_exists(pdf_dir)
+        pdf_dir = self.ensure_make_pdf_dir(pdf_dir)
+
+        # 处理pdf文件名
+        filename = DirRule.apply_rule_directly(album, photo, filename_rule)
 
+        # pdf路径
         pdf_filepath = os.path.join(pdf_dir, f'{filename}.pdf')
 
         # 调用 img2pdf 把 photo_dir 下的所有图片转为pdf
-        all_img = files_of_dir(photo_dir)
-        with open(pdf_filepath, 'wb') as f:
-            f.write(img2pdf.convert(all_img))
+        img_path_ls, img_dir_ls = self.write_img_2_pdf(pdf_filepath, album, photo)
+        self.log(f'Convert Successfully: JM{album or photo} → {pdf_filepath}')
 
         # 执行删除
-        self.log(f'Convert Successfully: JM{photo.id} → {pdf_filepath}')
-        all_img.append(self.option.decide_image_save_dir(photo, ensure_exists=False))
-        self.execute_deletion(all_img)
+        img_path_ls += img_dir_ls
+        self.execute_deletion(img_path_ls)
+
+    def write_img_2_pdf(self, pdf_filepath, album: JmAlbumDetail, photo: JmPhotoDetail):
+        import img2pdf
+
+        if album is None:
+            img_dir_ls = [self.option.decide_image_save_dir(photo)]
+        else:
+            img_dir_ls = [self.option.decide_image_save_dir(photo) for photo in album]
+
+        img_path_ls = []
+
+        for img_dir in img_dir_ls:
+            imgs = files_of_dir(img_dir)
+            if not imgs:
+                continue
+            img_path_ls += imgs
+
+        with open(pdf_filepath, 'wb') as f:
+            f.write(img2pdf.convert(img_path_ls))
+
+        return img_path_ls, img_dir_ls
+
+    @staticmethod
+    def ensure_make_pdf_dir(pdf_dir: str):
+        pdf_dir = pdf_dir or os.getcwd()
+        pdf_dir = fix_filepath(pdf_dir, True)
+        mkdir_if_not_exists(pdf_dir)
+        return pdf_dir
 
 
 class JmServerPlugin(JmOptionPlugin):
@@ -1067,3 +1093,27 @@ class DeleteDuplicatedFilesPlugin(JmOptionPlugin):
                           [f'  {path}' for path in paths]
                 self.log('\n'.join(message))
                 self.execute_deletion(paths)
+
+
+class ReplacePathStringPlugin(JmOptionPlugin):
+    plugin_key = 'replace_path_string'
+
+    def invoke(self,
+               replace: Dict[str, str],
+               ):
+        if not replace:
+            return
+
+        old_decide_dir = self.option.decide_image_save_dir
+
+        def new_decide_dir(photo, ensure_exists=True) -> str:
+            original_path: str = old_decide_dir(photo, False)
+            for k, v in replace.items():
+                original_path = original_path.replace(k, v)
+
+            if ensure_exists:
+                JmcomicText.try_mkdir(original_path)
+
+            return original_path
+
+        self.option.decide_image_save_dir = new_decide_dir

{jmcomic-2.5.14 → jmcomic-2.5.16}/src/jmcomic/jm_toolkit.py

@@ -316,6 +316,19 @@ class JmcomicText:
         import zhconv
         return zhconv.convert(s, 'zh_cn')
 
+    @classmethod
+    def try_mkdir(cls, save_dir: str):
+        try:
+            mkdir_if_not_exists(save_dir)
+        except OSError as e:
+            if e.errno == 36:
+                # 目录名过长
+                limit = JmModuleConfig.VAR_FILE_NAME_LENGTH_LIMIT
+                jm_log('error', f'目录名过长，无法创建目录，强制缩短到{limit}个字符并重试')
+                save_dir = save_dir[0:limit]
+                mkdir_if_not_exists(save_dir)
+        return save_dir
+
 
 # 支持dsl: #{???} -> os.getenv(???)
 JmcomicText.dsl_replacer.add_dsl_and_replacer(r'\$\{(.*?)\}', JmcomicText.match_os_env)

{jmcomic-2.5.14 → jmcomic-2.5.16/src/jmcomic.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jmcomic
-Version: 2.5.14
+Version: 2.5.16
 Summary: Python API For JMComic (禁漫天堂)
 Home-page: https://github.com/hect0x7/JMComic-Crawler-Python
 Author: hect0x7
@@ -40,24 +40,26 @@ Requires-Dist: pycryptodome
 
 ## 项目介绍
 
-本项目的核心功能是下载本子，基于此，设计了一套方便使用、便于扩展，能满足一些特殊下载需求的框架。
+本项目的核心功能是下载本子。
 
-目前核心功能实现较为稳定，项目也处于维护阶段。
+基于此，设计了一套方便使用、便于扩展，能满足一些特殊下载需求的框架。
 
-除了下载功能以外，也实现了其他的一些禁漫接口，按需实现，具体如下。
+目前核心功能实现较为稳定，项目也处于维护阶段。
 
-### 已实现的禁漫API：
+除了下载功能以外，也实现了其他的一些禁漫接口，按需实现。目前已有功能：
 
 - 登录
-- 搜本
-- 分类 (排行榜)
-- 本子章节详情
+- 搜索本子（支持所有搜索项）
 - 图片下载解码
-- 收藏夹
-- 移动端接口加解密
+- 分类/排行榜
+- 本子/章节详情
+- 个人收藏夹
+- 接口加解密（APP的接口）
 
 ## 安装教程
 
+> ⚠如果你没有安装过Python，需要先安装Python再执行下面的步骤，且版本需要>=3.7（[点我去python官网下载](https://www.python.org/downloads/)）
+
 * 通过pip官方源安装（推荐，并且更新也是这个命令）
 
   ```shell
@@ -72,7 +74,9 @@ Requires-Dist: pycryptodome
 ## 快速上手
 
 ### 1. 下载本子方法
+
 只需要使用如下代码，就可以下载本子`JM422866`的所有章节的图片：
+
 ```python
 import jmcomic  # 导入此模块，需要先安装.
 jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载整个album到本地.
@@ -85,10 +89,10 @@ jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载
 ### 2. 使用option配置来下载本子
 
 1. 首先，创建一个配置文件，假设文件名为 `option.yml`
-   
-    该文件有特定的写法，你需要参考这个文档 → [option配置](./assets/docs/sources/option_file_syntax.md)
-    
-    下面做一个演示，假设你需要把下载的图片转为png格式，你应该把以下内容写进`option.yml`
+
+   该文件有特定的写法，你需要参考这个文档 → [配置文件指南](./assets/docs/sources/option_file_syntax.md)
+
+   下面做一个演示，假设你需要把下载的图片转为png格式，你应该把以下内容写进`option.yml`
 
 ```yml
 download:
@@ -97,6 +101,7 @@ download:
 ```
 
 2. 第二步，运行下面的python代码
+
 ```python
 import jmcomic
 
@@ -104,24 +109,14 @@ import jmcomic
 option = jmcomic.create_option_by_file('你的配置文件路径，例如 D:/option.yml')
 # 使用option对象来下载本子
 jmcomic.download_album(422866, option)
+# 等价写法: option.download_album(422866)
 ```
 
-
-
 ## 进阶使用
 
-文档网站：[jmcomic.readthedocs.io](https://jmcomic.readthedocs.io/en/latest)
-
-首先，就下载功能，jmcomic提供了很多配置项，大部分的下载需求你都可以通过上文介绍的配置文件来配置。
+请查阅文档首页→[jmcomic.readthedocs.io](https://jmcomic.readthedocs.io/zh-cn/latest)
 
-如果你不满足于下载，还有其他的使用需求，推荐你先看看以下文档：
-
-* [jmcomic常用类和方法演示](assets/docs/sources/tutorial/0_demo.md)
-* [option配置文件语法（包含插件配置）](./assets/docs/sources/option_file_syntax.md)
-* [GitHub Actions使用教程](./assets/docs/sources/tutorial/1_github_actions.md)
-* [命令行使用教程](assets/docs/sources/tutorial/2_command_line.md)
-* [插件机制](assets/docs/sources/tutorial/6_plugin.md)
-* [下载过滤器机制](assets/docs/sources/tutorial/5_filter.md)
+（提示：jmcomic提供了很多下载配置项，大部分的下载需求你都可以尝试寻找相关配置项或插件来实现。）
 
 ## 项目特点
 
@@ -129,35 +124,35 @@ jmcomic.download_album(422866, option)
 - **实现禁漫APP接口最新的加解密算法 (1.6.3)**
 - 用法多样：
 
-    - GitHub
-      Actions：网页上直接输入本子id就能下载（[教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)）
-    - 命令行：无需写Python代码，简单易用（[教程：使用命令行下载禁漫本子](./assets/docs/sources/tutorial/2_command_line.md)）
-    - Python代码：最本质、最强大的使用方式，需要你有一定的python编程基础
+  - GitHub
+    Actions：网页上直接输入本子id就能下载（[教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)）
+  - 命令行：无需写Python代码，简单易用（[教程：使用命令行下载禁漫本子](./assets/docs/sources/tutorial/2_command_line.md)）
+  - Python代码：最本质、最强大的使用方式，需要你有一定的python编程基础
 - 支持**网页端**和**移动端**两种客户端实现，可通过配置切换（**移动端不限ip兼容性好，网页端限制ip地区但效率高**）
 - 支持**自动重试和域名切换**机制
 - **多线程下载**（可细化到一图一线程，效率极高）
 - **可配置性强**
 
-    - 不配置也能使用，十分方便
-    - 配置可以从配置文件生成，支持多种文件格式
-    - 配置点有：`请求域名` `客户端实现` `是否使用磁盘缓存` `同时下载的章节/图片数量` `图片格式转换` `下载路径规则` `请求元信息（headers,cookies,proxies）`
-  等
+  - 不配置也能使用，十分方便
+  - 配置可以从配置文件生成，支持多种文件格式
+  - 配置点有：`请求域名` `客户端实现` `是否使用磁盘缓存` `同时下载的章节/图片数量` `图片格式转换` `下载路径规则` `请求元信息（headers,cookies,proxies）`
+    等
 - **可扩展性强**
 
-    - 支持自定义本子/章节/图片下载前后的回调函数
-    - 支持自定义类：`Downloader（负责调度）` `Option（负责配置）` `Client（负责请求）` `实体类`等
-    - 支持自定义日志、异常监听器
-    - **支持Plugin插件，可以方便地扩展功能，以及使用别人的插件，目前内置插件有**：
-        - `登录插件`
-        - `硬件占用监控插件`
-        - `只下载新章插件`
-        - `压缩文件插件`
-        - `下载特定后缀图片插件`
-        - `发送QQ邮件插件`
-        - `日志主题过滤插件`
-        - `自动使用浏览器cookies插件`
-        - `jpg图片合成为一个pdf插件`
-        - `导出收藏夹为csv文件插件`
+  - 支持自定义本子/章节/图片下载前后的回调函数
+  - 支持自定义类：`Downloader（负责调度）` `Option（负责配置）` `Client（负责请求）` `实体类`等
+  - 支持自定义日志、异常监听器
+  - **支持Plugin插件，可以方便地扩展功能，以及使用别人的插件，目前内置插件有**：
+    - `登录插件`
+    - `硬件占用监控插件`
+    - `只下载新章插件`
+    - `压缩文件插件`
+    - `下载特定后缀图片插件`
+    - `发送QQ邮件插件`
+    - `日志主题过滤插件`
+    - `自动使用浏览器cookies插件`
+    - `jpg图片合成为一个pdf插件`
+    - `导出收藏夹为csv文件插件`
 
 ## 使用小说明
 
@@ -169,13 +164,11 @@ jmcomic.download_album(422866, option)
 * .github：GitHub Actions配置文件
 * assets：存放一些非代码的资源文件
 
-    * docs：项目文档
-    * option：存放配置文件
-
+  * docs：项目文档
+  * option：存放配置文件
 * src：存放源代码
 
-    * jmcomic：`jmcomic`模块
-
+  * jmcomic：`jmcomic`模块
 * tests：测试目录，存放测试代码，使用unittest
 * usage：用法目录，存放示例/使用代码
 
@@ -183,4 +176,10 @@ jmcomic.download_album(422866, option)
 
 ### 图片分割算法代码+禁漫移动端API
 
-[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt)](https://github.com/tonquer/JMComic-qt)
+<a href="https://github.com/tonquer/JMComic-qt">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt&theme=radical" />
+    <source media="(prefers-color-scheme: light)" srcset="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt" />
+    <img alt="Repo Card" src="https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt" />
+  </picture>
+</a>

jmcomic-2.5.14/README.md

@@ -1,158 +0,0 @@
-# Python API For JMComic (禁漫天堂)
-
-本项目封装了一套可用于爬取JM的Python API.
-
-你可以通过简单的几行Python代码，实现下载JM上的本子到本地，并且是处理好的图片。
-
-[【指路】教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)
-
-[【指路】教程：导出并下载你的禁漫收藏夹数据](./assets/docs/sources/tutorial/10_export_favorites.md)
-
-**友情提示：珍爱JM，为了减轻JM的服务器压力，请不要一次性爬取太多本子，西门🙏🙏🙏**.
-
-## 项目介绍
-
-本项目的核心功能是下载本子，基于此，设计了一套方便使用、便于扩展，能满足一些特殊下载需求的框架。
-
-目前核心功能实现较为稳定，项目也处于维护阶段。
-
-除了下载功能以外，也实现了其他的一些禁漫接口，按需实现，具体如下。
-
-### 已实现的禁漫API：
-
-- 登录
-- 搜本
-- 分类 (排行榜)
-- 本子章节详情
-- 图片下载解码
-- 收藏夹
-- 移动端接口加解密
-
-## 安装教程
-
-* 通过pip官方源安装（推荐，并且更新也是这个命令）
-
-  ```shell
-  pip install jmcomic -i https://pypi.org/project -U
-  ```
-* 通过源代码安装
-
-  ```shell
-  pip install git+https://github.com/hect0x7/JMComic-Crawler-Python
-  ```
-
-## 快速上手
-
-### 1. 下载本子方法
-只需要使用如下代码，就可以下载本子`JM422866`的所有章节的图片：
-```python
-import jmcomic  # 导入此模块，需要先安装.
-jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载整个album到本地.
-```
-
-上面的 `download_album`方法还有一个参数`option`，可用于控制下载配置，配置包括禁漫域名、网络代理、图片格式转换、插件等等。
-
-你可能需要这些配置项。推荐使用配置文件创建option，用option下载本子，见下章：
-
-### 2. 使用option配置来下载本子
-
-1. 首先，创建一个配置文件，假设文件名为 `option.yml`
-   
-    该文件有特定的写法，你需要参考这个文档 → [option配置](./assets/docs/sources/option_file_syntax.md)
-    
-    下面做一个演示，假设你需要把下载的图片转为png格式，你应该把以下内容写进`option.yml`
-
-```yml
-download:
-  image:
-    suffix: .png # 该配置用于把下载的图片转为png格式
-```
-
-2. 第二步，运行下面的python代码
-```python
-import jmcomic
-
-# 创建配置对象
-option = jmcomic.create_option_by_file('你的配置文件路径，例如 D:/option.yml')
-# 使用option对象来下载本子
-jmcomic.download_album(422866, option)
-```
-
-
-
-## 进阶使用
-
-文档网站：[jmcomic.readthedocs.io](https://jmcomic.readthedocs.io/en/latest)
-
-首先，就下载功能，jmcomic提供了很多配置项，大部分的下载需求你都可以通过上文介绍的配置文件来配置。
-
-如果你不满足于下载，还有其他的使用需求，推荐你先看看以下文档：
-
-* [jmcomic常用类和方法演示](assets/docs/sources/tutorial/0_demo.md)
-* [option配置文件语法（包含插件配置）](./assets/docs/sources/option_file_syntax.md)
-* [GitHub Actions使用教程](./assets/docs/sources/tutorial/1_github_actions.md)
-* [命令行使用教程](assets/docs/sources/tutorial/2_command_line.md)
-* [插件机制](assets/docs/sources/tutorial/6_plugin.md)
-* [下载过滤器机制](assets/docs/sources/tutorial/5_filter.md)
-
-## 项目特点
-
-- **绕过Cloudflare的反爬虫**
-- **实现禁漫APP接口最新的加解密算法 (1.6.3)**
-- 用法多样：
-
-    - GitHub
-      Actions：网页上直接输入本子id就能下载（[教程：使用GitHub Actions下载禁漫本子](./assets/docs/sources/tutorial/1_github_actions.md)）
-    - 命令行：无需写Python代码，简单易用（[教程：使用命令行下载禁漫本子](./assets/docs/sources/tutorial/2_command_line.md)）
-    - Python代码：最本质、最强大的使用方式，需要你有一定的python编程基础
-- 支持**网页端**和**移动端**两种客户端实现，可通过配置切换（**移动端不限ip兼容性好，网页端限制ip地区但效率高**）
-- 支持**自动重试和域名切换**机制
-- **多线程下载**（可细化到一图一线程，效率极高）
-- **可配置性强**
-
-    - 不配置也能使用，十分方便
-    - 配置可以从配置文件生成，支持多种文件格式
-    - 配置点有：`请求域名` `客户端实现` `是否使用磁盘缓存` `同时下载的章节/图片数量` `图片格式转换` `下载路径规则` `请求元信息（headers,cookies,proxies）`
-  等
-- **可扩展性强**
-
-    - 支持自定义本子/章节/图片下载前后的回调函数
-    - 支持自定义类：`Downloader（负责调度）` `Option（负责配置）` `Client（负责请求）` `实体类`等
-    - 支持自定义日志、异常监听器
-    - **支持Plugin插件，可以方便地扩展功能，以及使用别人的插件，目前内置插件有**：
-        - `登录插件`
-        - `硬件占用监控插件`
-        - `只下载新章插件`
-        - `压缩文件插件`
-        - `下载特定后缀图片插件`
-        - `发送QQ邮件插件`
-        - `日志主题过滤插件`
-        - `自动使用浏览器cookies插件`
-        - `jpg图片合成为一个pdf插件`
-        - `导出收藏夹为csv文件插件`
-
-## 使用小说明
-
-* Python >= 3.7
-* 个人项目，文档和示例会有不及时之处，可以Issue提问
-
-## 项目文件夹介绍
-
-* .github：GitHub Actions配置文件
-* assets：存放一些非代码的资源文件
-
-    * docs：项目文档
-    * option：存放配置文件
-
-* src：存放源代码
-
-    * jmcomic：`jmcomic`模块
-
-* tests：测试目录，存放测试代码，使用unittest
-* usage：用法目录，存放示例/使用代码
-
-## 感谢以下项目
-
-### 图片分割算法代码+禁漫移动端API
-
-[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=tonquer&repo=JMComic-qt)](https://github.com/tonquer/JMComic-qt)