fix: Avoid crash in the presence of decorators. #184
+162
−90
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| from typing import TypeVar, Generic, Callable, Iterator, ParamSpec | ||
|
|
||
| _T_co = TypeVar("_T_co") | ||
| _P = ParamSpec("_P") | ||
|
|
||
| class X(Generic[_T_co]): | ||
| pass | ||
|
|
||
| def decorate(func: Callable[_P, Iterator[_T_co]]) -> Callable[_P, X[_T_co]]: ... | ||
|
|
||
| class Foo: | ||
| @decorate | ||
| def foo(self) -> Iterator[None]: ... | ||
|
|
||
| @decorate | ||
| def noop(): | ||
| yield | ||
|
|
||
| class FooImpl(Foo): | ||
| def foo(self): | ||
| return noop() | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # < definition scip-python python snapshot-util 0.1 mwe/__init__: | ||
|
|
||
| from typing import TypeVar, Generic, Callable, Iterator, ParamSpec | ||
| # ^^^^^^ reference python-stdlib 3.11 typing/__init__: | ||
| # ^^^^^^^ reference python-stdlib 3.11 typing/TypeVar# | ||
| # ^^^^^^^ reference python-stdlib 3.11 typing/Generic. | ||
| # ^^^^^^^^ reference python-stdlib 3.11 typing/Callable. | ||
| # ^^^^^^^^ reference python-stdlib 3.11 typing/Iterator# | ||
| # ^^^^^^^^^ reference python-stdlib 3.11 typing/ParamSpec# | ||
|
|
||
| _T_co = TypeVar("_T_co") | ||
| #^^^^ definition snapshot-util 0.1 mwe/_T_co. | ||
| # ^^^^^^^ reference python-stdlib 3.11 typing/TypeVar# | ||
| _P = ParamSpec("_P") | ||
| #^ definition snapshot-util 0.1 mwe/_P. | ||
| # ^^^^^^^^^ reference python-stdlib 3.11 typing/ParamSpec# | ||
|
|
||
| class X(Generic[_T_co]): | ||
| # ^ definition snapshot-util 0.1 mwe/X# | ||
| # relationship implementation scip-python python python-stdlib 3.11 typing/Generic# | ||
| # ^^^^^^^ reference python-stdlib 3.11 typing/Generic. | ||
| # ^^^^^ reference snapshot-util 0.1 mwe/_T_co. | ||
| pass | ||
|
|
||
| def decorate(func: Callable[_P, Iterator[_T_co]]) -> Callable[_P, X[_T_co]]: ... | ||
| # ^^^^^^^^ definition snapshot-util 0.1 mwe/decorate(). | ||
| # ^^^^ definition snapshot-util 0.1 mwe/decorate().(func) | ||
| # ^^^^^^^^ reference python-stdlib 3.11 typing/Callable. | ||
| # ^^ reference snapshot-util 0.1 mwe/_P. | ||
| # ^^^^^^^^ reference python-stdlib 3.11 typing/Iterator# | ||
| # ^^^^^ reference snapshot-util 0.1 mwe/_T_co. | ||
| # ^^^^^^^^ reference python-stdlib 3.11 typing/Callable. | ||
| # ^^ reference snapshot-util 0.1 mwe/_P. | ||
| # ^ reference snapshot-util 0.1 mwe/X# | ||
| # ^^^^^ reference snapshot-util 0.1 mwe/_T_co. | ||
|
|
||
| class Foo: | ||
| # ^^^ definition snapshot-util 0.1 mwe/Foo# | ||
| @decorate | ||
| # ^^^^^^^^ reference snapshot-util 0.1 mwe/decorate(). | ||
| def foo(self) -> Iterator[None]: ... | ||
| # ^^^ definition snapshot-util 0.1 mwe/Foo#foo(). | ||
| # ^^^^ definition snapshot-util 0.1 mwe/Foo#foo().(self) | ||
| # ^^^^^^^^ reference python-stdlib 3.11 typing/Iterator# | ||
|
|
||
| @decorate | ||
| #^^^^^^^^ reference snapshot-util 0.1 mwe/decorate(). | ||
| def noop(): | ||
| # ^^^^ definition snapshot-util 0.1 mwe/noop(). | ||
| yield | ||
|
|
||
| class FooImpl(Foo): | ||
| # ^^^^^^^ definition snapshot-util 0.1 mwe/FooImpl# | ||
| # relationship implementation scip-python python snapshot-util 0.1 mwe/Foo# | ||
| # ^^^ reference snapshot-util 0.1 mwe/Foo# | ||
| def foo(self): | ||
| # ^^^ definition snapshot-util 0.1 mwe/FooImpl#foo(). | ||
| # relationship implementation scip-python python snapshot-util 0.1 mwe/Foo#foo(). | ||
| # ^^^^ definition snapshot-util 0.1 mwe/FooImpl#foo().(self) | ||
| return noop() | ||
| # ^^^^ reference snapshot-util 0.1 mwe/noop(). |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,8 @@ import { TypeEvaluator } from 'pyright-internal/analyzer/typeEvaluatorTypes'; | |
| import { convertOffsetToPosition } from 'pyright-internal/common/positionUtils'; | ||
| import { TextRange } from 'pyright-internal/common/textRange'; | ||
| import { TextRangeCollection } from 'pyright-internal/common/textRangeCollection'; | ||
| import { printParseNodeType } from 'pyright-internal/analyzer/parseTreeUtils'; | ||
| import { TreeDumper } from 'pyright-internal/commands/dumpFileDebugInfoCommand'; | ||
| import { | ||
| AssignmentNode, | ||
| ClassNode, | ||
|
|
@@ -38,7 +40,7 @@ import { SourceFile } from 'pyright-internal/analyzer/sourceFile'; | |
| import { extractParameterDocumentation } from 'pyright-internal/analyzer/docStringUtils'; | ||
| import { | ||
| Declaration, | ||
| DeclarationType, FunctionDeclaration, | ||
| isAliasDeclaration, | ||
| isIntrinsicDeclaration, | ||
| } from 'pyright-internal/analyzer/declaration'; | ||
|
|
@@ -53,7 +55,7 @@ import { Event } from 'vscode-languageserver'; | |
| import { HoverResults } from 'pyright-internal/languageService/hoverProvider'; | ||
| import { convertDocStringToMarkdown } from 'pyright-internal/analyzer/docStringConversion'; | ||
| import { assert } from 'pyright-internal/common/debug'; | ||
| import { ClassMemberLookupFlags, lookUpClassMember } from 'pyright-internal/analyzer/typeUtils'; | ||
| import { PyrightFileSystem } from "pyright-internal/pyrightFileSystem"; | ||
| import { createFromRealFileSystem } from "pyright-internal/common/realFileSystem"; | ||
| import { normalizePathCase } from "pyright-internal/common/pathUtils"; | ||
|
|
@@ -218,6 +220,8 @@ export class TreeVisitor extends ParseTreeWalker { | |
| const fileInfo = getFileInfo(node); | ||
| this.fileInfo = fileInfo; | ||
|
|
||
| // Pro tip: Use this.debugDumpAST(node, fileInfo) to see AST for debugging | ||
|
|
||
| // Insert definition at the top of the file | ||
| const pythonPackage = this.getPackageInfo(node, fileInfo.moduleName); | ||
| if (pythonPackage) { | ||
|
|
@@ -342,54 +346,26 @@ export class TreeVisitor extends ParseTreeWalker { | |
| let relationshipMap: Map<string, scip.Relationship> = new Map(); | ||
| let classType = enclosingClassType.classType; | ||
|
|
||
| let classMember = lookUpClassMember(classType, node.name.value, ClassMemberLookupFlags.SkipOriginalClass); | ||
| if (!classMember) { | ||
| return undefined; | ||
| } | ||
|
|
||
| const superDecls = classMember.symbol.getDeclarations(); | ||
| for (const superDecl of superDecls) { | ||
| if (superDecl.type !== DeclarationType.Function) { | ||
| continue; | ||
| } | ||
| let symbol = this.getFunctionSymbol(superDecl); | ||
| if (!symbol.isLocal()) { | ||
| relationshipMap.set( | ||
| symbol.value, | ||
| new scip.Relationship({ | ||
| symbol: symbol.value, | ||
| is_implementation: true, | ||
| }) | ||
| ); | ||
| } | ||
|
There was a problem hiding this comment. This |
||
| } | ||
|
|
||
| let relationships = Array.from(relationshipMap.values()); | ||
|
|
@@ -515,7 +491,6 @@ export class TreeVisitor extends ParseTreeWalker { | |
| // (aliased_import and nested_items tests). So do both checks. | ||
| const resolvedPath = path.resolve(importInfo.resolvedPaths[0]) | ||
| assertSometimesNormalized(resolvedPath, 'visitImportAs.resolvedPath') | ||
| return resolvedPath.startsWith(this.cwd) || | ||
| resolvedPath.startsWith( | ||
| normalizePathCase(new PyrightFileSystem(createFromRealFileSystem()), this.cwd)) | ||
|
|
@@ -1320,44 +1295,49 @@ export class TreeVisitor extends ParseTreeWalker { | |
| } | ||
| } | ||
|
|
||
| private getFunctionSymbol(decl: FunctionDeclaration): ScipSymbol { | ||
| const declModuleName = decl.moduleName; | ||
| let pythonPackage = this.guessPackage(declModuleName, decl.path); | ||
| if (!pythonPackage) { | ||
| return ScipSymbol.local(this.counter.next()); | ||
| } | ||
|
|
||
| const enclosingClass = ParseTreeUtils.getEnclosingClass(decl.node); | ||
| if (enclosingClass) { | ||
| const enclosingClassType = this.evaluator.getTypeOfClass(enclosingClass); | ||
| if (enclosingClassType) { | ||
| let classType = enclosingClassType.classType; | ||
| const pythonPackage = this.guessPackage(classType.details.moduleName, classType.details.filePath)!; | ||
| const symbol = Symbols.makeClass(pythonPackage, classType.details.moduleName, classType.details.name); | ||
| return Symbols.makeMethod(symbol, decl.node.name.value); | ||
| } | ||
| return ScipSymbol.local(this.counter.next()); | ||
| } else { | ||
| return Symbols.makeMethod(Symbols.makeModule(pythonPackage, declModuleName), decl.node.name.value); | ||
| } | ||
| } | ||
|
|
||
| // NOTE(tech-debt): typeToSymbol's signature doesn't make sense. It returns the | ||
|
There was a problem hiding this comment. Symbols should be purely based on declarations. For example: https://sourcegraph.sourcegraph.com/github.com/sourcegraph/scip-clang/-/blob/indexer/SymbolFormatter.cc?L707 |
||
| // symbol for a _function_ (not the function's _type_) despite the name being | ||
| // 'typeToSymbol'. More generally, we should have dedicated functions to get | ||
| // the symbol based on the specific declarations, like getFunctionSymbol. | ||
| // There can be a general function which gets the symbol for a variety of kinds | ||
| // of _declarations_, but it must not take a _Type_ as an argument | ||
| // (Python mostly doesn't use structural types, so ~only declarations should | ||
| // have symbols). | ||
|
|
||
| // Take a `Type` from pyright and turn that into an LSIF symbol. | ||
| private typeToSymbol(node: NameNode, declNode: ParseNode, typeObj: Type): ScipSymbol { | ||
| if (Types.isFunction(typeObj)) { | ||
| // TODO: Possibly worth checking for parent declarations. | ||
| // I'm not sure if that will actually work though for types. | ||
| const decl = typeObj.details.declaration; | ||
| if (!decl) { | ||
| // throw 'Unhandled missing declaration for type: function'; | ||
| // console.warn('Missing Function Decl:', node.token.value, typeObj); | ||
| return ScipSymbol.local(this.counter.next()); | ||
| } | ||
| return this.getFunctionSymbol(decl); | ||
| } else if (Types.isClass(typeObj)) { | ||
| const pythonPackage = this.getPackageInfo(node, typeObj.details.moduleName)!; | ||
| return Symbols.makeClass(pythonPackage, typeObj.details.moduleName, node.value); | ||
|
|
@@ -1700,6 +1680,15 @@ export class TreeVisitor extends ParseTreeWalker { | |
| this.rawSetLsifSymbol(node, symbol, symbol.isLocal()); | ||
| return symbol; | ||
| } | ||
|
|
||
| private debugDumpAST(node: ModuleNode, fileInfo: AnalyzerFileInfo): void { | ||
| console.log("\n=== AST DUMP ==="); | ||
| const dumper = new TreeDumper("", fileInfo.lines); | ||
| dumper.walk(node); | ||
| console.log(dumper.output); | ||
| console.log("=== END AST DUMP ===\n"); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| function _formatModuleName(node: ModuleNameNode): string { | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test cases seems a bit large, but I haven't been able to minimize it further.