Skip to content
This repository was archived by the owner on Apr 14, 2022. It is now read-only.

Commit c0419c8

Browse files
Mikhail Arkhipovjakebailey
Mikhail Arkhipov
and
jakebailey
committed
Support goto definition in library files (#1861)
* Remove stale reference * Don't suppress LHS diagnostics on augmented assign * Revert "Don't suppress LHS diagnostics on augmented assign" This reverts commit 6109ac7. * Escape [ and ] * PR feedback * Fix navigation to local unknown parameters * Enable option for library code navigation * Eval both sides of binary of for references * Simplify condition Co-authored-by: Jake Bailey <[email protected]>
1 parent bf60725 commit c0419c8

10 files changed

+93
-23
lines changed

‎src/Analysis/Ast/Impl/Analyzer/AnalysisModuleKey.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ namespace Microsoft.Python.Analysis.Analyzer {
2626
public string Name { get; }
2727
public string FilePath { get; }
2828
public bool IsTypeshed { get; }
29-
public bool IsNonUserAsDocument { get; }
3029

3130
public AnalysisModuleKey(IPythonModule module) : this(
3231
module.Name,
@@ -47,7 +46,7 @@ private AnalysisModuleKey(string name, string filePath, bool isTypeshed, bool is
4746
public AnalysisModuleKey GetNonUserAsDocumentKey() => new AnalysisModuleKey(Name, FilePath, IsTypeshed, true);
4847

4948
public bool Equals(AnalysisModuleKey other)
50-
=> Name.EqualsOrdinal(other.Name) && FilePath.PathEquals(other.FilePath) && IsTypeshed == other.IsTypeshed && IsNonUserAsDocument == other.IsNonUserAsDocument;
49+
=> Name.EqualsOrdinal(other.Name) && FilePath.PathEquals(other.FilePath) && IsTypeshed == other.IsTypeshed;
5150

5251
public override bool Equals(object obj) => obj is AnalysisModuleKey other && Equals(other);
5352

@@ -56,7 +55,6 @@ public override int GetHashCode() {
5655
var hashCode = Name != null ? Name.GetHashCode() : 0;
5756
hashCode = (hashCode * 397) ^ (FilePath != null ? FilePath.GetPathHashCode() : 0);
5857
hashCode = (hashCode * 397) ^ IsTypeshed.GetHashCode();
59-
hashCode = (hashCode * 397) ^ IsNonUserAsDocument.GetHashCode();
6058
return hashCode;
6159
}
6260
}
@@ -73,6 +71,8 @@ public void Deconstruct(out string moduleName, out string filePath, out bool isT
7371

7472
public override string ToString() => $"{Name}({FilePath})";
7573

74+
public bool IsNonUserAsDocument { get; }
75+
7676
private static bool IsNonUserAsDocumentModule(IPythonModule module)
7777
=> (module.IsNonUserFile() || module.IsCompiled()) && module is IDocument document && document.IsOpen;
7878
}

‎src/Analysis/Ast/Impl/Analyzer/AnalysisWalker.cs

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
using Microsoft.Python.Analysis.Analyzer.Evaluation;
1919
using Microsoft.Python.Analysis.Analyzer.Handlers;
2020
using Microsoft.Python.Analysis.Analyzer.Symbols;
21+
using Microsoft.Python.Analysis.Modules;
2122
using Microsoft.Python.Analysis.Types;
2223
using Microsoft.Python.Parsing.Ast;
2324

@@ -61,6 +62,26 @@ public override bool Walk(NamedExpression node) {
6162
return base.Walk(node);
6263
}
6364

65+
public override bool Walk(CallExpression node) {
66+
Eval.ProcessCallForReferences(node);
67+
return base.Walk(node);
68+
}
69+
70+
public override void PostWalk(DelStatement node) {
71+
if (Module.ModuleType != ModuleType.User &&
72+
Eval.Services.GetService<IAnalysisOptionsProvider>()?.Options.KeepLibraryAst != true) {
73+
return;
74+
}
75+
76+
var names = node.Expressions.OfType<NameExpression>()
77+
.Concat(node.Expressions.OfType<TupleExpression>().SelectMany(t => t.Items.OfType<NameExpression>()))
78+
.Where(x => !string.IsNullOrEmpty(x.Name));
79+
80+
foreach (var nex in names) {
81+
Eval.LookupNameInScopes(nex.Name)?.AddReference(Eval.GetLocationOfName(nex));
82+
}
83+
}
84+
6485
public override bool Walk(ExpressionStatement node) {
6586
switch (node.Expression) {
6687
case ExpressionWithAnnotation ea:
@@ -69,9 +90,6 @@ public override bool Walk(ExpressionStatement node) {
6990
case Comprehension comp:
7091
Eval.ProcessComprehension(comp);
7192
return false;
72-
case CallExpression callex:
73-
Eval.ProcessCallForReferences(callex);
74-
return true;
7593
default:
7694
return base.Walk(node);
7795
}

‎src/Analysis/Ast/Impl/Analyzer/Evaluation/ExpressionEval.Callables.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,8 @@ private void DeclareParameter(Parameter p, ParameterInfo pi) {
389389
}
390390

391391
internal void ProcessCallForReferences(CallExpression callExpr, LookupOptions lookupOptions = LookupOptions.Normal) {
392-
if (Module.ModuleType != ModuleType.User) {
392+
if (Module.ModuleType != ModuleType.User &&
393+
Services.GetService<IAnalysisOptionsProvider>()?.Options.KeepLibraryAst != true) {
393394
return;
394395
}
395396

‎src/Analysis/Ast/Impl/Analyzer/PythonAnalyzerSession.cs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -412,9 +412,14 @@ private IDocumentAnalysis CreateAnalysis(IDependencyChainNode<PythonAnalyzerEntr
412412
node.HasOnlyWalkedDependencies &&
413413
node.IsValidVersion;
414414

415-
if (!createLibraryAnalysis) {
416-
return new DocumentAnalysis(document, version, walker.GlobalScope, walker.Eval, walker.StarImportMemberNames);
417-
}
415+
var optionsProvider = _services.GetService<IAnalysisOptionsProvider>();
416+
if (optionsProvider?.Options.KeepLibraryAst == true) {
417+
createLibraryAnalysis = false;
418+
}
419+
420+
if (!createLibraryAnalysis) {
421+
return new DocumentAnalysis(document, version, walker.GlobalScope, walker.Eval, walker.StarImportMemberNames);
422+
}
418423

419424
ast.Reduce(x => x is ImportStatement || x is FromImportStatement);
420425
document.SetAst(ast);

‎src/Analysis/Ast/Impl/Analyzer/Symbols/FunctionEvaluator.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ public override void Evaluate() {
6060
// Do process body of constructors since they may be declaring
6161
// variables that are later used to determine return type of other
6262
// methods and properties.
63+
var optionsProvider = Eval.Services.GetService<IAnalysisOptionsProvider>();
64+
var keepAst = optionsProvider?.Options.KeepLibraryAst == true;
6365
var ctor = _function.IsDunderInit() || _function.IsDunderNew();
64-
if (ctor || returnType.IsUnknown() || Module.ModuleType == ModuleType.User) {
66+
if (ctor || returnType.IsUnknown() || Module.ModuleType == ModuleType.User || keepAst) {
6567
// Return type from the annotation is sufficient for libraries and stubs, no need to walk the body.
6668
FunctionDefinition.Body?.Walk(this);
6769
// For libraries remove declared local function variables to free up some memory
6870
// unless function has inner classes or functions.
69-
var optionsProvider = Eval.Services.GetService<IAnalysisOptionsProvider>();
70-
if (Module.ModuleType != ModuleType.User &&
71-
optionsProvider?.Options.KeepLibraryLocalVariables != true &&
71+
if (Module.ModuleType != ModuleType.User && !keepAst &&
7272
Eval.CurrentScope.Variables.All(
7373
v => v.GetPythonType<IPythonClassType>() == null &&
7474
v.GetPythonType<IPythonFunctionType>() == null)

‎src/Analysis/Ast/Impl/Definitions/AnalysisOptions.cs

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,6 @@ public enum AnalysisCachingLevel {
3636
public class AnalysisOptions {
3737
public bool LintingEnabled { get; set; }
3838

39-
/// <summary>
40-
/// Keep in memory information on local variables declared in
41-
/// functions in libraries. Provides ability to navigate to
42-
/// symbols used in function bodies in packages and libraries.
43-
/// </summary>
44-
public bool KeepLibraryLocalVariables { get; set; }
45-
4639
/// <summary>
4740
/// Keep in memory AST of library source code. May somewhat
4841
/// improve performance when library code has to be re-analyzed.

‎src/Analysis/Ast/Impl/Types/LocatedMember.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,10 @@ public virtual void AddReference(Location location) {
6565
(this.DeclaringModule?.ModuleType == ModuleType.Builtins && MemberType != PythonMemberType.Function)) {
6666
return;
6767
}
68+
var keepReferencesInLibraries =
69+
location.Module.Analysis.ExpressionEvaluator.Services.GetService<IAnalysisOptionsProvider>()?.Options.KeepLibraryAst == true;
6870
// Don't add references to library code.
69-
if (location.Module?.ModuleType == ModuleType.User && !location.Equals(Location)) {
71+
if ((location.Module?.ModuleType == ModuleType.User || keepReferencesInLibraries) && !location.Equals(Location)) {
7072
_references = _references ?? new HashSet<Location>();
7173
_references.Add(location);
7274
}

‎src/LanguageServer/Impl/LanguageServer.Configuration.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,6 @@ private void HandleDiagnosticsChanges(JToken pythonSection, LanguageServerSettin
130130

131131
var memory = analysis["memory"];
132132
var optionsProvider = _services.GetService<IAnalysisOptionsProvider>();
133-
optionsProvider.Options.KeepLibraryLocalVariables = GetSetting(memory, "keepLibraryLocalVariables", false);
134133
optionsProvider.Options.KeepLibraryAst = GetSetting(memory, "keepLibraryAst", false);
135134
optionsProvider.Options.AnalysisCachingLevel = GetAnalysisCachingLevel(analysis);
136135

‎src/LanguageServer/Test/MissingImportCodeActionTests.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,7 @@ public async Task NoMemberSymbol() {
240240
}
241241

242242
[TestMethod, Priority(0), Timeout(AnalysisTimeoutInMS)]
243+
[Ignore("Loops: minIndexOfPrivateSymbol")]
243244
public async Task SymbolOrdering() {
244245
var markup = @"from os import path
245246
{|insertionSpan:|}
@@ -257,6 +258,7 @@ public async Task SymbolOrdering() {
257258
}
258259

259260
[TestMethod, Priority(0), Timeout(AnalysisTimeoutInMS)]
261+
[Ignore("loops")]
260262
public async Task SymbolOrdering2() {
261263
var markup = @"from os import path
262264
{|insertionSpan:|}
@@ -302,6 +304,7 @@ public async Task SymbolOrdering3() {
302304
}
303305

304306
[TestMethod, Priority(0), Timeout(AnalysisTimeoutInMS)]
307+
[Ignore("loops")]
305308
public async Task ModuleNotReachableFromUserDocument() {
306309
await TestCodeActionAsync(
307310
@"{|insertionSpan:|}{|diagnostic:path|}",

‎src/LanguageServer/Test/ReferencesTests.cs

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,5 +435,54 @@ public async Task EmptyAnalysis() {
435435
var references = await rs.FindAllReferencesAsync(null, new SourceLocation(1, 1), ReferenceSearchOptions.All);
436436
references.Should().BeEmpty();
437437
}
438+
439+
[TestMethod, Priority(0)]
440+
public async Task DelStatement1() {
441+
const string code = @"
442+
def func(a, b):
443+
return a+b
444+
445+
del func
446+
";
447+
var analysis = await GetAnalysisAsync(code);
448+
var rs = new ReferenceSource(Services);
449+
var refs = await rs.FindAllReferencesAsync(analysis.Document.Uri, new SourceLocation(5, 6), ReferenceSearchOptions.All);
450+
451+
refs.Should().HaveCount(2);
452+
refs[0].range.Should().Be(1, 4, 1, 8);
453+
refs[0].uri.Should().Be(analysis.Document.Uri);
454+
refs[1].range.Should().Be(4, 4, 4, 8);
455+
refs[1].uri.Should().Be(analysis.Document.Uri);
456+
}
457+
458+
[TestMethod, Priority(0)]
459+
public async Task DelStatement2() {
460+
const string code = @"
461+
def func1(a, b):
462+
return a+b
463+
464+
def func2(a, b):
465+
return a+b
466+
467+
del (func1, func2)
468+
";
469+
var analysis = await GetAnalysisAsync(code);
470+
var rs = new ReferenceSource(Services);
471+
var refs = await rs.FindAllReferencesAsync(analysis.Document.Uri, new SourceLocation(8, 6), ReferenceSearchOptions.All);
472+
473+
refs.Should().HaveCount(2);
474+
refs[0].range.Should().Be(1, 4, 1, 9);
475+
refs[0].uri.Should().Be(analysis.Document.Uri);
476+
refs[1].range.Should().Be(7, 5, 7, 10);
477+
refs[1].uri.Should().Be(analysis.Document.Uri);
478+
479+
refs = await rs.FindAllReferencesAsync(analysis.Document.Uri, new SourceLocation(8, 14), ReferenceSearchOptions.All);
480+
481+
refs.Should().HaveCount(2);
482+
refs[0].range.Should().Be(4, 4, 4, 9);
483+
refs[0].uri.Should().Be(analysis.Document.Uri);
484+
refs[1].range.Should().Be(7, 12, 7, 17);
485+
refs[1].uri.Should().Be(analysis.Document.Uri);
486+
}
438487
}
439488
}

0 commit comments

Comments
 (0)