v2.0.0: 一次大版本更新 (#33)

- 重构JmcomicClient，重新设计抽象层次，以及两种实现：HTMl、API，支持请求重试+域名更换的机制；
- 重构JmOption，更加优雅、简单的配置，支持更多文件类型；
- 优化debug机制，等等。

Author: hect0x7

.github/workflows/action_workflow.yml renamed to .github/workflows/download.yml

@@ -35,13 +35,20 @@ jobs:
           pip install commonX -i https://pypi.org/project --upgrade
           pip install -e ./
 
+      - name: 安装依赖项（pull_request）
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          python -m pip install --upgrade pip
+          pip install commonX -i https://pypi.org/project --upgrade
+          pip install -e ./
+
       - name: 运行下载脚本
         env:
           JM_USERNAME: ${{ secrets.JM_USERNAME }}
           JM_PASSWORD: ${{ secrets.JM_PASSWORD }}
         run: |
           cd ./usage/
-          python jmcomic_workflows.py
+          python jmcomic_workflow_download.py
 
       - name: 压缩下载的漫画
         run: |

.github/workflows/action_run_tests.yml renamed to .github/workflows/test.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches: [ "dev", "master" ]
     paths:
+      - '.github/workflows/*.yml' # 工作流定义
+      - 'usage/**/*.py' # 工作流脚本
+      - 'assets/config/*.yml' # option配置文件
       - 'src/**/*.py' # 源码
       - 'tests/**/*.py' # 测试代码
 

assets/config/option.yml

@@ -1,41 +1,24 @@
-!!python/object:jmcomic.jm_option.JmOption
-dir_tree: !!python/object:jmcomic.jm_option.DownloadDirTree
-  Bd: D:/jmcomic/download/
-  flag: Bd_Id_Index_image
+version: '2.0'
+debug: true
 
-disable_jm_module_debug: false
-download_convert_image_suffix: .jpg
-download_image_then_decode: true
-download_multi_thread_photo_batch_count: 10 # 一次多线程批量下载的数量，太多了禁漫服务器可能顶不住
-download_multi_thread_photo_len_limit: 30
-download_use_disk_cache: true
-filepath: null
+dir_rule:
+  base_dir: ${workspace}/download/
+  rule: Bd_Ptitle
 
-client_config:
-  domain: jmcomic1.group
-  # 请求失败时，重试的次数，配个正数就行，不配默认是5
+client:
+  domain: []
+  impl: html
+  postman:
+    meta_data:
+      cookies: null
+      impersonate: chrome110
+    type: cffi
   retry_times: 5
-  postman_type: cffi
-  postman_type_list:
-    - requests
-    - requests_Session
-    - cffi
-    - cffi_Session
-  meta_data:
-    proxies: null
-    allow_redirects: true
-    cookies: null
-    headers:
-      accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9
-      accept-language: zh-CN,zh;q=0.9
-      authority: jmcomic1.group
-      sec-ch-ua: '"Not_A Brand";v="99", "Google Chrome";v="109", "Chromium";v="109"'
-      sec-ch-ua-mobile: ?0
-      sec-ch-ua-platform: '"Windows"'
-      sec-fetch-dest: document
-      sec-fetch-mode: navigate
-      sec-fetch-site: none
-      sec-fetch-user: ?1
-      upgrade-insecure-requests: '1'
-      user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,
-        like Gecko) Chrome/109.0.0.0 Safari/537.36
+
+download:
+  cache: true
+  image:
+    decode: true
+    suffix: .jpg
+  threading:
+    batch_count: 30

assets/config/option_test.yml

@@ -1,27 +1,2 @@
-!!python/object:jmcomic.jm_option.JmOption
-dir_tree: !!python/object:jmcomic.jm_option.DownloadDirTree
-  Bd: $(workspace}/download/
-  flag: Bd_Id_Image
-
-disable_jm_module_debug: false
-download_convert_image_suffix: null
-download_image_then_decode: true
-download_multi_thread_photo_batch_count: 3
-download_multi_thread_photo_len_limit: 5
-download_use_disk_cache: true
-
-
-client_config:
-  # 请求失败时，重试的次数，配个正数就行
-  retry_times: 10
-  domain: null
-  postman_type: cffi
-  postman_type_list:
-    - requests
-    - requests_Session
-    - cffi
-    - cffi_Session
-  meta_data:
-    proxies: null
-    allow_redirects: true
-    cookies: null
+# Github Actions 测试用
+version: '2.0'

assets/config/option_use_proxy.yml

@@ -0,0 +1,7 @@
+# Github Actions 下载脚本配置
+
+version: '2.0'
+
+dir_tree:
+  Bd: /home/runner/work/jmcomic/download/
+  flag: Bd_Aauthor_Atitle_Pindex

assets/config/option_workflow_download.yml

@@ -2,6 +2,6 @@
 # 被依赖方 <--- 使用方
 # config <--- entity <--- toolkit <--- client <--- option
 
-__version__ = '1.9.1'
+__version__ = '2.0.0'
 
 from .api import *

assets/config/workflow_option.yml

@@ -13,38 +13,35 @@ def download_album(jm_album_id, option=None):
         return download_album_batch(jm_album_id, option)
 
     option, jm_client = build_client(option)
-    album_detail: JmAlbumDetail = jm_client.get_album_detail(jm_album_id)
+    album: JmAlbumDetail = jm_client.get_album_detail(jm_album_id)
 
-    jm_debug('download_album',
-             f'获得album_detail成功，准备下载。'
-             f'本子作者是【{album_detail.author}】，一共有{len(album_detail)}集本子')
+    jm_debug('album',
+             f'本子获取成功: [{album.id}], '
+             f'标题: [{album.title}], '
+             f'作者: [{album.author}], '
+             f'章节数: [{len(album)}]')
 
-    def download_photo(index: int,
-                       photo_detail: JmPhotoDetail,
-                       debug_topic='download_album_photo',
+    def download_photo(photo: JmPhotoDetail,
+                       debug_topic='photo',
                        ):
-        jm_client.ensure_photo_can_use(photo_detail)
+        jm_client.ensure_photo_can_use(photo)
 
         jm_debug(debug_topic,
-                 f"下载第[{index + 1}]集: "
-                 f"图片数为[{len(photo_detail)}]，"
-                 f"标题为：({photo_detail.title}) "
-                 f"-- photo {photo_detail.photo_id}")
-
-        download_by_photo_detail(
-            photo_detail,
-            option,
-        )
+                 f'开始下载章节: {photo.id} ({photo.album_id}[{photo.index}/{len(album)}]), '
+                 f'标题: [{photo.title}], '
+                 f'图片数为[{len(photo)}]')
 
-        jm_debug(debug_topic,
-                 f"下载完成：({photo_detail.title}) "
-                 f"-- photo {photo_detail.photo_id}")
+        download_by_photo_detail(photo, option)
+
+        jm_debug(debug_topic, f'章节下载完成: {photo.id} ({photo.album_id}[{photo.index}/{len(album)}])')
 
     thread_pool_executor(
-        iter_objs=enumerate(album_detail),
+        iter_objs=album,
         apply_each_obj_func=download_photo,
     )
 
+    jm_debug('album', f'本子下载完成: [{album.id}]')
+
 
 def download_album_batch(jm_album_id_iter: Union[Iterable, Generator],
                          option=None,
@@ -88,35 +85,34 @@ def download_by_photo_detail(photo_detail: JmPhotoDetail,
     option, jm_client = build_client(option)
 
     # 下载准备
-    use_cache = option.download_use_disk_cache
-    decode_image = option.download_image_then_decode
+    use_cache = option.download_cache
+    decode_image = option.download_image_decode
     jm_client.ensure_photo_can_use(photo_detail)
 
     # 下载每个图片的函数
-    def download_image(index, img_detail, debug_topic='download_images_of_photo'):
+    def download_image(index, image: JmImageDetail, debug_topic='image'):
         img_save_path = option.decide_image_filepath(photo_detail, index)
 
         # 已下载过，缓存命中
         if use_cache is True and file_exists(img_save_path):
-            jm_debug(debug_topic, f'photo-{img_detail.aid}: '
-                                  f'图片{img_detail.filename}已下载过，'
-                                  f'命中磁盘缓存（{img_save_path}）')
+            jm_debug(debug_topic,
+                     f'图片已存在: {image.aid}[{image.filename}] → {img_save_path}')
             return
 
         # 开始下载
         jm_client.download_by_image_detail(
-            img_detail,
+            image,
             img_save_path,
             decode_image=decode_image,
         )
 
-        jm_debug(debug_topic, f'photo-{img_detail.aid}: '
-                              f'图片{img_detail.filename}下载完成：'
-                              f'[{img_detail.img_url}] → [{img_save_path}]')
+        jm_debug(debug_topic,
+                 f'图片下载完成: {image.aid}/{image.filename}, '
+                 f'[{image.img_url}] → [{img_save_path}]')
 
     length = len(photo_detail)
     # 根据图片数，决定下载策略
-    if length <= option.download_multi_thread_photo_len_limit:
+    if length <= option.download_threading_batch_count:
         # 如果图片数小的话，直接使用多线程下载，一张图一个线程。
         multi_thread_launcher(
             iter_objs=enumerate(photo_detail),
@@ -127,7 +123,7 @@ def download_image(index, img_detail, debug_topic='download_images_of_photo'):
         multi_task_launcher_batch(
             iter_objs=enumerate(photo_detail),
             apply_each_obj_func=download_image,
-            batch_size=option.download_multi_thread_photo_batch_count
+            batch_size=option.download_threading_batch_count
         )
 
 
@@ -143,5 +139,5 @@ def build_client(option: Optional[JmOption]) -> Tuple[JmOption, JmcomicClient]:
 
 
 def create_option(filepath: str) -> JmOption:
-    option = JmOption.create_from_file(filepath)
+    option = JmOption.from_file(filepath)
     return option