kmoe-manga-downloader 1.2.4__tar.gz → 1.2.5__tar.gz

kmoe_manga_downloader-1.2.5/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,81 @@
+name: Bug 报告
+description: 提交一个 Bug 帮助我们改进
+labels: ['bug']
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        感谢您提交 Bug！
+        请确保已阅读相关文档，并按照模版提供信息，否则 issue 可能会被关闭。
+
+  - type: input
+    id: app-version
+    attributes:
+      label: 应用版本
+      description: 请提供您使用的应用版本号，可以通过 `kmdr --version` 获取。
+    validations:
+      required: true
+  
+  - type: textarea
+    id: actual-command
+    attributes:
+      label: 实际执行的命令
+      description: 请提供您实际执行的命令。
+      placeholder: kmdr download -l <book_url> -v <volume_selected>
+    validations:
+      required: true
+
+  - type: textarea
+    id: what-expected
+    attributes:
+      label: 预期是什么？
+      description: 您期望发生什么？
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-happened
+    attributes:
+      label: 实际发生了什么？
+      description: 实际发生了什么，可以附带截图等说明问题。
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: 应用输出信息
+      description: 请在此处粘贴任何相关的日志、报错信息或堆栈跟踪。
+      render: shell
+    validations:
+      required: true
+  
+  - type: textarea
+    id: debug-logs
+    attributes:
+      label: 调试输出信息
+      description: |
+        如果问题可以复现，请启用调试模式（添加 `--verbose` 参数）并粘贴调试日志。
+        如 `kmdr --verbose status`。
+      render: shell
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: 其他上下文信息
+      description: |
+        请提供任何其他有助于理解问题的上下文信息，例如操作系统、使用的 shell 等。
+      placeholder: "OS: ..., Shell: ..."
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: 这不是重复的 issue
+      options:
+        - label: 我已经搜索了现有 issue，以确保该错误尚未被报告。
+          required: true

kmoe_manga_downloader-1.2.5/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,55 @@
+name: 功能请求
+description: 建议一个新功能或改进
+labels: ['enhancement']
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        感谢您抽出宝贵时间提出功能请求！
+        请详细描述您的想法，以便我们更好地理解它。
+
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: 您的功能请求是否与某个问题/痛点相关？
+      description: 请详细描述您遇到的问题或痛点。
+      placeholder: "当我...时，我希望能..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution-description
+    attributes:
+      label: 您希望的解决方案是什么？
+      description: |
+        请清晰简洁地描述您希望发生什么。
+        如果是 CLI 相关的，可以提供理想中的命令用法。
+      placeholder: |
+        我希望 `kmdr download` 增加一个 `--format epub` 标志...
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives-considered
+    attributes:
+      label: 您是否考虑过其他替代方案？
+      description: 请描述您可能考虑过的任何替代解决方案或功能，以及为什么提议的方案更好。
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: 额外信息
+      description: 在这里添加任何其他关于功能请求的信息，例如伪代码、流程图、截图或外部链接。
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: 确认
+      options:
+        - label: 我已经搜索了现有 issue，以确保这个功能尚未被提议。
+          required: true

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/.github/workflows/unit-test.yml

@@ -3,6 +3,9 @@ name: Unit Tests
 on:
   push:
     branches: [ main ]
+    paths:
+      - 'src/**'
+      - 'tests/**'
 
 jobs:
   test:

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kmoe-manga-downloader
-Version: 1.2.4
+Version: 1.2.5
 Summary: A CLI-downloader for site @kox.moe.
 Author-email: Chris Zheng <chrisis58@outlook.com>
 License: MIT License

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/src/kmdr/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.2.4'
-__version_tuple__ = version_tuple = (1, 2, 4)
+__version__ = version = '1.2.5'
+__version_tuple__ = version_tuple = (1, 2, 5)
 
-__commit_id__ = commit_id = 'gb584a1f0c'
+__commit_id__ = commit_id = 'gd3b720692'

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/src/kmdr/core/defaults.py

@@ -70,6 +70,7 @@ def argument_parser():
     download_parser.add_argument('-r', '--retry', type=int, help='网络请求失败时的重试次数', required=False)
     download_parser.add_argument('-c', '--callback', type=str, help='每个卷下载完成后执行的回调脚本，例如: `echo {v.name} downloaded!`', required=False)
     download_parser.add_argument('-m', '--method', type=int, help='下载方法，对应网站上的不同下载方式', required=False, choices=[1, 2], default=1)
+    download_parser.add_argument('--vip', action='store_true', help='尝试使用 VIP 链接进行下载（下载速度可能不及 CDN 方式）')
 
     login_parser = subparsers.add_parser('login', help='登录到 Kmoe')
     login_parser.add_argument('-u', '--username', type=str, help='用户名', required=True)

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/src/kmdr/module/downloader/DirectDownloader.py

@@ -11,8 +11,9 @@ from .download_utils import download_file_multipart, readable_safe_filename
     }
 )
 class DirectDownloader(Downloader):
-    def __init__(self, dest='.', callback=None, retry=3, num_workers=8, proxy=None, *args, **kwargs):
+    def __init__(self, dest='.', callback=None, retry=3, num_workers=8, proxy=None, vip=False, *args, **kwargs):
         super().__init__(dest, callback, retry, num_workers, proxy, *args, **kwargs)
+        self._use_vip = vip
 
     async def _download(self, book: BookInfo, volume: VolInfo):
         sub_dir = readable_safe_filename(book.name)
@@ -33,5 +34,5 @@ class DirectDownloader(Downloader):
         return API_ROUTE.DOWNLOAD.format(
             book_id=book.id,
             volume_id=volume.id,
-            is_vip=self._profile.is_vip
+            is_vip=self._profile.is_vip if not self._use_vip else 0
         )

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/src/kmdr/module/downloader/ReferViaDownloader.py

@@ -6,6 +6,7 @@ from async_lru import alru_cache
 from kmdr.core import Downloader, VolInfo, DOWNLOADER, BookInfo
 from kmdr.core.constants import API_ROUTE
 from kmdr.core.error import ResponseError
+from kmdr.core.utils import async_retry
 from kmdr.core.console import debug
 
 from .download_utils import download_file_multipart, readable_safe_filename
@@ -13,9 +14,9 @@ from .download_utils import download_file_multipart, readable_safe_filename
 
 @DOWNLOADER.register(order=10)
 class ReferViaDownloader(Downloader):
-    def __init__(self, dest='.', callback=None, retry=3, num_workers=8, proxy=None, *args, **kwargs):
+    def __init__(self, dest='.', callback=None, retry=3, num_workers=8, proxy=None, vip=False, *args, **kwargs):
         super().__init__(dest, callback, retry, num_workers, proxy, *args, **kwargs)
-
+        self._use_vip = vip
 
     async def _download(self, book: BookInfo, volume: VolInfo):
         sub_dir = readable_safe_filename(book.name)
@@ -36,13 +37,14 @@ class ReferViaDownloader(Downloader):
         )
 
     @alru_cache(maxsize=128)
+    @async_retry()
     async def fetch_download_url(self, book_id: str, volume_id: str) -> str:
 
         async with self._session.get(
             API_ROUTE.GETDOWNURL.format(
                 book_id=book_id,
                 volume_id=volume_id,
-                is_vip=self._profile.is_vip
+                is_vip=self._profile.is_vip if not self._use_vip else 0
             )
         ) as response:
             response.raise_for_status()

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/src/kmdr/module/downloader/download_utils.py

@@ -267,11 +267,16 @@ async def _fetch_content_length(
     """
     if headers is None:
         headers = {}
-    
+
     async with session.head(url, headers=headers, allow_redirects=True) as response:
-        # 注意：这个请求完成后，服务器就会记录这次下载，并消耗对应的流量配额，详细的规则请参考网站说明：
-        #   注 1 : 訂閱連載中的漫畫，有更新時自動推送的卷(冊)，暫不計算在使用額度中，不扣減使用額度。
-        #   注 2 : 對同一卷(冊)書在 12 小時內重複*下載*，不會重複扣減額度。但重復推送是會扣減的。
+        response.raise_for_status()
+        if 'Content-Length' in response.headers:
+            return int(response.headers['Content-Length'])
+
+    async with session.get(url, headers=headers, allow_redirects=True) as response:
+        # 普通下载链接可能不支持 HEAD 请求，尝试使用 GET 请求获取文件大小
+        # see: https://github.com/chrisis58/kmoe-manga-downloader/issues/25
+        debug("HEAD 请求未返回 Content-Length，尝试使用 GET 请求获取文件大小")
         response.raise_for_status()
         if 'Content-Length' not in response.headers:
             raise ResponseError("无法从服务器获取文件大小，请检查网络连接或稍后重试。", status_code=response.status)
@@ -392,19 +397,22 @@ def safe_filename(name: str) -> str:
     """
     return re.sub(r'[\\/:*?"<>|]', '_', name)
 
-async def fetch_url(url: Union[str, Callable[[], str], Callable[[], Awaitable[str]]], retry_times: int = 3) -> str:
-    while retry_times >= 0:
-        try:
-            if callable(url):
-                result = url()
-                if asyncio.iscoroutine(result) or isinstance(result, Awaitable):
-                    return await result
-                return result
-            elif isinstance(url, str):
-                return url
-        except Exception as e:
-            retry_times -= 1
-            if retry_times < 0:
-                raise e
-            await asyncio.sleep(2)
-    raise RuntimeError("Max retries exceeded")
+async def fetch_url(url: Union[str, Callable[[], str], Callable[[], Awaitable[str]]]) -> str:
+    """
+    获取下载链接的包装函数，支持直接传入字符串或异步/同步的 Supplier 函数。
+
+    :note: 不包含重试机制，调用方需自行处理。
+    :param url: 下载链接或其 Supplier
+    :return: 下载链接
+    """
+
+    if callable(url):
+        result = url()
+        if asyncio.iscoroutine(result) or isinstance(result, Awaitable):
+            # 如果 url() 是一个异步函数，等待它
+            return await result
+        # 如果 url() 是一个同步函数，直接返回
+        return result
+    elif isinstance(url, str):
+        # 如果 url 只是个字符串，直接返回
+        return url

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/src/kmdr/module/downloader/misc.py

@@ -55,7 +55,6 @@ class StateManager:
         if not self._part_states:
             return
         
-        debug("当前状态:", self._part_states)
         highest_status = max(self._part_states.values())
         if highest_status != self._current_status:
             self._current_status = highest_status

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/src/kmoe_manga_downloader.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kmoe-manga-downloader
-Version: 1.2.4
+Version: 1.2.5
 Summary: A CLI-downloader for site @kox.moe.
 Author-email: Chris Zheng <chrisis58@outlook.com>
 License: MIT License

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/src/kmoe_manga_downloader.egg-info/SOURCES.txt

@@ -2,6 +2,8 @@
 LICENSE
 README.md
 pyproject.toml
+.github/ISSUE_TEMPLATE/bug_report.yml
+.github/ISSUE_TEMPLATE/feature_request.yml
 .github/workflows/release-package.yml
 .github/workflows/unit-test.yml
 assets/kmdr-demo.gif

{kmoe_manga_downloader-1.2.4 → kmoe_manga_downloader-1.2.5}/tests/test_kmdr_download.py

@@ -129,6 +129,55 @@ class TestKmdrDownload(unittest.TestCase):
             os.path.getsize(os.path.join(dest, book_dir, f)) for f in os.listdir(os.path.join(dest, book_dir)) if os.path.isfile(os.path.join(dest, book_dir, f))
         )
         assert total_size < 1 * 0.6 * 1024 * 1024, "Total size of downloaded files exceeds 0.6 MB"
+    
+    def test_download_single_volume_use_vip(self):
+        dest = f'{BASE_DIR}/{self.test_download_single_volume_use_vip.__name__}'
+
+        kmdr_main(
+            Namespace(
+                command='download',
+                dest=dest,
+                book_url=f'{DEFAULT_BASE_URL}/c/51044.htm',
+                vol_type='extra',
+                volume='all',
+                max_size=0.6,
+                limit=1,
+                retry=3,
+                vip=True
+            )
+        )
+
+        assert len(sub_dir := os.listdir(dest)) == 1, "Expected one subdirectory in the destination"
+        assert os.path.isdir(os.path.join(dest, book_dir := sub_dir[0])), "Expected the subdirectory to be a directory"
+        assert len(os.listdir(os.path.join(dest, book_dir))) == 1, "Expected 1 volume to be downloaded"
+
+        total_size = sum(
+            os.path.getsize(os.path.join(dest, book_dir, f)) for f in os.listdir(os.path.join(dest, book_dir)) if os.path.isfile(os.path.join(dest, book_dir, f))
+        )
+        assert total_size < 1 * 0.6 * 1024 * 1024, "Total size of downloaded files exceeds 0.6 MB"
+
+    def test_download_volume_with_direct_downloader_and_use_vip(self):
+        dest = f'{BASE_DIR}/{self.test_download_volume_with_direct_downloader_and_use_vip.__name__}'
+
+        kmdr_main(
+            Namespace(
+                command='download',
+                dest=dest,
+                book_url=f'{DEFAULT_BASE_URL}/c/51043.htm',
+                vol_type='extra',
+                volume='all',
+                max_size=0.4,
+                method=2, # use direct download method
+                limit=1,
+                retry=3,
+                num_workers=1,
+                vip=True
+            )
+        )
+
+        assert len(sub_dir := os.listdir(dest)) == 1, "Expected one subdirectory in the destination"
+        assert os.path.isdir(os.path.join(dest, book_dir := sub_dir[0])), "Expected the subdirectory to be a directory"
+        assert len(os.listdir(os.path.join(dest, book_dir))) == 1, "Expected 1 volume to be downloaded"
 
     def test_download_multiple_volumes_with_multiple_workers(self):
         dest = f'{BASE_DIR}/{self.test_download_multiple_volumes_with_multiple_workers.__name__}'