Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork252
Expand file tree
/
Copy pathimportcompletion.py
More file actions
258 lines (230 loc) · 9.54 KB
/
importcompletion.py
File metadata and controls
258 lines (230 loc) · 9.54 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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# The MIT License
#
# Copyright (c) 2009-2011 Andreas Stuehrk
# Copyright (c) 2020-2021 Sebastian Ramacher
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
importfnmatch
importimportlib.machinery
importsys
importwarnings
fromdataclassesimportdataclass
frompathlibimportPath
fromcollections.abcimportGenerator,Sequence,Iterable
from .lineimport (
current_word,
current_import,
current_from_import_from,
current_from_import_import,
)
SUFFIXES=importlib.machinery.all_suffixes()
LOADERS= (
(
importlib.machinery.ExtensionFileLoader,
importlib.machinery.EXTENSION_SUFFIXES,
),
(
importlib.machinery.SourceFileLoader,
importlib.machinery.SOURCE_SUFFIXES,
),
)
@dataclass(frozen=True,slots=True)
class_LoadedInode:
dev:int
inode:int
classModuleGatherer:
def__init__(
self,
paths:Iterable[str|Path]|None=None,
skiplist:Sequence[str]|None=None,
)->None:
"""Initialize module gatherer with all modules in `paths`, which should be a list of
directory names. If `paths` is not given, `sys.path` will be used."""
# Cached list of all known modules
self.modules:set[str]=set()
# Set of (st_dev, st_ino) to compare against so that paths are not repeated
self.paths:set[_LoadedInode]=set()
# Patterns to skip
self.skiplist:Sequence[str]= (
skiplistifskiplistisnotNoneelsetuple()
)
self.fully_loaded=False
ifpathsisNone:
self.modules.update(sys.builtin_module_names)
paths=sys.path
self.find_iterator=self.find_all_modules(
Path(p).resolve()ifpelsePath.cwd()forpinpaths
)
defmodule_matches(self,cw:str,prefix:str="")->set[str]:
"""Modules names to replace cw with"""
full=f"{prefix}.{cw}"ifprefixelsecw
matches= (
name
fornameinself.modules
if (name.startswith(full)andname.find(".",len(full))==-1)
)
ifprefix:
return {match[len(prefix)+1 :]formatchinmatches}
else:
returnset(matches)
defattr_matches(
self,cw:str,prefix:str="",only_modules:bool=False
)->set[str]:
"""Attributes to replace name with"""
full=f"{prefix}.{cw}"ifprefixelsecw
module_name,_,name_after_dot=full.rpartition(".")
ifmodule_namenotinsys.modules:
returnset()
module=sys.modules[module_name]
ifonly_modules:
matches= {
name
fornameindir(module)
ifname.startswith(name_after_dot)
andf"{module_name}.{name}"insys.modules
}
else:
matches= {
namefornameindir(module)ifname.startswith(name_after_dot)
}
module_part=cw.rpartition(".")[0]
ifmodule_part:
matches= {f"{module_part}.{m}"forminmatches}
returnmatches
defmodule_attr_matches(self,name:str)->set[str]:
"""Only attributes which are modules to replace name with"""
returnself.attr_matches(name,only_modules=True)
defcomplete(self,cursor_offset:int,line:str)->set[str]|None:
"""Construct a full list of possibly completions for imports."""
tokens=line.split()
if"from"notintokensand"import"notintokens:
returnNone
result=current_word(cursor_offset,line)
ifresultisNone:
returnNone
from_import_from=current_from_import_from(cursor_offset,line)
iffrom_import_fromisnotNone:
import_import=current_from_import_import(cursor_offset,line)
ifimport_importisnotNone:
# `from a import <b|>` completion
matches=self.module_matches(
import_import.word,from_import_from.word
)
matches.update(
self.attr_matches(import_import.word,from_import_from.word)
)
else:
# `from <a|>` completion
matches=self.module_attr_matches(from_import_from.word)
matches.update(self.module_matches(from_import_from.word))
returnmatches
cur_import=current_import(cursor_offset,line)
ifcur_importisnotNone:
# `import <a|>` completion
matches=self.module_matches(cur_import.word)
matches.update(self.module_attr_matches(cur_import.word))
returnmatches
else:
returnNone
deffind_modules(self,path:Path)->Generator[str|None,None,None]:
"""Find all modules (and packages) for a given directory."""
ifnotpath.is_dir():
# Perhaps a zip file
return
ifany(fnmatch.fnmatch(path.name,entry)forentryinself.skiplist):
# Path is on skiplist
return
finder=importlib.machinery.FileFinder(str(path),*LOADERS)# type: ignore
try:
forpinpath.iterdir():
ifp.name.startswith(".")orp.name=="__pycache__":
# Impossible to import from names starting with . and we can skip __pycache__
continue
elifany(
fnmatch.fnmatch(p.name,entry)forentryinself.skiplist
):
# Path is on skiplist
continue
elifnotany(p.name.endswith(suffix)forsuffixinSUFFIXES):
# Possibly a package
if"."inp.name:
continue
elifp.is_dir():
# Unfortunately, CPython just crashes if there is a directory
# which ends with a python extension, so work around.
continue
name=p.name
forsuffixinSUFFIXES:
ifname.endswith(suffix):
name=name[:-len(suffix)]
break
ifname=="badsyntax_pep3120":
# Workaround for issue #166
continue
package_pathname=None
try:
withwarnings.catch_warnings():
warnings.simplefilter("ignore",ImportWarning)
spec=finder.find_spec(name)
ifspecisNone:
continue
ifspec.submodule_search_locationsisnotNone:
package_pathname=spec.submodule_search_locations[
0
]
except (ImportError,OSError,SyntaxError,UnicodeEncodeError):
# UnicodeEncodeError happens with Python 3 when there is a filename in some invalid encoding
continue
ifpackage_pathnameisnotNone:
path_real=Path(package_pathname).resolve()
try:
stat=path_real.stat()
exceptOSError:
continue
loaded_inode=_LoadedInode(stat.st_dev,stat.st_ino)
ifloaded_inodenotinself.paths:
self.paths.add(loaded_inode)
forsubnameinself.find_modules(path_real):
ifsubnameisNone:
yieldNone# take a break to avoid unresponsiveness
elifsubname!="__init__":
yieldf"{name}.{subname}"
yieldname
exceptOSError:
# Path is not readable
return
yieldNone# take a break to avoid unresponsiveness
deffind_all_modules(
self,paths:Iterable[Path]
)->Generator[None,None,None]:
"""Return a list with all modules in `path`, which should be a list of
directory names. If path is not given, sys.path will be used."""
forpinpaths:
formoduleinself.find_modules(p):
ifmoduleisnotNone:
self.modules.add(module)
yield
deffind_coroutine(self)->bool:
ifself.fully_loaded:
returnFalse
try:
next(self.find_iterator)
exceptStopIteration:
self.fully_loaded=True
returnTrue