禁漫v1.6.7更新 #214
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| # jmcomic 常用类和方法演示 | ||
|
|
||
| ## 下载本子/章节 | ||
|
|
||
| ```python | ||
| from jmcomic import * | ||
|
|
||
| # 下载id为438696的本子 (https://18comic.vip/album/438696) | ||
| download_album(438696) | ||
|
|
||
| # 下载章节 (https://18comic.vip/photo/438696) | ||
| download_photo(438696) | ||
|
|
||
| # 同时下载多个本子 | ||
| download_album([123, 456, 789]) | ||
| ``` | ||
|
|
||
| ## 使用option定制化下载本子 | ||
|
|
||
| 如果你在下载本子时有一些定制化需求， | ||
|
|
||
| 例如指定禁漫域名，使用代理，登录禁漫，图片格式转换等等， | ||
|
|
||
| 那么，你可以试试看jmcomic提供的option机制 | ||
|
|
||
| ```python | ||
| from jmcomic import * | ||
|
|
||
| # 1. 在调用下载api前，通过创建和使用option对象，可以定制化下载行为。 | ||
| # 推荐使用配置文件的方式来创建option对象， | ||
| # 你可以配置很多东西，比如代理、cookies、下载规则等等。 | ||
| # 配置文件的语法参考: https://jmcomic.readthedocs.io/en/latest/option_file_syntax/ | ||
| option = create_option_by_file('op.yml') # 通过配置文件来创建option对象 | ||
|
|
||
| # 2. 调用下载api，把option作为参数传递 | ||
| download_album(123, option) | ||
| # 也可以使用下面这种面向对象的方式，是一样的 | ||
| option.download_album(123) | ||
| ``` | ||
|
|
||
| ## 获取本子/章节/图片的实体类 | ||
|
|
||
| ```python | ||
| from jmcomic import * | ||
|
|
||
| # 客户端 | ||
| client = JmOption.default().new_jm_client() | ||
|
|
||
| # 本子实体类 | ||
| album: JmAlbumDetail = client.get_album_detail('427413') | ||
|
|
||
|
|
||
| def fetch(photo: JmPhotoDetail): | ||
| # 章节实体类 | ||
| photo = client.get_photo_detail(photo.photo_id, False) | ||
|
|
||
| # 图片实体类 | ||
| image: JmImageDetail | ||
| for image in photo: | ||
| print(image.img_url) | ||
|
|
||
|
|
||
| # 多线程发起请求 | ||
| multi_thread_launcher( | ||
| iter_objs=album, | ||
| apply_each_obj_func=fetch | ||
| ) | ||
|
Comment on lines
+63
to
+67
There was a problem hiding this comment. Tip Codebase Verification The search for the Analysis chainThe Scripts ExecutedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Search for the definition of the multi_thread_launcher method
rg "def multi_thread_launcher" || echo "multi_thread_launcher not found"
Length of output: 105 |
||
| ``` | ||
|
Comment on lines
+41
to
+68
There was a problem hiding this comment. Tip Codebase Verification The code examples provided in the documentation for accessing entity classes for albums, photos, and images are accurate and reflect the current API of the library, as confirmed by the presence of Analysis chainThe examples for accessing entity classes for albums, photos, and images are useful for advanced users who need to interact with these entities programmatically. It's important to ensure that the code examples are accurate and up-to-date with the library's current API. Scripts ExecutedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Verify that the entity class examples are accurate and reflect the current API.
echo "Manual verification required: Test the provided examples in a Python environment."
Length of output: 172 Script: #!/bin/bash
# Search for the definitions of classes and methods used in the code example
rg "class JmOption" || echo "JmOption not found"
rg "class JmAlbumDetail" || echo "JmAlbumDetail not found"
rg "class JmPhotoDetail" || echo "JmPhotoDetail not found"
rg "class JmImageDetail" || echo "JmImageDetail not found"
rg "def get_album_detail" || echo "get_album_detail not found"
rg "def get_photo_detail" || echo "get_photo_detail not found"
rg "def multi_thread_launcher" || echo "multi_thread_launcher not found"
Length of output: 1212 |
||
|
|
||
| ## 搜索本子 | ||
|
|
||
| ```python | ||
| from jmcomic import * | ||
|
|
||
| client = JmOption.default().new_jm_client() | ||
|
|
||
| # 分页查询，search_site就是禁漫网页上的【站内搜索】 | ||
| page: JmSearchPage = client.search_site(search_query='+MANA +无修正', page=1) | ||
| # page默认的迭代方式是page.iter_id_title()，每次迭代返回 albun_id, title | ||
| for album_id, title in page: | ||
| print(f'[{album_id}]: {title}') | ||
|
|
||
| # 直接搜索禁漫车号 | ||
| page = client.search_site(search_query='427413') | ||
| album: JmAlbumDetail = page.single_album | ||
| print(album.tags) | ||
| ``` | ||
|
|
||
| ## 搜索并下载本子 | ||
|
|
||
| ```python | ||
| from jmcomic import * | ||
|
|
||
| option = JmOption.default() | ||
| client = option.new_jm_client() | ||
|
|
||
| tag = '無修正' | ||
| # 搜索标签，可以使用search_tag。 | ||
| # 搜索第一页。 | ||
| page: JmSearchPage = client.search_tag(tag, page=1) | ||
|
|
||
| aid_list = [] | ||
|
|
||
| for aid, atitle, tag_list in page.iter_id_title_tag(): # 使用page的iter_id_title_tag迭代器 | ||
| if tag in tag_list: | ||
| print(f'[标签/{tag}] 发现目标: [{aid}]: [{atitle}]') | ||
| aid_list.append(aid) | ||
|
|
||
| download_album(aid_list, option) | ||
| ``` | ||
|
|
||
| ## 分类 / 排行榜 | ||
|
|
||
| 禁漫的分类是一个和搜索有些类似的功能。 | ||
|
|
||
| 搜索是按某一条件进行过滤。 | ||
|
|
||
| 分类没有过滤，就是把某一类别（category）下的本子全都调出来。 | ||
|
|
||
| 禁漫的排行榜就是分类的一种形式 | ||
|
|
||
| 下面演示调用分类api | ||
|
|
||
| ```python | ||
| from jmcomic import * | ||
|
|
||
| # 创建客户端 | ||
| op = JmOption.default() | ||
| cl = op.new_jm_client() | ||
|
|
||
| # 调用分类接口 | ||
| # 根据下面的参数，这个调用的意义就是： | ||
| # 在全部分类下，选择所有时间范围，按观看数排序后，获取第一页的本子 | ||
| page: JmCategoryPage = cl.categories_filter( | ||
| page=1, | ||
| time=JmMagicConstants.TIME_ALL, # 时间选择全部，具体可以写什么请见JmMagicConstants | ||
| category=JmMagicConstants.CATEGORY_ALL, # 分类选择全部，具体可以写什么请见JmMagicConstants | ||
| order_by=JmMagicConstants.ORDER_BY_LATEST, # 按照观看数排序，具体可以写什么请见JmMagicConstants | ||
| ) | ||
|
|
||
| # 月排行，底层实现也是调的categories_filter | ||
| page: JmCategoryPage = cl.month_ranking(1) | ||
| # 周排行 | ||
| page: JmCategoryPage = cl.week_ranking(1) | ||
|
|
||
| # 循环获取分页，使用 cl.categories_filter_gen | ||
| for page in cl.categories_filter_gen(1, # 起始页码 | ||
| # 下面是分类参数 | ||
| JmMagicConstants.TIME_WEEK, | ||
| JmMagicConstants.CATEGORY_ALL, | ||
| JmMagicConstants.ORDER_BY_VIEW, | ||
| ): | ||
| for aid, atitle in page: | ||
| print(aid, atitle) | ||
|
|
||
| ``` | ||
|
|
||
| ## 手动创建Client | ||
|
|
||
| ```python | ||
| # 默认的使用方式是先创建option，option封装了所有配置，然后由option.new_jm_client() 创建客户端client，使用client可以访问禁漫接口 | ||
|
|
||
| # 下面演示直接构造client的方式 | ||
| from jmcomic import * | ||
|
|
||
| """ | ||
| 创建JM客户端 | ||
| :param postman: 负责实现HTTP请求的对象，持有cookies、headers、proxies等信息 | ||
| :param domain_list: 禁漫域名 | ||
| :param retry_times: 重试次数 | ||
| """ | ||
|
|
||
| # 网页端 | ||
| cl = JmHtmlClient( | ||
| postman=JmModuleConfig.new_postman(), | ||
| domain_list=['18comic.vip'], | ||
| retry_times=1 | ||
| ) | ||
|
|
||
| # API端（APP） | ||
| cl = JmApiClient( | ||
| postman=JmModuleConfig.new_postman(), | ||
| domain_list=JmModuleConfig.DOMAIN_API_LIST, | ||
| retry_times=1 | ||
| ) | ||
|
|
||
|
|
||
| ``` | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The updates to the README provide comprehensive information about the project's stability, maintenance mode, and new manga API features. To enhance the visibility of these updates and new features, consider reorganizing the README to highlight them more prominently. This could be achieved through a dedicated section or bullet points at the beginning of the README, making it easier for readers to quickly grasp the latest changes and additions to the project.