Handle FunctionDef blockstart_tolineno edge cases #2880
Merged
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
The function definition can be quite tricky. Take below example: ``` # Case A def foo(bar: str) -> None: pass # Case B def foo( bar:str ): pass # Case C def foo( bar:str ) -> None: pass # Case D def foo( bar:str ): pass ``` Currently we only handled Case A, B. With this commit we can cover case C, but not Case D.
Pierre-Sassoulas requested changes Nov 7, 2025
Member
Pierre-Sassoulas left a comment
Pierre-Sassoulas left a comment There was a problem hiding this comment.
Thank you for opening a PR, do you mind adding automated test for this, please ?
Codecov Reportβ
All modified and coverable lines are covered by tests. Additional details and impacted files
@@ Coverage Diff @@ ## main #2880 +/- ## ========================================== + Coverage 93.30% 93.31% +0.01% ========================================== Files 92 92 Lines 11194 11196 +2 ========================================== + Hits 10445 10448 +3 + Misses 749 748 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
π New features to boost your workflow:
|
Added 4 test cases to test different argument and return statement lineno, also with or without annotations.
Fix placement of `#@`
Add another test case for FunctionDef's blockstart_tolineno, which without annotations will still work.
Remove comment that is not accurate.
Contributor Author
Sure! I have added some test cases. Sorry for making some amends, should be good now :) |
Pierre-Sassoulas approved these changes Nov 7, 2025
Member
Pierre-Sassoulas left a comment
Pierre-Sassoulas left a comment There was a problem hiding this comment.
LGTM, just waiting for the coverage job to show up :)
Pierre-Sassoulas temporarily deployed to Backport 
GitHub Actions Inactive pylint-backport bot pushed a commit that referenced this pull request Nov 8, 2025
Getting the lineno of the start of the block for function definition(`FunctionDef.blockstart_tolineno`) can be quite tricky. Take below example: ```python # Case A def foo(bar: str) -> None: pass # should returns line=1 # Case B def foo( bar:str): pass # should returns line=2 # Case C def foo( bar:str ) -> None: pass # should returns line=3 # Case D def foo( bar:str ): # should returns line=3 pass ``` Currently we only handled Case A, B. With this commit we can cover case C. But for Case D, we will need a better solution (cherry picked from commit 8fa18c7)
Member
| Great first contribution to astroid ! |
Pierre-Sassoulas pushed a commit that referenced this pull request Nov 8, 2025
β¦dge cases (#2881) Handle FunctionDef blockstart_tolineno edge cases (#2880) Getting the lineno of the start of the block for function definition(`FunctionDef.blockstart_tolineno`) can be quite tricky. Take below example: ```python # Case A def foo(bar: str) -> None: pass # should returns line=1 # Case B def foo( bar:str): pass # should returns line=2 # Case C def foo( bar:str ) -> None: pass # should returns line=3 # Case D def foo( bar:str ): # should returns line=3 pass ``` Currently we only handled Case A, B. With this commit we can cover case C. But for Case D, we will need a better solution (cherry picked from commit 8fa18c7) Co-authored-by: Low, Zhi Hao <lowzhao@gmail.com>
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.
Type of Changes
Description
Getting the lineno of the start of the block for function definition(
FunctionDef.blockstart_tolineno) can be quite tricky. Take below example:Currently we only handled Case A, B. With this commit we can cover case C.
But for Case D, we will need a better solution