v2.4.7: 实现收藏本子功能，优化代码和文档

[hect0x7]

Summary by CodeRabbit

• New Features

  • Added a search functionality to the app.

• Documentation

  • Updated descriptions for configuration parameters to enhance clarity.

• Refactor

  • Renamed methods for filtering download objects to do_filter.
  • Modified method names and parameter usage for consistency across classes.

• Style

  • Added styles for the search bar.

• Version Update

  • Updated software version from '2.4.6' to '2.4.7'.

[coderabbitai]

Warning

Rate Limit Exceeded

@hect0x7 has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 9 minutes and 8 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 9d42234 and 4d13845.

Walkthrough

The changes across various files reflect updates to method names, parameter descriptions, and functionality enhancements in a Python codebase. Key updates include renaming methods for filtering objects, refining parameter descriptions in YAML configurations, adding new methods for handling favorites and domain switching, and updating version numbers. Additionally, there are changes to type annotations and docstrings for better clarity and consistency.

Changes

File Path	Change Summary
.github/workflows/... assets/docs/sources/... src/jmcomic/jm_downloader.py src/jmcomic/jm_plugin.py	Updated parameter descriptions in YAML configurations. Renamed filter_iter_objs to do_filter and updated related logic.
src/jmcomic/__init__.py	Updated software version number.
src/jmcomic/jm_client_impl.py src/jmcomic/jm_client_interface.py	Added new methods for favorites and domain handling, and updated existing methods.
src/jmcomic/jm_config.py	Added new keys and attributes for configuration handling.
src/jmcomic/jm_entity.py	Updated type annotations and added docstrings.
src/jmcomic/jm_option.py	Refactored methods to remove and replace parameters.
src/jmcomic/jm_toolkit.py	Added regex pattern and updated method for match handling.
tests/test_jmcomic/...	Modified method calls in test cases.
usage/workflow_download.py	Refactored environment variable handling function.

🐇✨
In the burrow of code, changes abound,
Methods renamed, and new logic found.
A version ticked up, a refactor so neat,
A rabbit hops on, with updates complete. 🎉
🐇✨

---

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.
• 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

[github-actions]

To prevent beginners from mistakenly submitting PRs,
if your PR only modifies the usage/workflow_download.py file,
it will be automatically closed.
If you really want to submit a PR, please reopen it yourself.
Make sure you know what you are doing!

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a7e8ea2 and 2a081f5.

Files selected for processing (13)

• .github/workflows/download_dispatch.yml (1 hunks)
• assets/docs/sources/tutorial/5_filter.md (3 hunks)
• src/jmcomic/init.py (1 hunks)
• src/jmcomic/jm_client_impl.py (22 hunks)
• src/jmcomic/jm_client_interface.py (1 hunks)
• src/jmcomic/jm_config.py (3 hunks)
• src/jmcomic/jm_downloader.py (3 hunks)
• src/jmcomic/jm_entity.py (5 hunks)
• src/jmcomic/jm_option.py (5 hunks)
• src/jmcomic/jm_plugin.py (1 hunks)
• src/jmcomic/jm_toolkit.py (2 hunks)
• tests/test_jmcomic/test_jm_custom.py (3 hunks)
• usage/workflow_download.py (4 hunks)

Files skipped from review due to trivial changes (1)

• src/jmcomic/init.py

Additional comments: 43

.github/workflows/download_dispatch.yml (1)

• 16-32: The updates to the descriptions of CLIENT_IMPL, IMAGE_SUFFIX, and DIR_RULE parameters are clear and provide better understanding for users triggering the workflow. These changes align with the PR objectives to optimize code and documentation.

assets/docs/sources/tutorial/5_filter.md (3)

• 11-11: The parameter name iter_objs should be updated to detail to match the changes described in the summary.

- def do_filter(self, iter_objs: DownloadIterObjs):
+ def do_filter(self, detail: DownloadIterObjs):

• 35-35: The variable iter_objs should be updated to detail to match the parameter name and the logic described in the summary.

- photo: JmPhotoDetail = iter_objs
+ photo: JmPhotoDetail = detail

• 57-57: The variable iter_objs should be updated to detail to match the parameter name and the logic described in the summary.

- return iter_objs
+ return detail

src/jmcomic/jm_client_impl.py (10)

• 1-1: The import of Lock from the threading module is correctly added.

• 27-32: The AbstractJmClient class has been updated with a new __username attribute and a new enable_cache method call in the constructor.

• 64-75: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [58-119]

The request_with_retry method has been updated to support domain switching and retry mechanisms.

• 121-125: The update_request_with_specify_domain method has been added to support updating request parameters when domain switching occurs, but it currently does not contain any implementation.

• 225-251: The JmHtmlClient class now includes the add_favorite_album method for adding albums to favorites.

• 346-351: The login method in JmHtmlClient has been updated to set the username internally.

• 357-362: The favorite_folder method in JmHtmlClient has been updated to require the username parameter if the internal username is not set.

• 397-408: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [382-404]

The get_jm_html method in JmHtmlClient has been updated to support domain-specific headers.

• 765-790: The JmApiClient class now includes the add_favorite_album method for adding albums to favorites and the require_resp_status_ok method for checking the status of the response.

• 922-946: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [885-944]

The FutureClientProxy class has been added, which acts as a proxy for another client and routes unimplemented methods to the internal client.

src/jmcomic/jm_client_interface.py (2)

• 229-239: The summary incorrectly states that the add_favorite_album method is added to the JmImageClient class, while the hunk shows it being added to the JmUserClient class. Please correct the summary to reflect the actual changes.

• 232-239: The addition of the add_favorite_album method aligns with the PR objectives to implement a feature for favoriting manga.

src/jmcomic/jm_config.py (4)

• 260-265: The addition of the 'origin' key to the new_html_headers function aligns with the summary and the PR objectives to optimize code and documentation.

• 297-307: The summary indicates that comments explaining the usage of default configurations were added to the new_postman function, but these comments are not present in the provided code. Please verify if these comments were intended to be included or if the summary is incorrect.

• 303-305: The DEFAULT_CLIENT_CACHE attribute has been added as indicated in the summary. However, the summary suggests that it is used in the DEFAULT_CLIENT_IMPL and DEFAULT_PROXIES assignments within the new_postman function, which is not reflected in the provided code. Please verify if this usage is implemented elsewhere or if the summary is incorrect.

• 359-362: The modification of the client['cache'] assignment in the option_default_dict function to use cls.DEFAULT_CLIENT_CACHE is consistent with the summary and the PR objectives.

src/jmcomic/jm_downloader.py (3)

• 146-147: The comment in the do_filter method suggests using isinstance / detail.is_xxx for type checking, which contradicts the summary stating that is_photo and is_album methods should be used. Please update the comment to reflect the correct usage.

-        :param detail: 可能是本子或者章节，需要自行使用 isinstance / detail.is_xxx 判断
+        :param detail: 可能是本子或者章节，需要使用 detail.is_photo 或 detail.is_album 判断

• 203-215: The new DoNotDownloadImage class is correctly added as a placeholder for testing purposes.

• 115-121: The execute_by_condition method has been correctly updated to use the new do_filter method.

src/jmcomic/jm_entity.py (5)

• 175-182: The type annotation for from_photo in the JmImageDetail class has been updated to Optional[JmPhotoDetail], and the query_params attribute's type annotation has been updated to Optional[str]. These changes align with the summary provided.

• 266-272: In the JmPhotoDetail class, the _tags attribute type has not been changed, but the _author attribute's type has been updated to Optional[str], which is consistent with the summary.

• 278-284: The data_original_domain attribute's type in the JmPhotoDetail class has been updated to Optional[str], and the data_original_0 attribute does not have a type annotation, which is partially consistent with the summary. The summary does not mention the data_original_0 attribute, so it's unclear if a type annotation change was expected here.

• 372-378: The get_data_original_query_params method in the JmPhotoDetail class has been updated to accept an Optional[str] parameter, which aligns with the summary.

• 534-551: Docstrings have been added for the page_count and page_size properties in the ContentList class, as mentioned in the summary.

src/jmcomic/jm_option.py (3)

• 276-284: The changes to the default method to remove parameters and simplify the method are consistent with the PR objectives and the summary provided.

• 385-414: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [363-425]

The modifications to the new_jm_client method, including the replacement of the domain parameter with domain_list and the renaming of decide_domain to decide_domain_list, are in line with the PR objectives and the summary provided.

• 454-459: The error handling for unrecognized client types in the decide_client_domain method is appropriate and ensures that the method does not silently fail, which is good practice for maintainability and error tracing.

src/jmcomic/jm_plugin.py (2)

• 208-214: The method filter_iter_objs has been correctly renamed to do_filter in the FindUpdateDownloader class. This change is consistent with the summary provided and the PR objectives.

• 210-214: Verify that all references to the old method name filter_iter_objs have been updated to do_filter across the codebase.

---

The verification process confirms that the old method name filter_iter_objs is no longer used and the new method name do_filter is correctly implemented in the codebase.

src/jmcomic/jm_toolkit.py (2)

• 59-59: The addition of the new regular expression pattern pattern_ajax_favorite_msg seems correct and matches the PR's objective to implement favoriting manga functionality.

• 311-314: The modification to the require_match method to handle a None value for rindex is a good enhancement for flexibility. Ensure that this change is reflected in the method's documentation and that all existing calls to this method have been reviewed to ensure they are not negatively impacted by this change.

---

The updated require_match method in jm_toolkit.py is used in the same file with specified rindex values, which should not be affected by the new handling of None for rindex. The change appears safe and adds useful functionality.

tests/test_jmcomic/test_jm_custom.py (3)

• 45-49: The test test_extends_api_client is asserting that the DOMAIN_API_LIST is equal to the result of get_domain_list() when called with an empty domain_list and the impl set to MyClient.client_key. This seems to be testing the configuration of the MyClient class and its interaction with the JmModuleConfig.

• 59-63: Similar to the previous comment, the test test_extends_html_client is asserting that the DOMAIN_HTML_LIST is equal to the result of get_domain_list() when called with an empty domain_list and the impl set to MyClient.client_key. This test ensures that the HTML client configuration is working as expected.

• 95-100: The test test_client_empty_domain is asserting that the DOMAIN_API_LIST is equal to the result of get_domain_list() when called with an empty domain_list and the impl set to MyClient.client_key, with a message indicating that this is testing the behavior when no domain is configured. This test seems to be verifying that the default domain list is used when none is provided.

usage/workflow_download.py (5)

• 1-2: The summary states that the import statement for get_env was removed, but the hunk shows that it was not removed, only the function get_env has been refactored to env. The import statement now only includes JmcomicUI.

• 19-29: The refactoring of the get_env function to env is correctly implemented, with additional functionality for trimming characters from the environment variable values.

• 32-38: The replacement of get_env with the new env function is consistently applied in the get_id_set function.

• 85-87: The env function is correctly used in the log_before_raise function to set the jm_download_dir variable.

• 69-82: The env function is correctly used in the cover_option_config function to set configuration options such as dir_rule, impl, and suffix.