@zzzen/pyright-internal 1.2.0-dev.20230423 → 1.2.0-dev.20230507

package/dist/languageServerBase.d.ts

@@ -1,6 +1,7 @@
 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, WorkspaceSymbol, WorkspaceSymbolParams } from 'vscode-languageserver';
 import { ResultProgressReporter } from 'vscode-languageserver/lib/common/progress';
+import { TextDocument } from 'vscode-languageserver-textdocument';
 import { AnalysisResults } from './analyzer/analysis';
 import { BackgroundAnalysisProgram } from './analyzer/backgroundAnalysisProgram';
 import { CacheManager } from './analyzer/cacheManager';
@@ -65,16 +66,16 @@ export interface WindowInterface {
     showInformationMessage(message: string, ...actions: MessageAction[]): Promise<MessageAction | undefined>;
 }
 export interface LanguageServerInterface {
+    readonly rootPath: string;
+    readonly console: ConsoleInterface;
+    readonly window: WindowInterface;
+    readonly supportAdvancedEdits: boolean;
     getWorkspaceForFile(filePath: string): Promise<Workspace>;
     getSettings(workspace: Workspace): Promise<ServerSettings>;
     createBackgroundAnalysis(serviceId: string): BackgroundAnalysisBase | undefined;
     reanalyze(): void;
     restart(): void;
     decodeTextDocumentUri(uriString: string): string;
-    readonly rootPath: string;
-    readonly console: ConsoleInterface;
-    readonly window: WindowInterface;
-    readonly supportAdvancedEdits: boolean;
 }
 export interface ServerOptions {
     productName: string;
@@ -117,12 +118,9 @@ interface ClientCapabilities {
     completionItemResolveSupportsAdditionalTextEdits: boolean;
 }
 export declare abstract class LanguageServerBase implements LanguageServerInterface {
-    protected _serverOptions: ServerOptions;
-    protected _connection: Connection;
+    protected serverOptions: ServerOptions;
+    protected connection: Connection;
     readonly console: ConsoleInterface;
-    protected _defaultClientConfig: any;
-    protected _workspaceFactory: WorkspaceFactory;
-    protected _cacheManager: CacheManager;
     private _pendingFindAllRefsCancellationSource;
     private _pendingCommandCancellationSource;
     private _progressReporter;
@@ -131,36 +129,41 @@ export declare abstract class LanguageServerBase implements LanguageServerInterf
     private _initialized;
     rootPath: string;
     protected client: ClientCapabilities;
-    protected _serviceFS: PyrightFileSystem;
-    protected _uriParser: UriParser;
-    constructor(_serverOptions: ServerOptions, _connection: Connection, console: ConsoleInterface, uriParserFactory?: (fs: FileSystem) => UriParser);
+    protected defaultClientConfig: any;
+    protected workspaceFactory: WorkspaceFactory;
+    protected openFileMap: Map<string, TextDocument>;
+    protected cacheManager: CacheManager;
+    protected fs: PyrightFileSystem;
+    protected uriParser: UriParser;
+    constructor(serverOptions: ServerOptions, connection: Connection, console: ConsoleInterface, uriParserFactory?: (fs: FileSystem) => UriParser);
+    get window(): RemoteWindow;
+    get supportAdvancedEdits(): boolean;
     decodeTextDocumentUri(uriString: string): string;
     abstract createBackgroundAnalysis(serviceId: string): BackgroundAnalysisBase | undefined;
+    abstract getSettings(workspace: Workspace): Promise<ServerSettings>;
+    createAnalyzerService(name: string, services?: WorkspaceServices, libraryReanalysisTimeProvider?: () => number): AnalyzerService;
+    test_getWorkspaces(): Promise<Workspace[]>;
+    getWorkspaceForFile(filePath: string, pythonPath?: string): Promise<Workspace>;
+    getContainingWorkspacesForFile(filePath: string): Promise<Workspace[]>;
+    reanalyze(): void;
+    restart(): void;
+    updateSettingsForAllWorkspaces(): void;
+    updateSettingsForWorkspace(workspace: Workspace, status: InitStatus | undefined, serverSettings?: ServerSettings): Promise<void>;
+    updateOptionsAndRestartService(workspace: Workspace, serverSettings: ServerSettings, typeStubTargetImportName?: string): void;
     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: 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;
     protected getSeverityOverrides(value: string): DiagnosticSeverityOverrides | undefined;
     protected getDiagnosticRuleName(value: string): DiagnosticRule | undefined;
     protected abstract createHost(): Host;
     protected abstract createImportResolver(fs: FileSystem, options: ConfigOptions, host: Host): ImportResolver;
     protected createBackgroundAnalysisProgram(serviceId: string, console: ConsoleInterface, configOptions: ConfigOptions, importResolver: ImportResolver, backgroundAnalysis?: BackgroundAnalysisBase, maxAnalysisTime?: MaxAnalysisTime, cacheManager?: CacheManager): BackgroundAnalysisProgram;
-    get window(): RemoteWindow;
-    get supportAdvancedEdits(): boolean;
-    createAnalyzerService(name: string, services?: WorkspaceServices, libraryReanalysisTimeProvider?: () => number): AnalyzerService;
-    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;
     protected initialize(params: InitializeParams, supportedCommands: string[], supportedCodeActions: string[]): InitializeResult;
     protected onInitialized(): void;
-    private _setupFileWatcher;
     protected onDidChangeConfiguration(params: DidChangeConfigurationParams): void;
     protected onDefinition(params: TextDocumentPositionParams, token: CancellationToken): Promise<Definition | DefinitionLink[] | undefined | null>;
     protected onDeclaration(params: TextDocumentPositionParams, token: CancellationToken): Promise<Declaration | DeclarationLink[] | undefined | null>;
@@ -169,7 +172,7 @@ export declare abstract class LanguageServerBase implements LanguageServerInterf
     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-types").Hover | undefined>;
+    protected onHover(params: HoverParams, token: CancellationToken): Promise<import("vscode-languageserver-types").Hover | null>;
     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>;
@@ -190,21 +193,19 @@ export declare abstract class LanguageServerBase implements LanguageServerInterf
     protected onShutdown(token: CancellationToken): Promise<void>;
     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: Workspace, params?: CompletionParams): CompletionOptions;
     protected convertDiagnostics(fs: FileSystem, fileDiagnostics: FileDiagnostics): PublishDiagnosticsParams[];
     protected onAnalysisCompletedHandler(fs: FileSystem, results: AnalysisResults): void;
-    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;
-    private _convertDiagnostics;
     protected recordUserInteractionTime(): void;
     protected getDocumentationUrlForDiagnosticRule(rule: string): string | undefined;
     protected abstract createProgressReporter(): ProgressReporter;
     protected canNavigateToFile(path: string, fs: FileSystem): boolean;
+    private _setupFileWatcher;
+    private _sendDiagnostics;
+    private _getCompatibleMarkupKind;
+    private _getProgressReporter;
+    private _convertDiagnostics;
 }
 export {};