forked from microsoft/python-language-server
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathModuleFactory.cs
More file actions
240 lines (207 loc) · 10.4 KB
/
ModuleFactory.cs
File metadata and controls
240 lines (207 loc) · 10.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
// Copyright(c) Microsoft Corporation
// All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the License); you may not use
// this file except in compliance with the License. You may obtain a copy of the
// License at http://www.apache.org/licenses/LICENSE-2.0
//
// THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS
// OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
// IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
// MERCHANTABILITY OR NON-INFRINGEMENT.
//
// See the Apache Version 2.0 License for specific language governing
// permissions and limitations under the License.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using Microsoft.Python.Analysis.Caching.Models;
using Microsoft.Python.Analysis.Modules;
using Microsoft.Python.Analysis.Specializations.Typing;
using Microsoft.Python.Analysis.Specializations.Typing.Types;
using Microsoft.Python.Analysis.Types;
using Microsoft.Python.Analysis.Utilities;
using Microsoft.Python.Analysis.Values;
using Microsoft.Python.Core;
namespace Microsoft.Python.Analysis.Caching {
/// <summary>
/// Constructs module from its persistent model.
/// </summary>
internal sealed class ModuleFactory {
/// <summary>For use in tests so missing members will assert.</summary>
internal static bool EnableMissingMemberAssertions { get; set; }
// TODO: better resolve circular references.
private readonly ReentrancyGuard<string> _moduleReentrancy = new ReentrancyGuard<string>();
private readonly ModuleModel _model;
private readonly IGlobalScope _gs;
public IPythonModule Module { get; }
public Location DefaultLocation { get; }
public ModuleFactory(ModuleModel model, IPythonModule module, IGlobalScope gs) {
_model = model;
_gs = gs;
Module = module;
DefaultLocation = new Location(Module);
}
public IPythonType ConstructType(string qualifiedName)
=> ConstructMember(qualifiedName)?.GetPythonType();
public IMember ConstructMember(string qualifiedName) {
// Determine module name, member chain and if this is an instance.
if (!TypeNames.DeconstructQualifiedName(qualifiedName, out var parts)) {
return null;
}
// See if member is a module first.
var module = GetModule(parts);
if (module == null) {
return null;
}
var member = parts.ModuleName == Module.Name
? GetMemberFromThisModule(parts.MemberNames)
: GetMemberFromModule(module, parts.MemberNames);
if (parts.ObjectType != ObjectType.Instance) {
return member;
}
var t = member.GetPythonType() ?? module.Interpreter.UnknownType;
return new PythonInstance(t);
}
private IMember GetMemberFromThisModule(IReadOnlyList<string> memberNames) {
if (memberNames.Count == 0) {
return null;
}
// Try from cache first
MemberModel currentModel = _model;
IMember m = null;
IPythonType declaringType = null;
foreach (var name in memberNames) {
// Check if name has type arguments such as Union[int, str]
// Note that types can be nested like Union[int, Union[A, B]]
var memberName = name;
var typeArgs = GetTypeArguments(memberName, out var typeName);
if (!string.IsNullOrEmpty(typeName) && typeName != name) {
memberName = typeName;
}
if (memberName == "<lambda>") {
return null;
}
var nextModel = currentModel.GetModel(memberName);
Debug.Assert(nextModel != null, $"Unable to find member {memberName} in module {Module.Name}");
if (nextModel == null) {
return null;
}
m = nextModel.Create(this, declaringType, _gs);
Debug.Assert(m != null);
if (m is IGenericType gt && typeArgs.Count > 0) {
m = gt.CreateSpecificType(new ArgumentSet(typeArgs, null, null));
}
currentModel = nextModel;
declaringType = m as IPythonType;
Debug.Assert(declaringType != null);
if (declaringType == null) {
return null;
}
}
return m;
}
private IMember GetMemberFromModule(IPythonModule module, IReadOnlyList<string> memberNames)
=> memberNames.Count == 0 ? module : GetMember(module, memberNames);
private IPythonModule GetModule(QualifiedNameParts parts) {
if (parts.ModuleName == Module.Name) {
return Module;
}
using (_moduleReentrancy.Push(parts.ModuleName, out var reentered)) {
if (reentered) {
return null;
}
// Here we do not call GetOrLoad since modules references here must
// either be loaded already since they were required to create
// persistent state from analysis. Also, occasionally types come
// from the stub and the main module was never loaded. This, for example,
// happens with io which has member with mmap type coming from mmap
// stub rather than the primary mmap module.
var m = parts.IsStub
? Module.Interpreter.TypeshedResolution.GetImportedModule(parts.ModuleName)
: Module.Interpreter.ModuleResolution.GetImportedModule(parts.ModuleName);
if (m != null) {
return parts.ObjectType == ObjectType.VariableModule ? new PythonVariableModule(m) : m;
}
return null;
}
}
private IMember GetMember(IMember root, IEnumerable<string> memberNames) {
var member = root;
foreach (var n in memberNames) {
var memberName = n;
// Check if name has type arguments such as Union[int, str]
// Note that types can be nested like Union[int, Union[A, B]]
var typeArgs = GetTypeArguments(memberName, out var typeName);
if (!string.IsNullOrEmpty(typeName) && typeName != memberName) {
memberName = typeName;
}
var mc = member as IMemberContainer;
Debug.Assert(mc != null);
if (mc is IBuiltinsPythonModule builtins) {
// Builtins require special handling since there may be 'hidden' names
// like __NoneType__ which need to be mapped to visible types.
member = GetBuiltinMember(builtins, memberName) ?? builtins.Interpreter.UnknownType;
} else {
member = mc?.GetMember(memberName);
// Work around problem that some stubs have incorrectly named tuples.
// For example, in posix.pyi variable for the named tuple is not named as the tuple:
// sched_param = NamedTuple('sched_priority', [('sched_priority', int),])
member = member ?? (mc as PythonModule)?.GlobalScope.Variables
.FirstOrDefault(v => v.Value is ITypingNamedTupleType nt && nt.Name == memberName);
}
if (member == null) {
var containerName = mc is IPythonType t ? t.Name : "<mc>";
Debug.Assert(member != null || EnableMissingMemberAssertions == false, $"Unable to find member {memberName} in {containerName}.");
break;
}
member = typeArgs.Count > 0 && member is IGenericType gt
? gt.CreateSpecificType(new ArgumentSet(typeArgs, null, null))
: member;
}
return member;
}
private IMember GetBuiltinMember(IBuiltinsPythonModule builtins, string memberName) {
if (memberName.StartsWithOrdinal("__")) {
memberName = memberName.Substring(2, memberName.Length - 4);
}
switch (memberName) {
case "NoneType":
return builtins.Interpreter.GetBuiltinType(BuiltinTypeId.NoneType);
case "Unknown":
return builtins.Interpreter.UnknownType;
}
return builtins.GetMember(memberName);
}
private IReadOnlyList<IPythonType> GetTypeArguments(string memberName, out string typeName) {
typeName = null;
// TODO: better handle generics.
// https://github.com/microsoft/python-language-server/issues/1215
// Determine generic type arguments, if any, so we can construct
// complex types from parts, such as Union[typing.Any, a.b.c].
var typeArgs = new List<IPythonType>();
var openBracket = memberName.IndexOf('[');
if (openBracket > 0) {
var closeBracket = memberName.LastIndexOf(']');
if (closeBracket > 0) {
var argumentString = memberName.Substring(openBracket + 1, closeBracket - openBracket - 1);
// Extract type names from argument string. Note that types themselves
// can have arguments: Union[int, Union[int, Union[str, bool]], ...].
var qualifiedNames = TypeNames.GetTypeNames(argumentString, ',');
foreach (var qn in qualifiedNames) {
var t = ConstructType(qn);
if (t == null) {
TypeNames.DeconstructQualifiedName(qn, out var parts);
typeName = string.Join(".", parts.MemberNames);
t = new GenericTypeParameter(typeName, Module, Array.Empty<IPythonType>(), null, null, null, default);
}
typeArgs.Add(t);
}
typeName = memberName.Substring(0, openBracket);
}
}
return typeArgs;
}
}
}