Add retry support and exception tolerance for url parser #7734
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7734.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
| from sphobjinv.inventory import Inventory as BaseInventory | ||
|
|
||
|
|
||
| class Inventory(BaseInventory): |
There was a problem hiding this comment.
这里新定义的 Inventory 类会遮蔽 sphobjinv.inventory.Inventory 的原始含义，后续读代码/排查问题时容易混淆（尤其在 traceback/类型提示中）。建议把该包装类改成更明确的名字（例如 LoggedInventory/DebugInventory），并在本文件内相应替换调用点；或仅在需要时用局部函数/上下文包装而不是同名类覆盖。
Suggested change
| class Inventory(BaseInventory): | |
| class LoggedInventory(BaseInventory): |
Comment on lines
12
to
15
| def __init__(self, *args, **kwargs) -> None: | ||
| logger.info(f"Creating {self.__class__.__name__}") | ||
| super().__init__(*args, **kwargs) | ||
| logger.info(f"Created {self.__class__.__name__}") |
There was a problem hiding this comment.
在 Inventory.__init__ 里使用 logger.info 打印创建/创建完成会显著增加文档构建或工具运行时的日志噪声（该解析器会在 get_parser 中被多次初始化）。更合适的做法是改用 logger.debug，或用环境变量/命令行开关控制是否输出这类调试日志，避免污染 CI 日志。
zhwesky2010
reviewed
Feb 9, 2026
| @@ -5,7 +5,14 @@ | |||
| from urllib.parse import urljoin | |||
|
|
|||
| from loguru import logger | |||
Collaborator
There was a problem hiding this comment.
这个logger也删了吧，直接print，减少下载量
Add retry mechanism with exponential backoff to the Inventory class constructor to handle transient network failures when loading API documentation inventories. The class now retries up to 3 times with a 1-second delay between attempts, logging warnings for retries and raising a ConnectionError after all attempts fail. Wrap the get_url function in a try-except block to catch and log any exceptions during URL resolution, returning an empty string on error instead of crashing. This improves the robustness of the API documentation tooling against intermittent network issues and unexpected parsing errors.
- Remove loguru dependency from pre-doc-compile.sh installation - Replace loguru logger with Python's standard logging.getLogger in api_url_parser.py and api_utils.py - Update logging calls to use standard Python string formatting syntax - Maintain existing functionality while switching to built-in logging module
LittleHeroZZZX
changed the title
zhwesky2010
approved these changes
Feb 10, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
增强 URL parser 的稳定性