Merge branch 'hect0x7:master' into master

Author: Greeay7

.github/ISSUE_TEMPLATE/ask-for-help.yml

@@ -14,11 +14,11 @@ body:
   - type: dropdown
     attributes:
       label: 你使用的是哪种方式？
+      multiple: true
       options:
         - GitHub Actions
         - Python代码
         - jmcomic命令行
-      default: 0
     validations:
       required: true
 
@@ -34,5 +34,8 @@ body:
 
   - type: textarea
     attributes:
-      label: 其他信息
-      placeholder: 如果有其他需要补充的信息，可以在这里留言
+      label: 额外信息（代码/option配置/截图等）
+      placeholder: |
+        - 如果是运行代码，请提供核心代码片段
+        - 如果有自定义option配置，请提供配置内容
+        - 如果是GitHub Actions，请提供运行记录的URL

.github/ISSUE_TEMPLATE/bug.yml

@@ -6,17 +6,19 @@ labels: [ 'bug' ]
 body:
   - type: checkboxes
     attributes:
-      label: 注意事项
+      label: 请确认注意事项
       options:
-        - label: 提ISSUE前，请确认你已经在GitHub Issues和Discussions里搜索过类似的问题，并且没找到想要的答案。
+        - label: 你已经在GitHub Issues和Discussions里搜索过类似的问题，并且没找到想要的答案。
           required: true
-        - label: GitHub Actions问题请到置顶的Issue反馈。
+        - label: 你使用的是最新的jmcomic版本
+          required: true
+        - label: 非GitHub Actions类问题（此类问题请专门到置顶的Issue反馈）
           required: true
 
   - type: dropdown
     attributes:
       label: 发生Bug时，你的使用方式？
-      multiple: false
+      multiple: true
       options:
         - Python代码
         - jmcomic命令行
@@ -26,7 +28,7 @@ body:
   - type: dropdown
     attributes:
       label: 你是否在禁漫官方网页或APP，验证过相应的功能是正常的？
-      multiple: false
+      multiple: true
       options:
         - 测试过，禁漫官方功能正常
         - 我要反馈的bug无需验证/不方便验证
@@ -35,18 +37,21 @@ body:
 
   - type: textarea
     attributes:
-      label: option配置+源码/命令
-      placeholder: 贴一下你的option配置 + 你使用的python代码或命令，这会帮助开发者解决bug。
+      label: 代码/option配置
+      placeholder: |
+        - 如果是运行代码，请提供核心代码片段
+        - 如果有自定义option配置，请提供配置内容
+        - 如果是GitHub Actions，请提供运行记录的URL
 
   - type: textarea
     attributes:
-      label: 你预期的结果，与实际结果的差别
+      label: 描述bug现象（你预期的结果，与实际结果的差别）
       placeholder: |
         1. 预期结果...
         2. 差别...
 
   - type: textarea
     attributes:
-      label: 其他信息
-      placeholder: 如果有其他需要补充的信息，可以在这里留言
+      label: 其他可提供的信息
+      placeholder: 截图/程序输出日志等
 

.github/workflows/test_html.yml

@@ -16,7 +16,7 @@ jobs:
   test: # This code is based on https://github.com/gaogaotiantian/viztracer/blob/master/.github/workflows/python-package.yml
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.11', '3.12']
+        python-version: ['3.9', '3.10', '3.11', '3.13']
         os: [ ubuntu-latest ]
     runs-on: ${{ matrix.os }}
     timeout-minutes: 5

README.md

@@ -84,6 +84,41 @@ jmcomic.download_album(422866, option)
 # 等价写法: option.download_album(422866)
 ```
 
+### 3. 使用命令行
+> 如果只想下载本子，使用命令行会比上述方式更加简单直接
+> 
+> 例如，在windows上，直接按下win+r键，输入jmcomic xxx就可以下载本子。
+
+示例：
+
+下载本子422866的命令
+
+```sh
+jmcomic 422866
+```
+同时下载本子123, 章节456的命令
+```sh
+jmcomic 123 p456
+```
+
+命令行模式也支持自定义option，你可以使用环境变量或者命令行参数：
+
+a. 通过命令行--option参数指定option文件路径
+
+```sh
+jmcomic 123 --option="D:/a.yml"
+```
+
+b. 配置环境变量 `JM_OPTION_PATH` 为option文件路径（推荐）
+
+> 请自行google配置环境变量的方式，或使用powershell命令:  `setx JM_OPTION_PATH "D:/a.yml"` 重启后生效
+
+```sh
+jmcomic 123
+```
+
+
+
 ## 进阶使用
 
 请查阅文档首页→[jmcomic.readthedocs.io](https://jmcomic.readthedocs.io/zh-cn/latest)
@@ -122,10 +157,11 @@ jmcomic.download_album(422866, option)
     - `下载特定后缀图片插件`
     - `发送QQ邮件插件`
     - `自动使用浏览器cookies插件`
-    - `jpg图片合成为一个pdf插件`
     - `导出收藏夹为csv文件插件`
     - `合并所有图片为pdf文件插件`
-    - `合并所有图片为长图插件`
+    - `合并所有图片为长图png插件`
+    - `重复文件检测删除插件`
+    - `网页观看本地章节插件`
 
 ## 使用小说明
 

assets/docs/sources/option_file_syntax.md

@@ -27,14 +27,17 @@ client:
   # APP端不限ip兼容性好，网页端限制ip地区但效率高
   impl: html
 
-  # domain: 域名配置，默认是 []，表示运行时自动获取域名。
-  # 可配置特定域名，如下：
-  # 程序会先用第一个域名，如果第一个域名重试n次失败，则换下一个域名重试，以此类推。
+  # domain: 禁漫域名配置，一般无需配置，jmcomic会根据上面的impl自动设置相应域名
+  # 该配置项需要和上面的impl结合使用，因为禁漫网页端和APP端使用的是不同域名，
+  # 所以配置是一个dict结构，key是impl的值，value是域名列表，表示这个impl走这些域名。
+  # 域名列表的使用顺序是：先用第一个域名，如果第一个域名重试n次失败，则换下一个域名重试，以此类推。
+  # 下面是示例：（注意下面这些域名可能会过时，不一定能用）
   domain:
-    - jm-comic.org
-    - jm-comic2.cc
-    - 18comic.vip
-    - 18comic.org
+    html:
+      - 18comic.vip
+      - 18comic.org
+    api:
+      - www.jmapiproxyxxx.vip
 
   # retry_times: 请求失败重试次数，默认为5
   retry_times: 5
@@ -93,7 +96,14 @@ dir_rule:
   # 写法:
   # 1. 以'Bd'开头，表示根目录
   # 2. 文件夹每增加一层，使用 '_' 或者 '/' 区隔
-  # 3. 用Pxxx或者Ayyy指代文件夹名，意思是 JmPhotoDetail.xxx / JmAlbumDetail的.yyy。xxx和yyy可以写什么需要看源码。
+  # 3. 用Pxxx或者Ayyy指代文件夹名，意思是 JmPhotoDetail.xxx / JmAlbumDetail的.yyy。
+  # xxx和yyy可以写什么需要看源码，或通过下面代码打印出所有可用的值
+  # 
+  # ```python
+  # import jmcomic
+  # properties: dict = jmcomic.JmOption.default().new_jm_client().get_album_detail(本子id).get_properties_dict()
+  # print(properties)
+  # ```
   # 
   # 下面演示如果要使用禁漫网站的默认下载方式，该怎么写:
   # 规则: 根目录 / 本子id / 章节序号 / 图片文件
@@ -102,6 +112,9 @@ dir_rule:
 
   # 默认规则是: 根目录 / 章节标题 / 图片文件
   rule: Bd_Ptitle
+  # jmcomic v2.5.36 以后，支持使用python的f-string的语法组合文件夹名，下为示例
+  # rule: Bd / Aauthor / (JM{Aid}-{Pindex})-{Pname}
+  # {}大括号里的内容同样是写 Axxx 或 Pxxx，其他语法自行参考python f-string的语法
 ```
 
 ## 3. option插件配置项
@@ -194,7 +207,38 @@ plugins:
         # 如果level=[album], filename_rule只能写Axxx
 
         zip_dir: D:/jmcomic/zip/ # 压缩文件存放的文件夹
+
+        suffix: zip #压缩包后缀名，默认值为zip，可以指定为zip或者7z
+
+        # v2.6.0 以后，zip插件也支持dir_rule配置项，可以替代旧版本的zip_dir和filename_rule
+        # 请注意⚠ 使用此配置项会使filename_rule，zip_dir，suffix三个配置项无效，与这三个配置项同时存在时仅会使用dir_rule
+        # 示例如下:
+        # dir_rule: # 新配置项，可取代旧的zip_dir和filename_rule
+        #   base_dir: D:/jmcomic-zip
+        #   rule: 'Bd / {Atitle} / [{Pid}]-{Ptitle}.zip'  # 设置压缩文件夹规则，中间Atitle表示创建一层文件夹，名称是本子标题。[{Pid}]-{Ptitle}.zip 表示压缩文件的命名规则(需显式写出后缀名)
+        # 使用此方法指定压缩包存储路径则无需和level对应
+
         delete_original_file: true # 压缩成功后，删除所有原文件和文件夹
+        
+        # 在v2.6.0及以后版本，zip插件还支持设置密码和加密方式，使用encrypt配置项，该配置是可选的，示例如下：
+        # 1. 给压缩包设置一个指定密码
+        # encrypt:
+        #   password: 123456
+        # 2. 设置随机生成的密码。该密码会在日志中打印出来，并附着到zip的压缩文件注释里
+        # encrypt:
+        #   type: random
+        # 配置密码时，type和password二选一必填
+        
+        # 插件还支持使用7z加密，这种方式会加密压缩包文件头，只有输入了密码才能查看压缩包文件列表，隐私性最好。
+        # 使用encrypt.impl配置项开启7z格式加密，如果不配置，默认仍使用zip格式。
+        # 使用7z格式时记得把压缩包后缀名指定为7z。
+        # 示例如下:
+        # suffix: 7z
+        # encrypt:
+        #   impl: 7z
+        #   type: random # type和password二选一必填，和上面一样
+        # 需要提醒的是，7z没有压缩文件注释，因此如果设置随机密码，密码就只会存在于日志中，请注意及时保存密码。
+         
 
     # 删除重复文件插件
     # 参考 → [https://github.com/hect0x7/JMComic-Crawler-Python/issues/244]
@@ -251,19 +295,4 @@ plugins:
         img_dir: D:/pdf/ # 长图存放文件夹
         filename_rule: Aname # 长图命名规则，同上
 
-    # 请注意⚠
-    # 下方的j2p插件的功能不如img2pdf插件，不建议使用。
-    # 如有图片转pdf的需求，直接使用img2pdf即可，下面的内容请忽略。
-
-    - plugin: j2p # 图片合并插件，可以将下载下来的jpg图片合成为一个pdf插件
-      # 请注意⚠ 该插件的使用前提是，下载下来的图片是jpg图片
-      # 因此，使用该插件前，需要有如下配置:（下载图片格式转为jpg，上文有解释过此配置）
-      # download:
-      #   image:
-      #     suffix: .jpg
-      kwargs:
-        pdf_dir: D:/pdf/ # pdf存放文件夹
-        filename_rule: Pid # pdf命名规则
-        quality: 100 # pdf质量，0 - 100
-  
 ```

assets/docs/sources/tutorial/0_common_usage.md

@@ -63,7 +63,7 @@ def fetch(photo: JmPhotoDetail):
     # 下载单个图片
     client.download_by_image_detail(image, './a.jpg')
     # 如果是已知未混淆的图片，也可以直接使用url来下载
-    random_image_domain = JmModuleConfig.DOMAIN_IMAGE_LIST
+    random_image_domain = JmModuleConfig.DOMAIN_IMAGE_LIST[0]
     client.download_image(f'https://{random_image_domain}/media/albums/416130.jpg', './a.jpg')
 
 
@@ -82,25 +82,38 @@ from jmcomic import *
 # 客户端
 client = JmOption.default().new_jm_client()
 
-# 捕获jmcomic可能出现的异常
+# 捕获获取本子/章节详情时可能出现的异常
 try:
     # 请求本子实体类
     album: JmAlbumDetail = client.get_album_detail('427413')
 except MissingAlbumPhotoException as e:
     print(f'id={e.error_jmid}的本子不存在')
-    
+
 except JsonResolveFailException as e:
     print(f'解析json失败')
     # 响应对象
     resp = e.resp
     print(f'resp.text: {resp.text}, resp.status_code: {resp.status_code}')
-    
+
 except RequestRetryAllFailException as e:
     print(f'请求失败，重试次数耗尽')
-    
+
 except JmcomicException as e:
     # 捕获所有异常，用作兜底
     print(f'jmcomic遇到异常: {e}')
+
+# 多线程下载时，可能出现非当前线程下载失败，抛出异常，
+# 而JmDownloader有对应字段记录了这些线程发生的异常
+# 使用check_exception=True参数可以使downloader主动检查是否存在下载异常
+# 如果有，则当前线程会主动上抛一个PartialDownloadFailedException异常
+# 该参数主要用于主动检查部分下载失败的情况，
+# 因为非当前线程抛出的异常（比如下载章节的线程和下载图片的线程），这些线程如果抛出异常，
+# 当前线程是感知不到的，try-catch下载方法download_album不能捕获到其他线程发生的异常。
+try:
+    album, downloader = download_album(123, check_exception=True)
+except PartialDownloadFailedException as e:
+    downloader: JmDownloader = e.downloader
+    print(f'下载出现部分失败, 下载失败的章节: {downloader.download_failed_photo}, 下载失败的图片: {downloader.download_failed_image}')
 ```
 
 

assets/docs/sources/tutorial/2_command_line.md

@@ -12,14 +12,15 @@ jmcomic 123 456 p333
 ### 2.1. 通过命令行
 使用 --option 参数指定option配置文件路径
 
-```
+```sh
 jmcomic 123 --option="D:/a.yml"
 ```
 
 ### 2.2. 使用环境变量
 配置环境变量 `JM_OPTION_PATH` 为option配置文件路径
 
-```
-set JM_OPTION_PATH="D:/a.yml"
+> 请自行google配置环境变量的方式，或使用powershell命令:  `setx JM_OPTION_PATH "D:/a.yml"` 重启后生效
+
+```sh
 jmcomic 123
 ```

requirements-dev.txt

@@ -5,4 +5,5 @@ Pillow
 psutil
 pycryptodome
 requests
-plugin_jm_server
+plugin_jm_server
+zhconv

setup.py

@@ -43,6 +43,7 @@
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "Operating System :: MacOS",
         "Operating System :: POSIX :: Linux",
         "Operating System :: Microsoft :: Windows",

src/jmcomic/__init__.py

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