v2.2.8: 优化统一禁漫网页端和移动端的搜索返回类，增加移动端的测试，跟进文档 (#132)

Author: hect0x7

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: 跑测试
 
 on:
   schedule:
-    - cron: "0 8 * * *"
+    - cron: "0 0 * * *"
   workflow_dispatch:
   push:
     branches: [ "dev" ]

README.md

@@ -70,10 +70,10 @@ jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载
   - 配置点有：`是否使用磁盘缓存` `并发下载图片数` `图片类型转换` `下载路径` `请求元信息（headers,cookies,proxies）`等
 - **可扩展性强**
   - **支持Plugin插件，可以方便地扩展功能，以及使用别人的插件**
-    - 目前内置支持的插件有：`登录插件` `硬件占用监控插件` `只下载新章插件` `压缩文件插件` 
+    - 目前内置支持的插件有：`登录插件` `硬件占用监控插件` `只下载新章插件` `压缩文件插件`
   - 支持自定义本子/章节/图片下载前后的回调函数
-  - 支持自定义debug日志的开关/格式
-  - 支持自定义Downloader/Option/Client/实体类
+  - 支持自定义debug日志
+  - 支持自定义类：Downloader（负责调度）/Option（负责配置）/Client（负责请求）/实体类 等等
   - ......
 - 支持**自动重试和域名切换**机制
 - **多线程下载**（可细化到一图一线程，效率极高）

requirements-dev.txt

@@ -2,4 +2,5 @@ commonX
 curl_cffi
 PyYAML
 Pillow
-psutil
+psutil
+pycryptodome

src/jmcomic/__init__.py

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

src/jmcomic/jm_client_impl.py

@@ -225,7 +225,7 @@ def search(self,
             album = JmcomicText.analyse_jm_album_html(resp.text)
             return JmSearchPage.wrap_single_album(album)
         else:
-            return JmSearchSupport.analyse_jm_search_html(resp.text)
+            return JmcomicText.analyse_jm_search_html(resp.text)
 
     # -- 帐号管理 --
 
@@ -405,31 +405,8 @@ def search(self,
                main_tag: int,
                order_by: str,
                time: str,
-               ) -> JmApiResp:
-        """
-        model_data: {
-          "search_query": "MANA",
-          "total": "177",
-          "content": [
-            {
-              "id": "441923",
-              "author": "MANA",
-              "description": "",
-              "name": "[MANA] 神里绫华5",
-              "image": "",
-              "category": {
-                "id": "1",
-                "title": "同人"
-              },
-              "category_sub": {
-                "id": "1",
-                "title": "同人"
-              }
-            }
-          ]
-        }
-        """
-        return self.get(
+               ) -> JmSearchPage:
+        resp = self.get(
             self.API_SEARCH,
             params={
                 'search_query': search_query,
@@ -440,6 +417,20 @@ def search(self,
             }
         )
 
+        # 直接搜索禁漫车号，发生重定向的响应数据 resp.model_data
+        # {
+        #   "search_query": "310311",
+        #   "total": 1,
+        #   "redirect_aid": "310311",
+        #   "content": []
+        # }
+        data = resp.model_data
+        if data.get('redirect_aid', None) is not None:
+            aid = data.redirect_aid
+            return JmSearchPage.wrap_single_album(self.get_album_detail(aid))
+
+        return JmcomicSearchTool.parse_api_resp_to_page(data)
+
     def get(self, url, **kwargs) -> JmApiResp:
         # set headers
         headers, key_ts = self.headers_key_ts
@@ -464,17 +455,5 @@ def debug_topic_request(self):
         return 'api'
 
 
-class AsyncSaveImageClient(JmImageClient):
-
-    def __init__(self, workers=None) -> None:
-        from concurrent.futures import ThreadPoolExecutor, Future
-        self.executor = ThreadPoolExecutor(max_workers=workers)
-        self.future_list: List[Future] = []
-
-    def save_image_resp(self, *args, **kwargs):
-        future = self.executor.submit(lambda: super().save_image_resp(*args, **kwargs))
-        self.future_list.append(future)
-
-
 JmModuleConfig.register_client(JmHtmlClient)
 JmModuleConfig.register_client(JmApiClient)

src/jmcomic/jm_client_interface.py

@@ -6,6 +6,7 @@
 
 """
 
+DictModel = AdvancedEasyAccessDict
 
 class JmResp(CommonResp):
 
@@ -19,6 +20,9 @@ def json(self, **kwargs) -> Dict:
     def model(self) -> DictModel:
         return DictModel(self.json())
 
+    def require_success(self):
+        if self.is_not_success:
+            raise JmModuleConfig.exception(self.resp.text)
 
 class JmImageResp(JmResp):
 
@@ -312,7 +316,7 @@ def search_site(self,
                     page: int = 1,
                     order_by: str = ORDER_BY_LATEST,
                     time: str = TIME_ALL,
-                    ) -> JmSearchPage:
+                    ):
         """
         对应禁漫的站内搜索
         """
@@ -323,7 +327,7 @@ def search_work(self,
                     page: int = 1,
                     order_by: str = ORDER_BY_LATEST,
                     time: str = TIME_ALL,
-                    ) -> JmSearchPage:
+                    ):
         """
         搜索album的作品 work
         """
@@ -334,7 +338,7 @@ def search_author(self,
                       page: int = 1,
                       order_by: str = ORDER_BY_LATEST,
                       time: str = TIME_ALL,
-                      ) -> JmSearchPage:
+                      ):
         """
         搜索album的作者 author
         """
@@ -345,7 +349,7 @@ def search_tag(self,
                    page: int = 1,
                    order_by: str = ORDER_BY_LATEST,
                    time: str = TIME_ALL,
-                   ) -> JmSearchPage:
+                   ):
         """
         搜索album的标签 tag
         """
@@ -356,7 +360,7 @@ def search_actor(self,
                      page: int = 1,
                      order_by: str = ORDER_BY_LATEST,
                      time: str = TIME_ALL,
-                     ) -> JmSearchPage:
+                     ):
         """
         搜索album的登场角色 actor
         """

src/jmcomic/jm_entity.py

@@ -5,49 +5,19 @@
 
 class JmBaseEntity:
 
-    @staticmethod
-    def fix_title(title: str, limit=50):
-        """
-        一些过长的标题可能含有 \n，例如album: 360537
-        该方法会把 \n 去除
-        """
-        if len(title) > limit and '\n' in title:
-            title = title.replace('\n', '')
-
-        return title.strip()
-
     def save_to_file(self, filepath):
         from common import PackerUtil
         PackerUtil.pack(self, filepath)
 
 
-class DetailEntity(JmBaseEntity):
-
-    @property
-    def id(self) -> str:
-        raise NotImplementedError
-
-    @property
-    def name(self) -> str:
-        return getattr(self, 'title')
-
-    # help for typing
-    JMPI = Union['JmPhotoDetail', 'JmImageDetail']
-
-    def getindex(self, index: int) -> JMPI:
+class IndexedEntity:
+    def getindex(self, index: int):
         raise NotImplementedError
 
     def __len__(self):
         raise NotImplementedError
 
-    def __iter__(self) -> Generator[JMPI, Any, None]:
-        for index in range(len(self)):
-            yield self.getindex(index)
-
-    def __str__(self):
-        return f'{self.__class__.__name__}({self.id}-{self.name})'
-
-    def __getitem__(self, item) -> Union[JMPI, List[JMPI]]:
+    def __getitem__(self, item) -> Any:
         if isinstance(item, slice):
             start = item.start or 0
             stop = item.stop or len(self)
@@ -60,6 +30,24 @@ def __getitem__(self, item) -> Union[JMPI, List[JMPI]]:
         else:
             raise TypeError(f"Invalid item type for {self.__class__}")
 
+    def __iter__(self):
+        for index in range(len(self)):
+            yield self.getindex(index)
+
+
+class DetailEntity(JmBaseEntity, IndexedEntity):
+
+    @property
+    def id(self) -> str:
+        raise NotImplementedError
+
+    @property
+    def name(self) -> str:
+        return getattr(self, 'title')
+
+    def __str__(self):
+        return f'{self.__class__.__name__}({self.id}-{self.name})'
+
     @classmethod
     def __alias__(cls):
         # "JmAlbumDetail" -> "album" (本子)
@@ -163,7 +151,7 @@ def __init__(self,
                  ):
         self.photo_id: str = photo_id
         self.scramble_id: str = scramble_id
-        self.title: str = self.fix_title(str(title))
+        self.title: str = str(title).strip()
         self.sort: int = int(sort)
         self._keywords: str = keywords
         self._series_id: int = int(series_id)
@@ -290,7 +278,7 @@ def __getitem__(self, item) -> Union[JmImageDetail, List[JmImageDetail]]:
     def __len__(self):
         return len(self.page_arr)
 
-    def __iter__(self) -> Generator[JmImageDetail, Any, None]:
+    def __iter__(self) -> Generator[JmImageDetail, None, None]:
         return super().__iter__()
 
 
@@ -418,39 +406,71 @@ def __getitem__(self, item) -> Union[JmPhotoDetail, List[JmPhotoDetail]]:
     def __len__(self):
         return len(self.episode_list)
 
-    def __iter__(self) -> Generator[JmPhotoDetail, Any, None]:
+    def __iter__(self) -> Generator[JmPhotoDetail, None, None]:
         return super().__iter__()
 
 
-class JmSearchPage(JmBaseEntity):
+class JmSearchPage(JmBaseEntity, IndexedEntity):
+    ContentItem = Tuple[str, Dict[str, Any]]
 
-    def __init__(self, album_info_list: List[Tuple[str, str, StrNone, StrNone, List[str]]]):
-        # (album_id, title, category_none, label_sub_none, tag_list)
-        self.album_info_list = album_info_list
+    def __init__(self, content: List[ContentItem]):
+        # [
+        #   album_id, {title, tag_list, ...}
+        # ]
+        self.content = content
 
-    def __len__(self):
-        return len(self.album_info_list)
+    def iter_id(self) -> Generator[str, None, None]:
+        """
+        返回 album_id 的迭代器
+        """
+        for aid, ainfo in self.content:
+            yield aid
+
+    def iter_id_title(self) -> Generator[Tuple[str, str], None, None]:
+        """
+        返回 album_id, album_title 的迭代器
+        """
+        for aid, ainfo in self.content:
+            yield aid, ainfo['name']
 
-    def __getitem__(self, item) -> Tuple[str, str]:
-        return self.album_info_list[item][0:2]
+    def iter_id_title_tag(self) -> Generator[Tuple[str, str, List[str]], None, None]:
+        """
+        返回 album_id, album_title, album_tag_list 的迭代器
+        """
+        for aid, ainfo in self.content:
+            yield aid, ainfo['name'], ainfo['tag_list']
+
+    # 下面的方法是对单个album的包装
+
+    @property
+    def is_single_album(self):
+        return hasattr(self, 'album')
 
     @property
     def single_album(self) -> JmAlbumDetail:
         return getattr(self, 'album')
 
     @classmethod
     def wrap_single_album(cls, album: JmAlbumDetail) -> 'JmSearchPage':
-        # ('462257', '[無邪気漢化組] [きょくちょ] 楓と鈴 4.5', '短篇', '漢化', [])
-        # (album_id, title, category_none, label_sub_none, tag_list)
-
-        album_info = (
-            album.album_id,
-            album.title,
-            None,
-            None,
-            album.tag_list,
-        )
-        obj = JmSearchPage([album_info])
-
+        obj = JmSearchPage([(
+            album.album_id, {
+                'name': album.title,
+                'tag_list': album.tag_list,
+            }
+        )])
         setattr(obj, 'album', album)
         return obj
+
+    # 下面的方法实现方便的元素访问
+
+    def __len__(self):
+        return len(self.content)
+
+    def __iter__(self):
+        return self.iter_id_title()
+
+    def __getitem__(self, item) -> Union[ContentItem, List[ContentItem]]:
+        return super().__getitem__(item)
+
+    def getindex(self, index: int):
+        return self.content[index]

src/jmcomic/jm_option.py

@@ -130,11 +130,11 @@ def __init__(self,
         # 路径规则配置
         self.dir_rule = DirRule(**dir_rule)
         # 请求配置
-        self.client = DictModel(client)
+        self.client = AdvancedEasyAccessDict(client)
         # 下载配置
-        self.download = DictModel(download)
+        self.download = AdvancedEasyAccessDict(download)
         # 插件配置
-        self.plugin = DictModel(plugin)
+        self.plugin = AdvancedEasyAccessDict(plugin)
         # 其他配置
         self.filepath = filepath