|
| 1 | +""" |
| 2 | +本文件演示对jmcomic模块进行自定义功能的方式，下面的每个函数都是一个独立的演示单元。 |
| 3 | +本文件不演示【自定义配置】，有关配置的教程文档请见 `` |
| 4 | +""" |
| 5 | +from jmcomic import * |
| 6 | + |
| 7 | +option = JmOption.default() |
| 8 | +client: JmcomicClient = option.build_jm_client() |
| 9 | + |
| 10 | + |
| 11 | +def custom_download_callback(): |
| 12 | + """ |
| 13 | + 该函数演示自定义下载时的回调函数 |
| 14 | + """ |
| 15 | + |
| 16 | + # jmcomic的下载功能由 JmModuleConfig.CLASS_DOWNLOADER 这个类来负责执行 |
| 17 | + # 这个类默认是 JmDownloader，继承了DownloadCallback |
| 18 | + # 你可以写一个自定义类，继承JmDownloader，覆盖属于DownloadCallback的方法，来实现自定义回调 |
| 19 | + class MyDownloader(JmDownloader): |
| 20 | + # 覆盖 album 下载完成后的回调 |
| 21 | + def after_album(self, album: JmAlbumDetail): |
| 22 | + print(f'album下载完毕: {album}') |
| 23 | + pass |
| 24 | + |
| 25 | + # 同样的，最后要让你的自定义类生效 |
| 26 | + JmModuleConfig.CLASS_DOWNLOADER = MyDownloader |
| 27 | + |
| 28 | + |
| 29 | +def custom_option_class(): |
| 30 | + """ |
| 31 | + 该函数演示自定义option |
| 32 | + """ |
| 33 | + |
| 34 | + # jmcomic模块支持自定义Option类， |
| 35 | + # 你可以写一个自己的类，继承JmOption，然后覆盖其中的一些方法。 |
| 36 | + class MyOption(JmOption): |
| 37 | + |
| 38 | + def __init__(self, *args, **kwargs): |
| 39 | + print('MyOption 初始化开始') |
| 40 | + super().__init__(*args, **kwargs) |
| 41 | + |
| 42 | + @classmethod |
| 43 | + def default(cls): |
| 44 | + print('调用了MyOption.default()') |
| 45 | + return super().default() |
| 46 | + |
| 47 | + # 最后，替换默认Option类即可 |
| 48 | + JmModuleConfig.CLASS_OPTION = MyOption |
| 49 | + |
| 50 | + |
| 51 | +def custom_client_class(): |
| 52 | + """ |
| 53 | + 该文件演示自定义client类 |
| 54 | + """ |
| 55 | + |
| 56 | + # 默认情况下，JmOption使用client类是根据配置项 `client.impl` 决定的 |
| 57 | + # JmOption会根据`client.impl`到 JmModuleConfig.CLASS_CLIENT_IMPL 中查找 |
| 58 | + |
| 59 | + # 你可以自定义一个`client.impl`，例如 'my-client'， |
| 60 | + # 或者使用jmcomic内置 'html' 和 'api'， |
| 61 | + # 然后把你的`client.impl`和类一起配置到JmModuleConfig中 |
| 62 | + |
| 63 | + # 1. 自定义Client类 |
| 64 | + class MyClient(JmHtmlClient): |
| 65 | + pass |
| 66 | + |
| 67 | + # 2. 让你的配置类生效 |
| 68 | + JmModuleConfig.CLASS_CLIENT_IMPL['my-client'] = MyClient |
| 69 | + |
| 70 | + # 3. 在配置文件中使用你定义的client.impl，后续使用这个option即可 |
| 71 | + """ |
| 72 | + client: |
| 73 | + impl: 'my-client' |
| 74 | + """ |
| 75 | + |
| 76 | + |
| 77 | +def custom_album_photo_image_detail_class(): |
| 78 | + """ |
| 79 | + 该函数演示替换实体类（本子/章节/图片） |
| 80 | + """ |
| 81 | + |
| 82 | + # 在使用路径规则 DirRule 时，可能会遇到需要自定义实体类属性的情况，例如： |
| 83 | + """ |
| 84 | + dir_rule: |
| 85 | + base_dir: ${workspace} |
| 86 | + rule: Bd_Acustom_Pcustom |
| 87 | + """ |
| 88 | + |
| 89 | + # 上面的Acustom，Pcustom都是自定义字段 |
| 90 | + # 如果你想要使用这种自定义字段，你就需要替换默认的实体类，例如 |
| 91 | + |
| 92 | + # 自定义本子实体类 |
| 93 | + class MyAlbum(JmAlbumDetail): |
| 94 | + # 自定义 custom 属性 |
| 95 | + @property |
| 96 | + def custom(self): |
| 97 | + return f'custom_{self.title}' |
| 98 | + |
| 99 | + # 自定义章节实体类 |
| 100 | + class MyPhoto(JmPhotoDetail): |
| 101 | + # 自定义 custom 属性 |
| 102 | + @property |
| 103 | + def custom(self): |
| 104 | + return f'custom_{self.title}' |
| 105 | + |
| 106 | + # 自定义图片实体类 |
| 107 | + class MyImage(JmImageDetail): |
| 108 | + pass |
| 109 | + |
| 110 | + # 最后，替换默认实体类来让你的自定义类生效 |
| 111 | + JmModuleConfig.CLASS_ALBUM = MyAlbum |
| 112 | + JmModuleConfig.CLASS_PHOTO = MyPhoto |
| 113 | + JmModuleConfig.CLASS_IMAGE = MyImage |
| 114 | + |
| 115 | + |
| 116 | +def custom_jm_debug(): |
| 117 | + """ |
| 118 | + 该函数演示自定义debug |
| 119 | + """ |
| 120 | + |
| 121 | + # jmcomic模块在运行过程中会使用 jm_debug() 这个函数进行打印信息 |
| 122 | + # jm_debug() 这个函数 最后会调用 JmModuleConfig.debug_executor 函数 |
| 123 | + # 你可以写一个自己的函数，替换 JmModuleConfig.debug_executor，实现自定义debug |
| 124 | + |
| 125 | + # 1. 自定义debug函数 |
| 126 | + def my_debug(topic: str, msg: str): |
| 127 | + """ |
| 128 | + 这个debug函数的参数列表必须包含两个参数，topic和msg |
| 129 | + @param topic: debug主题，例如 'album.before', 'req.error', 'plugin.error' |
| 130 | + @param msg: 具体debug的信息 |
| 131 | + """ |
| 132 | + pass |
| 133 | + |
| 134 | + # 2. 让my_debug生效 |
| 135 | + JmModuleConfig.debug_executor = my_debug |
| 136 | + |
| 137 | + |
| 138 | +def custom_exception_raise(): |
| 139 | + """ |
| 140 | + 该函数演示jmcomic的异常机制 |
| 141 | + """ |
| 142 | + |
| 143 | + # jmcomic 代码在运行过程中可能抛出异常，以获取album实体类为例： |
| 144 | + album = client.get_album_detail('999999') |
| 145 | + |
| 146 | + # 上面这行代码用于获取本子id为 999999 的JmAlbumDetail |
| 147 | + # 如果本子不存在，则会抛出异常，异常类默认是 JmcomicException |
| 148 | + |
| 149 | + # 你可以自定义抛出的异常类，做法如下： |
| 150 | + # 1. 自定义异常类 |
| 151 | + class MyExceptionClass(Exception): |
| 152 | + pass |
| 153 | + |
| 154 | + # 2. 替换默认异常类 |
| 155 | + JmModuleConfig.CLASS_EXCEPTION = MyExceptionClass |
| 156 | + |
| 157 | + # 这样一来，抛出的异常类就是 MyExceptionClass |
| 158 | + try: |
| 159 | + album = client.get_album_detail('999999') |
| 160 | + except MyExceptionClass as e: |
| 161 | + print('捕获MyExceptionClass异常') |
| 162 | + pass |
0 commit comments