Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Change end line and column for untyped function defs to line of function definition #17006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mschoettle wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Change end line and column for untyped function defs to line of function definition #17006

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5f88e5d
Add test for line and column end for missing function type annotation
mschoettle Mar 9, 2024
c780ac1
Change end of line and column to be same as start of node
mschoettle Mar 9, 2024
707e4aa
Merge branch 'python:master' into untyped-def-end-line
mschoettle May 6, 2024
8b7802c
Add end line and column for the function definition itself
mschoettle May 6, 2024
6dee499
Determine end line and column of function itself
mschoettle May 6, 2024
37ee833
Add more tests
mschoettle May 7, 2024
081c8cb
Add extra test case
mschoettle May 7, 2024
b835494
Cleanup
mschoettle May 8, 2024
5a7c0ec
Add multiline test
mschoettle May 9, 2024
38f311a
Merge branch 'master' into untyped-def-end-line
JelleZijlstra Jun 2, 2024
796d6ee
Merge branch 'master' into untyped-def-end-line
mschoettle Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add multiline test
  • Loading branch information
@mschoettle
mschoettle committed May 9, 2024
commit 5a7c0ec5e9a410642521c646d97746ce857c7fff
17 changes: 17 additions & 0 deletions test-data/unit/check-columns.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,23 @@ def f_untyped(x, foo, *args, **kwargs) -> None:
main:5:1:5:43: error: Function is missing a type annotation for one or more arguments
main:8:1:8:47: error: Function is missing a type annotation for one or more arguments

[case testColumnEndMultiline]
# flags: --disallow-untyped-defs --warn-no-return --show-error-end
def f(
x: int,
y: int,
):
pass

def g(
x: int,
y: int,
) -> int:
x = 1
[out]
main:2:1:4:11: error: Function is missing a return type annotation
Copy link
Copy Markdown
Member

@JelleZijlstra JelleZijlstra May 14, 2024

Choose a reason for hiding this comment

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

It's unfortunate that the closing ): isn't included in the range. I imagine that's hard to fix though.

Copy link
Copy Markdown
Author

@mschoettle mschoettle May 16, 2024

Choose a reason for hiding this comment

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

I agree. I unfortunately don't know how this could be fixed since it is unavailable in the AST.

For reference: I did find ast.get_source_segment. However, it also returns the source code for a function definition node including the body.

Copy link
Copy Markdown
Member

@JelleZijlstra JelleZijlstra Jun 2, 2024

Choose a reason for hiding this comment

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

I understand. I'm still struggling with this case (as well as the one above where if the function has no annotations at all, we emit a one-character range); I'm worried this PR may lead to more confusing output in some cases. However, on balance it's probably fine and we can apply this change, but consider reverting it if there's a lot of negative feedback.

We could also consider looking at the first start position in the body of the function, but then the whitespace between the colon and the first statement would be included in the range.

main:8:1:11:9: error: Missing return statement

[case testColumnNameIsNotDefined]
((x)) # E:3: Name "x" is not defined

Expand Down