v2.5.35: 优化部分下载失败时异常处理

Author: hect0x7

src/jmcomic/api.py

@@ -72,7 +72,7 @@ def download_album(jm_album_id,
         if callback is not None:
             callback(album, dler)
         if check_exception:
-            dler.raise_if_have_exception()
+            dler.raise_if_has_exception()
         return album, dler
 
 

src/jmcomic/jm_client_impl.py

@@ -566,7 +566,7 @@ def check_special_text(cls, resp):
 
             cls.raise_request_error(
                 resp,
-                f'{reason}'
+                f'{reason}({content})'
                 + (f': {url}' if url is not None else '')
             )
 

src/jmcomic/jm_downloader.py

@@ -1,27 +1,27 @@
 from .jm_option import *
 
 
-def catch_exception(field_name):
-    def deco(func):
-        def wrapper(self, *args, **kwargs):
-            try:
-                return func(self, *args, **kwargs)
-            except Exception as e:
-                detail: JmBaseEntity = args[1]
-                getattr(self, field_name).append((detail, e))
-                if detail.is_image():
-                    detail: JmImageDetail
-                    jm_log('image.failed', f'图片下载失败: [{detail.download_url}], 异常: {e}')
+def catch_exception(func):
+    def wrapper(self, *args, **kwargs):
+        self: JmDownloader
+        try:
+            return func(self, *args, **kwargs)
+        except Exception as e:
+            detail: JmBaseEntity = args[0]
+            if detail.is_image():
+                detail: JmImageDetail
+                jm_log('image.failed', f'图片下载失败: [{detail.download_url}], 异常: [{e}]')
+                self.download_failed_image.append((detail, e))
 
-                elif detail.is_photo():
-                    detail: JmPhotoDetail
-                    jm_log('photo.failed', f'章节下载失败: [{detail.id}], 异常: {e}')
+            elif detail.is_photo():
+                detail: JmPhotoDetail
+                jm_log('photo.failed', f'章节下载失败: [{detail.id}], 异常: [{e}]')
+                self.download_failed_photo.append((detail, e))
 
-                raise e
+            raise e
 
-        return wrapper
-
-    return deco
+    wrapper.__name__ = func.__name__
+    return wrapper
 
 
 # noinspection PyMethodMayBeStatic
@@ -73,51 +73,50 @@ class JmDownloader(DownloadCallback):
 
     def __init__(self, option: JmOption) -> None:
         self.option = option
+        self.client = option.build_jm_client()
         # 下载成功的记录dict
         self.download_success_dict: Dict[JmAlbumDetail, Dict[JmPhotoDetail, List[Tuple[str, JmImageDetail]]]] = {}
         # 下载失败的记录list
         self.download_failed_image: List[Tuple[JmImageDetail, BaseException]] = []
         self.download_failed_photo: List[Tuple[JmPhotoDetail, BaseException]] = []
 
     def download_album(self, album_id):
-        client = self.client_for_album(album_id)
-        album = client.get_album_detail(album_id)
-        self.download_by_album_detail(album, client)
+        album = self.client.get_album_detail(album_id)
+        self.download_by_album_detail(album)
         return album
 
-    def download_by_album_detail(self, album: JmAlbumDetail, client: JmcomicClient):
+    def download_by_album_detail(self, album: JmAlbumDetail):
         self.before_album(album)
         if album.skip:
             return
-        self.execute_by_condition(
+        self.execute_on_condition(
             iter_objs=album,
-            apply=lambda photo: self.download_by_photo_detail(photo, client),
+            apply=self.download_by_photo_detail,
             count_batch=self.option.decide_photo_batch_count(album)
         )
         self.after_album(album)
 
     def download_photo(self, photo_id):
-        client = self.client_for_photo(photo_id)
-        photo = client.get_photo_detail(photo_id)
-        self.download_by_photo_detail(photo, client)
+        photo = self.client.get_photo_detail(photo_id)
+        self.download_by_photo_detail(photo)
         return photo
 
-    @catch_exception('download_failed_photo')
-    def download_by_photo_detail(self, photo: JmPhotoDetail, client: JmcomicClient):
-        client.check_photo(photo)
+    @catch_exception
+    def download_by_photo_detail(self, photo: JmPhotoDetail):
+        self.client.check_photo(photo)
 
         self.before_photo(photo)
         if photo.skip:
             return
-        self.execute_by_condition(
+        self.execute_on_condition(
             iter_objs=photo,
-            apply=lambda image: self.download_by_image_detail(image, client),
+            apply=self.download_by_image_detail,
             count_batch=self.option.decide_image_batch_count(photo)
         )
         self.after_photo(photo)
 
-    @catch_exception('download_failed_image')
-    def download_by_image_detail(self, image: JmImageDetail, client: JmcomicClient):
+    @catch_exception
+    def download_by_image_detail(self, image: JmImageDetail):
         img_save_path = self.option.decide_image_filepath(image)
 
         image.save_path = img_save_path
@@ -136,16 +135,15 @@ def download_by_image_detail(self, image: JmImageDetail, client: JmcomicClient):
         if use_cache is True and image.exists:
             return
 
-        client.download_by_image_detail(
+        self.client.download_by_image_detail(
             image,
             img_save_path,
             decode_image=decode_image,
         )
 
         self.after_image(image, img_save_path)
 
-    # noinspection PyMethodMayBeStatic
-    def execute_by_condition(self,
+    def execute_on_condition(self,
                              iter_objs: DetailEntity,
                              apply: Callable,
                              count_batch: int,
@@ -186,20 +184,6 @@ def do_filter(self, detail: DetailEntity):
         """
         return detail
 
-    # noinspection PyUnusedLocal
-    def client_for_album(self, jm_album_id) -> JmcomicClient:
-        """
-        默认情况下，所有的JmDownloader共用一个JmcomicClient
-        """
-        return self.option.build_jm_client()
-
-    # noinspection PyUnusedLocal
-    def client_for_photo(self, jm_photo_id) -> JmcomicClient:
-        """
-        默认情况下，所有的JmDownloader共用一个JmcomicClient
-        """
-        return self.option.build_jm_client()
-
     @property
     def all_success(self) -> bool:
         """
@@ -209,7 +193,7 @@ def all_success(self) -> bool:
 
         注意！如果使用了filter机制，例如通过filter只下载3张图片，那么all_success也会为False
         """
-        if not self.is_empty_download_failed:
+        if not self.has_no_download_failed_exception:
             return False
 
         for album, photo_dict in self.download_success_dict.items():
@@ -223,7 +207,7 @@ def all_success(self) -> bool:
         return True
 
     @property
-    def is_empty_download_failed(self):
+    def has_no_download_failed_exception(self):
         return len(self.download_failed_image) == 0 and len(self.download_failed_photo) == 0
 
     # 下面是回调方法
@@ -283,13 +267,19 @@ def after_image(self, image: JmImageDetail, img_save_path):
             downloader=self,
         )
 
-    def raise_if_have_exception(self):
-        if self.is_empty_download_failed:
+    def raise_if_has_exception(self):
+        if self.has_no_download_failed_exception:
             return
+        msg_ls = ['部分下载失败', '', '']
+
+        if len(self.download_failed_photo) != 0:
+            msg_ls[1] = f'共{len(self.download_failed_photo)}个章节下载失败: {self.download_failed_photo}'
+
+        if len(self.download_failed_image) != 0:
+            msg_ls[2] = f'共{len(self.download_failed_image)}个图片下载失败: {self.download_failed_image}'
+
         ExceptionTool.raises(
-            f'部分下载失败: 有{len(self.download_failed_photo)}个章节下载失败, {len(self.download_failed_image)}个图片下载失败。\n' +
-            f'失败章节IDs: {[photo.id for photo, _ in self.download_failed_photo][:5]}{"..." if len(self.download_failed_photo) > 5 else ""}\n' +
-            f'失败图片URLs: {[image.download_url for image, _ in self.download_failed_image][:5]}{"..." if len(self.download_failed_image) > 5 else ""}',
+            '\n'.join(msg_ls),
             {'downloader': self},
             PartialDownloadFailedException,
         )
@@ -318,7 +308,7 @@ class DoNotDownloadImage(JmDownloader):
     不会下载任何图片的Downloader，用作测试
     """
 
-    def download_by_image_detail(self, image: JmImageDetail, client: JmcomicClient):
+    def download_by_image_detail(self, image: JmImageDetail):
         # ensure make dir
         self.option.decide_image_filepath(image)
 
@@ -332,12 +322,13 @@ class JustDownloadSpecificCountImage(JmDownloader):
     count_lock = Lock()
     count = 0
 
-    def download_by_image_detail(self, image: JmImageDetail, client: JmcomicClient):
+    @catch_exception
+    def download_by_image_detail(self, image: JmImageDetail):
         # ensure make dir
         self.option.decide_image_filepath(image)
 
         if self.try_countdown():
-            return super().download_by_image_detail(image, client)
+            return super().download_by_image_detail(image)
 
     def try_countdown(self):
         if self.count < 0:

src/jmcomic/jm_entity.py

@@ -35,6 +35,13 @@ def is_album(cls):
     def is_page(cls):
         return False
 
+    @classmethod
+    def __alias__(cls):
+        # "JmAlbumDetail" -> "album" (本子)
+        # "JmPhotoDetail" -> "photo" (章节)
+        cls_name = cls.__name__
+        return cls_name[cls_name.index("m") + 1: cls_name.rfind("Detail")].lower()
+
 
 class IndexedEntity:
     def getindex(self, index: int):
@@ -125,17 +132,9 @@ def idoname(self):
         return f'[{self.id}] {self.oname}'
 
     def __str__(self):
-        return f'{self.__class__.__name__}' \
-               '{' \
-               f'{self.id}: {self.title}' \
-               '}'
+        return f'''{self.__class__.__name__}({self.__alias__()}-{self.id}: "{self.title}")'''
 
-    @classmethod
-    def __alias__(cls):
-        # "JmAlbumDetail" -> "album" (本子)
-        # "JmPhotoDetail" -> "photo" (章节)
-        cls_name = cls.__name__
-        return cls_name[cls_name.index("m") + 1: cls_name.rfind("Detail")].lower()
+    __repr__ = __str__
 
     @classmethod
     def get_dirname(cls, detail: 'DetailEntity', ref: str) -> str:
@@ -258,6 +257,11 @@ def tag(self) -> str:
     def is_image(cls):
         return True
 
+    def __str__(self):
+        return f'''{self.__class__.__name__}({self.__alias__()}-[{self.download_url}])'''
+
+    __repr__ = __str__
+
 
 class JmPhotoDetail(DetailEntity, Downloadable):