microsoft/pyright
1
1
Fork 0
mirror of https://github.com/microsoft/pyright.git synced 2024-10-26 19:01:08 +03:00
Code Issues Projects Releases Wiki Activity

Improved completion suggestions for symbol imports when no text has been typed. Private symbols are now deprioritized.

Browse Source
This commit is contained in:
Eric Traut 2019-09-15 16:01:04 -07:00
parent b2ad5c1f3d
commit 06a16d26cd
3 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
server/src/analyzer/symbolNameUtils.ts
View File

@ -24,6 +24,11 @@ export function isProtectedName(name: string) {
!name.startsWith('__');
}
export function isPrivateOrProtectedName(name: string) {
return name.length > 1 &&
name.startsWith('_');
}
// "Dunder" names start and end with two underscores.
export function isDunderName(name: string) {
return name.length > 4 &&

7
server/src/analyzer/typeStubWriter.ts
View File

@ -308,9 +308,7 @@ export class TypeStubWriter extends ParseTreeWalker {
if (baseExpression.nodeType === ParseNodeType.Name) {
if (baseExpression.nameToken.value === 'self') {
const memberName = node.leftExpression.memberName.nameToken.value;
if (!SymbolNameUtils.isProtectedName(memberName) &&
!SymbolNameUtils.isPrivateName(memberName)) {
if (!SymbolNameUtils.isPrivateOrProtectedName(memberName)) {
line = this._printExpression(node.leftExpression);
}
}
@ -366,8 +364,7 @@ export class TypeStubWriter extends ParseTreeWalker {
if (baseExpression.nodeType === ParseNodeType.Name) {
if (baseExpression.nameToken.value === 'self') {
const memberName = node.valueExpression.memberName.nameToken.value;
if (!SymbolNameUtils.isProtectedName(memberName) &&
!SymbolNameUtils.isPrivateName(memberName)) {
if (!SymbolNameUtils.isPrivateOrProtectedName(memberName)) {
line = this._printExpression(node.valueExpression);
}
}

13
server/src/languageService/completionProvider.ts
View File

@ -100,6 +100,10 @@ enum SortCategory {
// A normal symbol.
NormalSymbol,
// A symbol that starts with _ or __ (used only when there is
// no matching filter).
PrivateSymbol,
// A symbol with a dunder name (e.g. __init__).
DunderSymbol,
@ -423,7 +427,7 @@ export class CompletionProvider {
// Don't offer imports from files that are named with private
// naming semantics like "_ast.py".
if (!SymbolNameUtils.isProtectedName(fileName) && !SymbolNameUtils.isPrivateName(fileName)) {
if (!SymbolNameUtils.isPrivateOrProtectedName(fileName)) {
const symbolTable = moduleSymbolMap[filePath];
symbolTable.forEach((symbol, name) => {
@ -714,6 +718,12 @@ export class CompletionProvider {
// Force dunder-named symbols to appear after all other symbols.
completionItem.sortText =
this._makeSortText(SortCategory.DunderSymbol, name);
} else if (filter === '' && (SymbolNameUtils.isPrivateOrProtectedName(name))) {
// Distinguish between normal and private symbols only if there is
// currently no filter text. Once we get a single character to filter
// upon, we'll no longer differentiate.
completionItem.sortText =
this._makeSortText(SortCategory.PrivateSymbol, name);
} else {
completionItem.sortText =
this._makeSortText(SortCategory.NormalSymbol, name);
@ -784,6 +794,7 @@ export class CompletionProvider {
sortCategory = SortCategory.RecentImportModuleName;
} else if (sortCategory === SortCategory.Keyword ||
sortCategory === SortCategory.NormalSymbol ||
sortCategory === SortCategory.PrivateSymbol ||
sortCategory === SortCategory.DunderSymbol) {
sortCategory = SortCategory.RecentKeywordOrSymbol;
}