Skip to content

[API Compatible] Use a more robust signature parsing method for Python API sinking to C++#74700

Merged
SigureMo merged 2 commits into
PaddlePaddle:developfrom
DanielSun11:sig_parse
Aug 19, 2025
Merged

[API Compatible] Use a more robust signature parsing method for Python API sinking to C++#74700
SigureMo merged 2 commits into
PaddlePaddle:developfrom
DanielSun11:sig_parse

Conversation

@DanielSun11
Copy link
Copy Markdown
Contributor

@DanielSun11 DanielSun11 commented Aug 18, 2025 •
edited
Loading

PR Category

Operator Mechanism

PR Types

Improvements

Description

对#74676 的完善。
采用 #74676 (comment) @SigureMo 建议的方法，提升C++下沉方案中解析signature 过程的鲁棒性。

pcard-67164

@DanielSun11 DanielSun11 changed the title Use a more robust signature parsing method for sinking to C [API Compatible ]Use a more robust signature parsing method for Python API sinking to C++ Aug 18, 2025
SigureMo
SigureMo previously approved these changes Aug 18, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@SigureMo SigureMo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTMeow 🐾

@SigureMo SigureMo changed the title [API Compatible ]Use a more robust signature parsing method for Python API sinking to C++ [API Compatible] Use a more robust signature parsing method for Python API sinking to C++ Aug 18, 2025
@paddle-bot
Copy link
Copy Markdown

paddle-bot Bot commented Aug 18, 2025

你的PR提交成功，感谢你对开源项目的贡献!
请关注后续CI自动化测试结果，详情请参考Paddle-CI手册。
Your PR has been submitted. Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

@SigureMo
Copy link
Copy Markdown
Member

SigureMo commented Aug 18, 2025 •
edited
Loading 

**************************************************************
API Difference is: 
- paddle._paddle_docs.add_doc_and_signature (ArgSpec(args=['method', 'docstr', 'signature'], varargs=None, varkw=None, defaults=None, kwonlyargs=[], kwonlydefaults=None, annotations={'return': None, 'method': <class 'str'>, 'docstr': <class 'str'>, 'signature': <class 'str'>}), ('document', '10436ac8f85701d92d9e96d33530a256'))
?                                                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^                                                                                                                 ----                                            ^^^^^^^^^

+ paddle._paddle_docs.add_doc_and_signature (ArgSpec(args=['func_name', 'docstr', 'func_def'], varargs=None, varkw=None, defaults=None, kwonlyargs=[], kwonlydefaults=None, annotations={'return': None, 'func_name': <class 'str'>, 'docstr': <class 'str'>, 'func_def': <class 'str'>}), ('document', '10436ac8f85701d92d9e96d33530a256'))
?                                                           +++++++  ^^^^^^^^^^^^^^^^^^^^^^                                                                                                               +++++++

这个 API 是不是误暴露为公开 API 了，会呈现在官网文档的，这个看起来是内部 API，应该可以从 __all__ 里删掉1

Footnotes

  1. __all__ 里的 API 会作为公开 API 呈现，比如 paddle.a.b.c.__all__ = ["d", "e"] 会将 paddle.a.b.c.d 和 paddle.a.b.c.e 作为公开 API，这是 Paddle 的规范，不是 Python 的规范 ↩

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Aug 18, 2025

Codecov Report

❌ Patch coverage is 93.33333% with 1 line in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (develop@14373b3). Learn more about missing BASE report.

Files with missing lines Patch % Lines
python/paddle/_paddle_docs.py 93.33% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             develop   #74700   +/-   ##
==========================================
  Coverage           ?   93.33%           
==========================================
  Files              ?        1           
  Lines              ?       15           
  Branches           ?        0           
==========================================
  Hits               ?       14           
  Misses             ?        1           
  Partials           ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@SigureMo SigureMo mentioned this pull request Aug 18, 2025
Merged
@SigureMo SigureMo merged commit c363e6a into PaddlePaddle:develop Aug 19, 2025
87 of 91 checks passed
Luckycheng222 pushed a commit to Luckycheng222/Paddle that referenced this pull request Aug 25, 2025
@DanielSun11 @Luckycheng222
[API Compatible] Use a more robust signature parsing method for Pytho…
3aba4a0 
…n API sinking to C++ (PaddlePaddle#74700)
@DanielSun11 DanielSun11 deleted the sig_parse branch September 18, 2025 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SigureMo SigureMo SigureMo approved these changes

Assignees

No one assigned

Labels

skip-ci: static-check

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@DanielSun11 @SigureMo @codecov-commenter