jmcomic 0.0.2__py3-none-any.whl

jmcomic/__init__.py

@@ -0,0 +1,29 @@
+# 模块依赖关系如下:
+# 被依赖方 <--- 使用方
+# config <--- entity <--- toolkit <--- client <--- option <--- downloader
+
+__version__ = '0.0.2'
+
+from .api import *
+from .jm_plugin import *
+
+# 下面进行注册组件（客户端、插件）
+gb = dict(filter(lambda pair: isinstance(pair[1], type), globals().items()))
+
+
+def register_jmcomic_component(variables: Dict[str, Any], method, valid_interface: type):
+    for v in variables.values():
+        if v != valid_interface and issubclass(v, valid_interface):
+            method(v)
+
+
+# 注册客户端
+register_jmcomic_component(gb,
+                           JmModuleConfig.register_client,
+                           JmcomicClient,
+                           )
+# 注册插件
+register_jmcomic_component(gb,
+                           JmModuleConfig.register_plugin,
+                           JmOptionPlugin,
+                           )

jmcomic/api.py

@@ -0,0 +1,131 @@
+from .jm_downloader import *
+
+__DOWNLOAD_API_RET = Tuple[JmAlbumDetail, JmDownloader]
+
+
+def download_batch(download_api,
+                   jm_id_iter: Union[Iterable, Generator],
+                   option=None,
+                   downloader=None,
+                   ) -> Set[__DOWNLOAD_API_RET]:
+    """
+    批量下载 album / photo
+
+    一个album/photo，对应一个线程，对应一个option
+
+    :param download_api: 下载api
+    :param jm_id_iter: jmid (album_id, photo_id) 的迭代器
+    :param option: 下载选项，所有的jmid共用一个option
+    :param downloader: 下载器类
+    """
+    from common import multi_thread_launcher
+
+    if option is None:
+        option = JmModuleConfig.option_class().default()
+
+    result = set()
+
+    def callback(*ret):
+        result.add(ret)
+
+    multi_thread_launcher(
+        iter_objs=set(
+            JmcomicText.parse_to_jm_id(jmid)
+            for jmid in jm_id_iter
+        ),
+        apply_each_obj_func=lambda aid: download_api(aid,
+                                                     option,
+                                                     downloader,
+                                                     callback=callback,
+                                                     ),
+        wait_finish=True
+    )
+
+    return result
+
+
+def download_album(jm_album_id,
+                   option=None,
+                   downloader=None,
+                   callback=None,
+                   check_exception=True,
+                   ) -> Union[__DOWNLOAD_API_RET, Set[__DOWNLOAD_API_RET]]:
+    """
+    下载一个本子（album），包含其所有的章节（photo）
+
+    当jm_album_id不是str或int时，视为批量下载，相当于调用 download_batch(download_album, jm_album_id, option, downloader)
+
+    :param jm_album_id: 本子的禁漫车号
+    :param option: 下载选项
+    :param downloader: 下载器类
+    :param callback: 返回值回调函数，可以拿到 album 和 downloader
+    :param check_exception: 是否检查异常, 如果为True，会检查downloader是否有下载异常，并上抛PartialDownloadFailedException
+    :return: 对于的本子实体类，下载器（如果是上述的批量情况，返回值为download_batch的返回值）
+    """
+
+    if not isinstance(jm_album_id, (str, int)):
+        return download_batch(download_album, jm_album_id, option, downloader)
+
+    with new_downloader(option, downloader) as dler:
+        album = dler.download_album(jm_album_id)
+
+        if callback is not None:
+            callback(album, dler)
+        if check_exception:
+            dler.raise_if_has_exception()
+        return album, dler
+
+
+def download_photo(jm_photo_id,
+                   option=None,
+                   downloader=None,
+                   callback=None,
+                   check_exception=True,
+                   ):
+    """
+    下载一个章节（photo），参数同 download_album
+    """
+    if not isinstance(jm_photo_id, (str, int)):
+        return download_batch(download_photo, jm_photo_id, option)
+
+    with new_downloader(option, downloader) as dler:
+        photo = dler.download_photo(jm_photo_id)
+
+        if callback is not None:
+            callback(photo, dler)
+        if check_exception:
+            dler.raise_if_has_exception()
+        return photo, dler
+
+
+def new_downloader(option=None, downloader=None) -> JmDownloader:
+    if option is None:
+        option = JmModuleConfig.option_class().default()
+
+    if downloader is None:
+        downloader = JmModuleConfig.downloader_class()
+
+    return downloader(option)
+
+
+def create_option_by_file(filepath):
+    return JmModuleConfig.option_class().from_file(filepath)
+
+
+def create_option_by_env(env_name='JM_OPTION_PATH'):
+    from .cl import get_env
+
+    filepath = get_env(env_name, None)
+    ExceptionTool.require_true(filepath is not None,
+                               f'未配置环境变量: {env_name}，请配置为option的文件路径')
+    return create_option_by_file(filepath)
+
+
+def create_option_by_str(text: str, mode=None):
+    if mode is None:
+        mode = PackerUtil.mode_yml
+    data = PackerUtil.unpack_by_str(text, mode)[0]
+    return JmModuleConfig.option_class().construct(data)
+
+
+create_option = create_option_by_file

jmcomic/cl.py

@@ -0,0 +1,121 @@
+"""
+command-line usage
+
+for example, download album 123 456, photo 333:
+
+$ jmcomic 123 456 p333 --option="D:/option.yml"
+
+
+"""
+import os.path
+from typing import List, Optional
+
+
+def get_env(name, default):
+    import os
+    value = os.getenv(name, None)
+    if value is None or value == '':
+        return default
+
+    return value
+
+
+class JmcomicUI:
+
+    def __init__(self) -> None:
+        self.option_path: Optional[str] = None
+        self.raw_id_list: List[str] = []
+        self.album_id_list: List[str] = []
+        self.photo_id_list: List[str] = []
+
+    def parse_arg(self):
+        import argparse
+        parser = argparse.ArgumentParser(prog='python -m jmcomic', description='JMComic Command Line Downloader')
+        parser.add_argument(
+            'id_list',
+            nargs='*',
+            help='input all album/photo ids that you want to download, separating them by spaces. '
+                 'Need add a "p" prefix to indicate a photo id, such as `123 456 p333`.',
+            default=[],
+        )
+
+        parser.add_argument(
+            '--option',
+            help='path to the option file, you can also specify it by env `JM_OPTION_PATH`',
+            type=str,
+            default=get_env('JM_OPTION_PATH', ''),
+        )
+
+        args = parser.parse_args()
+        option = args.option
+        if len(option) == 0 or option == "''":
+            self.option_path = None
+        else:
+            self.option_path = os.path.abspath(option)
+
+        self.raw_id_list = args.id_list
+        self.parse_raw_id()
+
+    def parse_raw_id(self):
+
+        def parse(text):
+            from .jm_toolkit import JmcomicText
+
+            try:
+                return JmcomicText.parse_to_jm_id(text)
+            except Exception as e:
+                print(e.args[0])
+                exit(1)
+
+        for raw_id in self.raw_id_list:
+            if raw_id.startswith('p'):
+                self.photo_id_list.append(parse(raw_id[1:]))
+            elif raw_id.startswith('a'):
+                self.album_id_list.append(parse(raw_id[1:]))
+            else:
+                self.album_id_list.append(parse(raw_id))
+
+    def main(self):
+        self.parse_arg()
+        from .api import jm_log
+        jm_log('command_line',
+               f'start downloading...\n'
+               f'- using option: [{self.option_path or "default"}]\n'
+               f'to be downloaded: \n'
+               f'- album: {self.album_id_list}\n'
+               f'- photo: {self.photo_id_list}')
+
+        from .api import create_option, JmOption
+        if self.option_path is not None:
+            option = create_option(self.option_path)
+        else:
+            option = JmOption.default()
+
+        self.run(option)
+
+    def run(self, option):
+        from .api import download_album, download_photo
+        from common import MultiTaskLauncher
+
+        if len(self.album_id_list) == 0:
+            download_photo(self.photo_id_list, option)
+        elif len(self.photo_id_list) == 0:
+            download_album(self.album_id_list, option)
+        else:
+            # 同时下载album和photo
+            launcher = MultiTaskLauncher()
+
+            launcher.create_task(
+                target=download_album,
+                args=(self.album_id_list, option)
+            )
+            launcher.create_task(
+                target=download_photo,
+                args=(self.photo_id_list, option)
+            )
+
+            launcher.wait_finish()
+
+
+def main():
+    JmcomicUI().main()