@zzzen/pyright-internal 1.2.0-dev.20230305 → 1.2.0-dev.20230319

package/dist/languageServerBase.d.ts

@@ -1,5 +1,5 @@
 import './common/extensions';
-import { CallHierarchyIncomingCallsParams, CallHierarchyItem, CallHierarchyOutgoingCall, CallHierarchyOutgoingCallsParams, CallHierarchyPrepareParams, CancellationToken, CodeAction, CodeActionParams, Command, CompletionItem, CompletionList, CompletionParams, Connection, Declaration, DeclarationLink, Definition, DefinitionLink, DidChangeConfigurationParams, DidChangeTextDocumentParams, DidChangeWatchedFilesParams, DidCloseTextDocumentParams, DidOpenTextDocumentParams, DocumentHighlight, DocumentHighlightParams, DocumentSymbol, DocumentSymbolParams, ExecuteCommandParams, HoverParams, InitializeParams, InitializeResult, Location, MarkupKind, PrepareRenameParams, PublishDiagnosticsParams, ReferenceParams, RemoteWindow, RenameParams, SignatureHelp, SignatureHelpParams, SymbolInformation, TextDocumentPositionParams, WorkDoneProgressReporter, WorkspaceEdit, WorkspaceFolder, WorkspaceSymbol, WorkspaceSymbolParams } from 'vscode-languageserver';
+import { CallHierarchyIncomingCallsParams, CallHierarchyItem, CallHierarchyOutgoingCall, CallHierarchyOutgoingCallsParams, CallHierarchyPrepareParams, CancellationToken, CodeAction, CodeActionParams, Command, CompletionItem, CompletionList, CompletionParams, Connection, Declaration, DeclarationLink, Definition, DefinitionLink, DidChangeConfigurationParams, DidChangeTextDocumentParams, DidChangeWatchedFilesParams, DidCloseTextDocumentParams, DidOpenTextDocumentParams, DocumentHighlight, DocumentHighlightParams, DocumentSymbol, DocumentSymbolParams, ExecuteCommandParams, HoverParams, InitializeParams, InitializeResult, Location, MarkupKind, PrepareRenameParams, PublishDiagnosticsParams, ReferenceParams, RemoteWindow, RenameParams, SignatureHelp, SignatureHelpParams, SymbolInformation, TextDocumentPositionParams, WorkDoneProgressReporter, WorkspaceEdit, WorkspaceSymbol, WorkspaceSymbolParams } from 'vscode-languageserver';
 import { ResultProgressReporter } from 'vscode-languageserver/lib/common/progress';
 import { AnalysisResults } from './analyzer/analysis';
 import { BackgroundAnalysisProgram } from './analyzer/backgroundAnalysisProgram';
@@ -24,7 +24,7 @@ import { UriParser } from './common/uriParser';
 import { CompletionOptions, CompletionResultsList } from './languageService/completionProvider';
 import { DefinitionFilter } from './languageService/definitionProvider';
 import { PyrightFileSystem } from './pyrightFileSystem';
-import { WorkspaceMap } from './workspaceMap';
+import { InitStatus, Workspace, WorkspaceFactory } from './workspaceFactory';
 export interface ServerSettings {
     venvPath?: string | undefined;
     pythonPath?: string | undefined;
@@ -52,34 +52,6 @@ export interface ServerSettings {
     taskListTokens?: TaskListToken[];
     functionSignatureDisplay?: SignatureDisplayType | undefined;
 }
-export declare enum WellKnownWorkspaceKinds {
-    Default = "default",
-    Regular = "regular",
-    Limited = "limited",
-    Cloned = "cloned",
-    Test = "test"
-}
-export declare function createInitStatus(): InitStatus;
-export interface InitStatus {
-    resolve(): void;
-    reset(): InitStatus;
-    markCalled(): void;
-    promise: Promise<void>;
-    resolved(): boolean;
-}
-export interface WorkspaceServiceInstance {
-    workspaceName: string;
-    rootPath: string;
-    path: string;
-    uri: string;
-    kinds: string[];
-    serviceInstance: AnalyzerService;
-    disableLanguageServices: boolean;
-    disableOrganizeImports: boolean;
-    disableWorkspaceSymbol: boolean;
-    isInitialized: InitStatus;
-    searchPathsToWatch: string[];
-}
 export interface MessageAction {
     title: string;
     id: string;
@@ -93,8 +65,8 @@ export interface WindowInterface {
     showInformationMessage(message: string, ...actions: MessageAction[]): Promise<MessageAction | undefined>;
 }
 export interface LanguageServerInterface {
-    getWorkspaceForFile(filePath: string): Promise<WorkspaceServiceInstance>;
-    getSettings(workspace: WorkspaceServiceInstance): Promise<ServerSettings>;
+    getWorkspaceForFile(filePath: string): Promise<Workspace>;
+    getSettings(workspace: Workspace): Promise<ServerSettings>;
     createBackgroundAnalysis(serviceId: string): BackgroundAnalysisBase | undefined;
     reanalyze(): void;
     restart(): void;
@@ -108,7 +80,6 @@ export interface ServerOptions {
     productName: string;
     rootDirectory: string;
     version: string;
-    workspaceMap: WorkspaceMap;
     cancellationProvider: CancellationProvider;
     fileSystem: FileSystem;
     fileWatcherHandler: FileWatcherHandler;
@@ -116,6 +87,7 @@ export interface ServerOptions {
     disableChecker?: boolean;
     supportedCommands?: string[];
     supportedCodeActions?: string[];
+    supportsTelemetry?: boolean;
 }
 export interface WorkspaceServices {
     fs: FileSystem;
@@ -149,13 +121,14 @@ export declare abstract class LanguageServerBase implements LanguageServerInterf
     protected _connection: Connection;
     readonly console: ConsoleInterface;
     protected _defaultClientConfig: any;
-    protected _workspaceMap: WorkspaceMap;
+    protected _workspaceFactory: WorkspaceFactory;
     protected _cacheManager: CacheManager;
     private _pendingFindAllRefsCancellationSource;
     private _pendingCommandCancellationSource;
     private _progressReporter;
     private _lastTriggerKind;
     private _lastFileWatcherRegistration;
+    private _initialized;
     rootPath: string;
     protected client: ClientCapabilities;
     protected _serviceFS: PyrightFileSystem;
@@ -166,7 +139,8 @@ export declare abstract class LanguageServerBase implements LanguageServerInterf
     protected abstract executeCommand(params: ExecuteCommandParams, token: CancellationToken): Promise<any>;
     protected abstract isLongRunningCommand(command: string): boolean;
     protected abstract executeCodeAction(params: CodeActionParams, token: CancellationToken): Promise<(Command | CodeAction)[] | undefined | null>;
-    abstract getSettings(workspace: WorkspaceServiceInstance): Promise<ServerSettings>;
+    abstract getSettings(workspace: Workspace): Promise<ServerSettings>;
+    protected isPythonPathImmutable(filePath: string): boolean;
     protected getConfiguration(scopeUri: string | undefined, section: string): Promise<any>;
     protected isOpenFilesOnly(diagnosticMode: string): boolean;
     protected get allowModuleRename(): boolean;
@@ -178,8 +152,9 @@ export declare abstract class LanguageServerBase implements LanguageServerInterf
     get window(): RemoteWindow;
     get supportAdvancedEdits(): boolean;
     createAnalyzerService(name: string, services?: WorkspaceServices, libraryReanalysisTimeProvider?: () => number): AnalyzerService;
-    test_getWorkspaces(): Promise<WorkspaceServiceInstance[]>;
-    getWorkspaceForFile(filePath: string): Promise<WorkspaceServiceInstance>;
+    test_getWorkspaces(): Promise<Workspace[]>;
+    getWorkspaceForFile(filePath: string, pythonPath?: string): Promise<Workspace>;
+    getContainingWorkspacesForFile(filePath: string): Promise<Workspace[]>;
     reanalyze(): void;
     restart(): void;
     protected setupConnection(supportedCommands: string[], supportedCodeActions: string[]): void;
@@ -190,11 +165,11 @@ export declare abstract class LanguageServerBase implements LanguageServerInterf
     protected onDefinition(params: TextDocumentPositionParams, token: CancellationToken): Promise<Definition | DefinitionLink[] | undefined | null>;
     protected onDeclaration(params: TextDocumentPositionParams, token: CancellationToken): Promise<Declaration | DeclarationLink[] | undefined | null>;
     protected onTypeDefinition(params: TextDocumentPositionParams, token: CancellationToken): Promise<Definition | DefinitionLink[] | undefined | null>;
-    protected getDefinitions(params: TextDocumentPositionParams, token: CancellationToken, filter: DefinitionFilter, getDefinitionsFunc: (workspace: WorkspaceServiceInstance, filePath: string, position: Position, filter: DefinitionFilter, token: CancellationToken) => DocumentRange[] | undefined): Promise<Location[] | undefined>;
+    protected getDefinitions(params: TextDocumentPositionParams, token: CancellationToken, filter: DefinitionFilter, getDefinitionsFunc: (workspace: Workspace, filePath: string, position: Position, filter: DefinitionFilter, token: CancellationToken) => DocumentRange[] | undefined): Promise<Location[] | undefined>;
     protected onReferences(params: ReferenceParams, token: CancellationToken, workDoneReporter: WorkDoneProgressReporter, resultReporter: ResultProgressReporter<Location[]> | undefined): Promise<Location[] | null | undefined>;
     protected onDocumentSymbol(params: DocumentSymbolParams, token: CancellationToken): Promise<DocumentSymbol[] | SymbolInformation[] | null | undefined>;
     protected onWorkspaceSymbol(params: WorkspaceSymbolParams, token: CancellationToken, resultReporter: ResultProgressReporter<SymbolInformation[]> | undefined): Promise<SymbolInformation[] | WorkspaceSymbol[] | null | undefined>;
-    protected onHover(params: HoverParams, token: CancellationToken): Promise<import("vscode-languageserver").Hover | undefined>;
+    protected onHover(params: HoverParams, token: CancellationToken): Promise<import("vscode-languageserver-types").Hover | undefined>;
     protected onDocumentHighlight(params: DocumentHighlightParams, token: CancellationToken): Promise<DocumentHighlight[] | null | undefined>;
     protected onSignatureHelp(params: SignatureHelpParams, token: CancellationToken): Promise<SignatureHelp | undefined | null>;
     protected onCompletion(params: CompletionParams, token: CancellationToken): Promise<CompletionList | undefined>;
@@ -213,16 +188,16 @@ export declare abstract class LanguageServerBase implements LanguageServerInterf
     protected onDidChangeWatchedFiles(params: DidChangeWatchedFilesParams): void;
     protected onExecuteCommand(params: ExecuteCommandParams, token: CancellationToken, reporter: WorkDoneProgressReporter): Promise<any>;
     protected onShutdown(token: CancellationToken): Promise<void>;
-    protected resolveWorkspaceCompletionItem(workspace: WorkspaceServiceInstance, filePath: string, item: CompletionItem, token: CancellationToken): void;
-    protected getWorkspaceCompletionsForPosition(workspace: WorkspaceServiceInstance, filePath: string, position: Position, options: CompletionOptions, token: CancellationToken): Promise<CompletionResultsList | undefined>;
+    protected resolveWorkspaceCompletionItem(workspace: Workspace, filePath: string, item: CompletionItem, token: CancellationToken): void;
+    protected getWorkspaceCompletionsForPosition(workspace: Workspace, filePath: string, position: Position, options: CompletionOptions, token: CancellationToken): Promise<CompletionResultsList | undefined>;
     updateSettingsForAllWorkspaces(): void;
-    protected getCompletionOptions(workspace: WorkspaceServiceInstance, params?: CompletionParams): CompletionOptions;
-    protected createWorkspaceServiceInstance(workspaceFolder: WorkspaceFolder | undefined, rootPath: string, path: string, kinds?: string[], services?: WorkspaceServices): WorkspaceServiceInstance;
+    protected getCompletionOptions(workspace: Workspace, params?: CompletionParams): CompletionOptions;
     protected convertDiagnostics(fs: FileSystem, fileDiagnostics: FileDiagnostics): PublishDiagnosticsParams[];
     protected onAnalysisCompletedHandler(fs: FileSystem, results: AnalysisResults): void;
-    updateSettingsForWorkspace(workspace: WorkspaceServiceInstance, status: InitStatus | undefined, serverSettings?: ServerSettings): Promise<void>;
-    updateOptionsAndRestartService(workspace: WorkspaceServiceInstance, serverSettings: ServerSettings, typeStubTargetImportName?: string): void;
-    protected convertLogLevel(logLevelValue?: string): LogLevel;
+    updateSettingsForWorkspace(workspace: Workspace, status: InitStatus | undefined, serverSettings?: ServerSettings): Promise<void>;
+    updateOptionsAndRestartService(workspace: Workspace, serverSettings: ServerSettings, typeStubTargetImportName?: string): void;
+    protected onWorkspaceCreated(workspace: Workspace): void;
+    protected createAnalyzerServiceForWorkspace(name: string, _rootPath: string, _uri: string, kinds: string[], services?: WorkspaceServices): AnalyzerService;
     private _sendDiagnostics;
     private _getCompatibleMarkupKind;
     private _getProgressReporter;