jmcomic 2.1.21__py3-none-any.whl → 2.2.0__py3-none-any.whl

jmcomic/__init__.py

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

jmcomic/jm_client_impl.py

@@ -87,7 +87,7 @@ class AbstractJmClient(
 
     # noinspection PyMethodMayBeStatic, PyUnusedLocal
     def before_retry(self, e, kwargs, retry_count, url):
-        jm_debug('req.err', str(e))
+        jm_debug('req.error', str(e))
 
     def enable_cache(self, debug=False):
         def wrap_func_cache(func_name, cache_dict_name):
@@ -235,7 +235,6 @@ class JmHtmlClient(AbstractJmClient):
         resp = self.get(url, **kwargs)
 
         if require_200 is True and resp.status_code != 200:
-            # write_text('./resp.html', resp.text)
             self.check_special_http_code(resp)
             self.raise_request_error(resp)
 
@@ -342,7 +341,6 @@ class JmHtmlClient(AbstractJmClient):
             if content not in html:
                 continue
 
-            write_text('./resp.html', html)
             cls.raise_request_error(
                 resp,
                 f'{reason}'

jmcomic/jm_config.py

@@ -78,6 +78,9 @@ class JmModuleConfig:
     # debug开关标记
     enable_jm_debug = True
 
+    # 插件注册表
+    plugin_registry = {}
+
     @classmethod
     def downloader_class(cls):
         if cls.CLASS_DOWNLOADER is not None:
@@ -256,7 +259,8 @@ class JmModuleConfig:
             },
             'impl': 'html',
             'retry_times': 5
-        }
+        },
+        'plugin': {},
     }
 
     @classmethod
@@ -289,6 +293,10 @@ class JmModuleConfig:
 
         return option_dict
 
+    @classmethod
+    def register_plugin(cls, plugin_class):
+        cls.plugin_registry[plugin_class.plugin_key] = plugin_class
+
 
 jm_debug = JmModuleConfig.jm_debug
 disable_jm_debug = JmModuleConfig.disable_jm_debug

jmcomic/jm_downloader.py

@@ -21,7 +21,9 @@ class DownloadCallback:
                  f'本子获取成功: [{album.id}], '
                  f'作者: [{album.author}], '
                  f'章节数: [{len(album)}], '
+                 f'总页数: [{album.page_count}], '
                  f'标题: [{album.title}], '
+                 f'关键词: [{album.keywords}], '
                  )
 
     def after_album(self, album: JmAlbumDetail):

jmcomic/jm_option.py

@@ -109,6 +109,7 @@ class JmOption:
                  dir_rule: Dict,
                  download: Dict,
                  client: Dict,
+                 plugin: Dict,
                  filepath=None,
                  ):
         # 版本号
@@ -119,9 +120,13 @@ class JmOption:
         self.client = DictModel(client)
         # 下载配置
         self.download = DictModel(download)
+        # 插件配置
+        self.plugin = DictModel(plugin)
         # 其他配置
         self.filepath = filepath
 
+        self.call_all_plugin('after_init')
+
     @property
     def download_cache(self):
         return self.download.cache
@@ -286,3 +291,48 @@ class JmOption:
             else:
                 default_dict[key] = value
         return default_dict
+
+    # 下面的方法提供面向对象的调用风格
+
+    def download_album(self, album_id):
+        from .api import download_album
+        download_album(album_id, self)
+
+    def download_album(self, photo_id):
+        from .api import download_album
+        download_album(photo_id, self)
+
+    # 下面的方法为调用插件提供支持
+    def call_all_plugin(self, key: str):
+        plugin_dict: dict = self.plugin.get(key, {})
+        if plugin_dict is None or len(plugin_dict) == 0:
+            return
+
+        # 保证 jm_plugin.py 被加载
+        from .jm_plugin import JmOptionPlugin
+
+        plugin_registry = JmModuleConfig.plugin_registry
+        for name, kwargs in plugin_dict.items():
+            plugin_class: Optional[Type[JmOptionPlugin]] = plugin_registry.get(name, None)
+
+            if plugin_class is None:
+                raise JmModuleConfig.exception(f'[{key}] 未注册的plugin: {name}')
+
+            self.invoke_plugin(plugin_class, kwargs)
+
+    def invoke_plugin(self, plugin_class, kwargs: dict):
+        # 保证 jm_plugin.py 被加载
+        from .jm_plugin import JmOptionPlugin
+
+        plugin_class: Type[JmOptionPlugin]
+        try:
+            plugin = plugin_class.build(self)
+            plugin.invoke(**kwargs)
+        except JmcomicException as e:
+            msg = str(e)
+            jm_debug('plugin.exception', msg)
+            raise JmModuleConfig.exception(msg)
+        except BaseException as e:
+            msg = str(e)
+            jm_debug('plugin.error', msg)
+            raise e

jmcomic/jm_plugin.py

@@ -0,0 +1,53 @@
+"""
+该文件存放的是option插件类
+"""
+
+from .jm_option import *
+
+
+class JmOptionPlugin:
+    plugin_key: str
+
+    def __init__(self, option: JmOption):
+        self.option = option
+
+    def invoke(self, **kwargs) -> None:
+        """
+        执行插件的功能
+        @param kwargs: 给插件的参数
+        """
+        raise NotImplementedError
+
+    @classmethod
+    def build(cls, option: JmOption) -> 'JmOptionPlugin':
+        """
+        创建插件实例
+        @param option: JmOption对象
+        """
+        return cls(option)
+
+
+"""
+插件功能：登录禁漫，并保存登录后的cookies，让所有client都带上此cookies
+"""
+
+
+class LoginPlugin(JmOptionPlugin):
+    plugin_key = 'login'
+
+    def invoke(self, username, password) -> None:
+        assert isinstance(username, str), '用户名必须是str'
+        assert isinstance(password, str), '密码必须是str'
+
+        client = self.option.new_jm_client()
+        client.login(username, password)
+        cookies = client['cookies']
+
+        postman: dict = self.option.client.postman.src_dict
+        meta_data = postman.get('meta_data', {})
+        meta_data['cookies'] = cookies
+        postman['meta_data'] = meta_data
+        jm_debug('plugin.login', '登录成功')
+
+
+JmModuleConfig.register_plugin(LoginPlugin)

{jmcomic-2.1.21.dist-info → jmcomic-2.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jmcomic
-Version: 2.1.21
+Version: 2.2.0
 Summary: Python API For JMComic (禁漫天堂)
 Home-page: https://github.com/hect0x7/JMComic-Crawler-Python
 Author: hect0x7
@@ -34,7 +34,7 @@ Requires-Dist: Pillow
 
 ## 安装教程
 
-* 通过pip官方源安装（推荐）
+* 通过pip官方源安装（推荐，并且更新也是这个命令）
 
   ```shell
   pip install jmcomic -i https://pypi.org/project --upgrade
@@ -56,10 +56,19 @@ jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载
 # 配置项的作用是告诉程序下载时候的一些选择，
 # 比如，要下载到哪个文件夹，使用怎样的路径组织规则（比如[/作者/本子id/图片] 或者 [/作者/本子名称/图片]）.
 # 如果没有配置，则会使用 JmOption.default()，下载的路径是[当前工作文件夹/本子名称/图片].
-# 如果你想要配置，请参考assets/config/和usgae/下的文档和示例.
+# 如果你想要配置，请参考文件 assets/config/常用配置介绍.yml
 ```
 
-进一步的使用可以参考usage文件夹下的示例代码: `getting_started.py` `usage_simple.py` `usage_feature_filter`
+进阶使用可以参考本repo下usage文件夹内的示例代码文件:
+
+- API上手介绍: `getting_started.py`
+- 使用API实现简单功能: `usage_simple.py`
+- 使用API的Filter过滤功能: `usage_feature_filter.py`
+- 测试你的ip可以访问哪些禁漫域名: `pick_domain.py`
+- 基于GitHub Actions下载本子: `workflow_download.py`
+- 演示jmcomic模块的自定义功能点: `usage_custom.py`
+- 演示jmcomic模块的Plugin插件体系: `usage_plugin.py`
+
 
 ## 项目特点
 
@@ -68,13 +77,14 @@ jmcomic.download_album('422866')  # 传入要下载的album的id，即可下载
 - **可配置性强**
   - 不配置也能使用，十分方便
   - 配置可以从**配置文件**生成，支持多种文件格式，无需写Python代码
-  - 配置点有：`是否使用磁盘缓存` `图片类型转换` `下载路径` `请求元信息（headers,cookies,代理）`等
+  - 配置点有：`是否使用磁盘缓存` `并发下载图片数` `图片类型转换` `下载路径` `请求元信息（headers,cookies,proxies）`等
 - **可扩展性强**
+  - **支持Plugin插件，可以方便地扩展功能，以及使用别人的插件**
   - 支持自定义本子/章节/图片下载前后的回调函数
   - 支持自定义debug日志的开关/格式
-  - 支持自定义Option/Client/实体类
+  - 支持自定义Downloader/Option/Client/实体类
   - ...
-- 支持重试和域名切换机制
+- 支持自动重试和域名切换机制
 - **多线程下载**（可细化到一图一线程，效率极高）
 - 跟进了JM最新的图片分割算法（2023-02-08）
 

jmcomic-2.2.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+jmcomic/__init__.py,sha256=wO2S88eNgkgAQzuspVBF1qmc3mqkdzXnIzhtJfdA8SI,200
+jmcomic/api.py,sha256=s1LTgpKQh5hMnl3Im6qD5nvrnusf6NHawzvJKbZxwCo,1864
+jmcomic/jm_client_impl.py,sha256=YN8tX-Z2hGcZVkV4UOuRN039H71vKyl1lYf6pV3OdQg,14136
+jmcomic/jm_client_interface.py,sha256=5BCWxrWkoRRXOSIZX_m4aMPTXKti4l01T6HhIQ4FmNc,8184
+jmcomic/jm_config.py,sha256=lhVTAjexPfBGgFhievcuE9s4U2EkHYjBtrbMnTutp2E,9863
+jmcomic/jm_downloader.py,sha256=JRdO5BSSC5dqN-O8hCZpkH2yaUjCwNYhbva37X_3nso,6016
+jmcomic/jm_entity.py,sha256=VEw4vCpsmzCJqlOuzLz7O9aeHIuGpwCLX10yzoX4ZIc,12908
+jmcomic/jm_option.py,sha256=zgwNLXAtJUQ9ALsrlh3Cq_kpqjQwhQIHkyRu7NUJCKQ,10408
+jmcomic/jm_plugin.py,sha256=PY7ulWiTnYOGf5vRb6dF-XydfSJEIRX0Xa6LkrEsJkg,1306
+jmcomic/jm_toolkit.py,sha256=QKjzZOx4JX801RtpWKGvCMTTdi-WMU7eGSnFvD7iKME,12035
+jmcomic-2.2.0.dist-info/LICENSE,sha256=kz4coTxZxuGxisK3W00tjK57Zh3RcMGq-EnbXrK7-xA,1064
+jmcomic-2.2.0.dist-info/METADATA,sha256=7ZMJtsk7MpJ-apCI0fJJdEVAcf0F8FZKOBdKVXd5Jpc,4428
+jmcomic-2.2.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+jmcomic-2.2.0.dist-info/top_level.txt,sha256=puvVMFYJqIbd6NOTMEvOyugMTT8woBfSQyxEBan3zY4,8
+jmcomic-2.2.0.dist-info/RECORD,,

jmcomic-2.1.21.dist-info/RECORD

@@ -1,14 +0,0 @@
-jmcomic/__init__.py,sha256=o0Ckfc5P-D1zwvuYrPZi0nLWHw_ZKTBIAKtZZ9VbrgI,176
-jmcomic/api.py,sha256=s1LTgpKQh5hMnl3Im6qD5nvrnusf6NHawzvJKbZxwCo,1864
-jmcomic/jm_client_impl.py,sha256=vT5HOlK-eohgQJmLbdw_yubdcLqnGZjtEMAseVGqQKQ,14229
-jmcomic/jm_client_interface.py,sha256=5BCWxrWkoRRXOSIZX_m4aMPTXKti4l01T6HhIQ4FmNc,8184
-jmcomic/jm_config.py,sha256=eayA_RDqKeWpkf57Da2jXFBK7-hWs3wa-8Zu5VP_Csg,9662
-jmcomic/jm_downloader.py,sha256=NrDp8q7l1-FChAsEUOnWp9Vcx-C3xn5R2Cq6kG4s2nc,5910
-jmcomic/jm_entity.py,sha256=VEw4vCpsmzCJqlOuzLz7O9aeHIuGpwCLX10yzoX4ZIc,12908
-jmcomic/jm_option.py,sha256=sYzNN_-ptfPIJ4YwBU-x4vQZhbcDdQpvj-PASaHYDOw,8729
-jmcomic/jm_toolkit.py,sha256=QKjzZOx4JX801RtpWKGvCMTTdi-WMU7eGSnFvD7iKME,12035
-jmcomic-2.1.21.dist-info/LICENSE,sha256=kz4coTxZxuGxisK3W00tjK57Zh3RcMGq-EnbXrK7-xA,1064
-jmcomic-2.1.21.dist-info/METADATA,sha256=Z_ww6EdjxC7Ietv-lqBxBRK9cK-zopaTQe-zJo8kJTA,3922
-jmcomic-2.1.21.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-jmcomic-2.1.21.dist-info/top_level.txt,sha256=puvVMFYJqIbd6NOTMEvOyugMTT8woBfSQyxEBan3zY4,8
-jmcomic-2.1.21.dist-info/RECORD,,