hect0x7 / JMComic-Crawler-Python

Python API for JMComic | 提供Python API访问禁漫天堂,同时支持网页端和移动端 | 禁漫天堂GitHub Actions下载器🚀
https://jmcomic.readthedocs.io/zh-cn/latest/option_file_syntax/#
MIT License
791 stars 1.85k forks source link

v2.4.4: 优化GitHub Actions、文档、注释、代码结构 #168

Closed hect0x7 closed 10 months ago

hect0x7 commented 10 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 10 months ago

Walkthrough

The changes across various files reflect a version update and enhancements in a Python codebase, likely for a comic crawler project. Modifications include updates to GitHub Actions workflow, tutorial documentation, client implementation, and response handling. Configuration variables have been renamed for consistency, and new classes and methods have been introduced for better response management. Error handling has been improved, and dependencies have been updated to ensure compatibility.

Changes

File Path Change Summary
.github/workflows/download_dispatch.yml Updated CLIENT_IMPL parameter description and default value.
assets/docs/sources/tutorial/... Added instructions for enabling GitHub Actions; updated URLs.
setup.py Updated commonX package version requirement.
src/jmcomic/__init__.py Updated version number from '2.4.3' to '2.4.4'.
src/jmcomic/jm_client_impl.py Added domain_list and retry_times parameters; updated methods and error handling; introduced get_cookies method.
src/jmcomic/jm_client_interface.py Modified JmResp class; added JmJsonResp and JmAlbumCommentResp classes; updated properties and methods.
src/jmcomic/jm_config.py Renamed global variables; removed system_proxy and get_cookies methods; updated jm_log method.
src/jmcomic/jm_downloader.py Changed formatting of '关键词' output.
src/jmcomic/jm_entity.py Replaced JmModuleConfig.DEFAULT_AUTHOR with JmMagicConstants.DEFAULT_AUTHOR.
src/jmcomic/jm_option.py Renamed configuration variable; modified build_jm_client method; updated decide_domain function parameters.
src/jmcomic/jm_plugin.py Renamed variables and updated method references.
src/jmcomic/jm_toolkit.py Added condition in match_field; updated raises and replace_old_exception_executor methods; clarified comment in decode_resp_data.
tests/test_jmcomic/test_jm_client.py Renamed JmModuleConfig variables.

Poem

In the burrow of code, the rabbit did hop, 🐇
Through the files and the functions nonstop.
With a tweak and a fix, and a rename so slick,
The crawler did update with a click.

Now the actions are set, and the docs are all neat,
With the clients and responses so sweet.
A version bump here, a new feature there,
The rabbit's hard work, truly beyond compare.

So let's celebrate the changes, so deft,
For in the code, no bug is left.
With every commit, the project does thrive,
In the digital warren, where the code comes alive. 🌟


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - If you reply to a *review comment* from CodeRabbit, the bot will automatically respond. - To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment - Note: Review comments are made on code diffs or files, not on the PR overview. - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Note: For conversation with the bot, please use the review comments on code diffs or files. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json`