Skip to content

Commit 08e4074

Browse files
authored
Rename some types (#13408)
* Rename InterpreterType to EnvironmentType * Rename PythonInterpreter to PythonEnvironment * Rename environment type field from 'type' to 'envType' * Fix unit tests broken by rename. * Fix build failure.
1 parent 9b3803a commit 08e4074

File tree

182 files changed

+924
-917
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

182 files changed

+924
-917
lines changed

src/client/activation/activationService.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { LanguageService } from '../common/utils/localize';
2929
import { noop } from '../common/utils/misc';
3030
import { IInterpreterService } from '../interpreter/contracts';
3131
import { IServiceContainer } from '../ioc/types';
32-
import { PythonInterpreter } from '../pythonEnvironments/info';
32+
import { PythonEnvironment } from '../pythonEnvironments/info';
3333
import { sendTelemetryEvent } from '../telemetry';
3434
import { EventName } from '../telemetry/constants';
3535
import { Commands } from './commands';
@@ -119,7 +119,7 @@ export class LanguageServerExtensionActivationService
119119
this.activatedServer.server.activate();
120120
}
121121

122-
public async get(resource: Resource, interpreter?: PythonInterpreter): Promise<RefCountedLanguageServer> {
122+
public async get(resource: Resource, interpreter?: PythonEnvironment): Promise<RefCountedLanguageServer> {
123123
// See if we already have it or not
124124
const key = await this.getKey(resource, interpreter);
125125
let result: Promise<RefCountedLanguageServer> | undefined = this.cache.get(key);
@@ -212,7 +212,7 @@ export class LanguageServerExtensionActivationService
212212

213213
private async createRefCountedServer(
214214
resource: Resource,
215-
interpreter: PythonInterpreter | undefined,
215+
interpreter: PythonEnvironment | undefined,
216216
key: string
217217
): Promise<RefCountedLanguageServer> {
218218
let serverType = this.getCurrentLanguageServerType();
@@ -293,7 +293,7 @@ export class LanguageServerExtensionActivationService
293293
}
294294
}
295295

296-
private async getKey(resource: Resource, interpreter?: PythonInterpreter): Promise<string> {
296+
private async getKey(resource: Resource, interpreter?: PythonEnvironment): Promise<string> {
297297
const configurationService = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
298298
const serverType = configurationService.getSettings(this.resource).languageServer;
299299
if (serverType === LanguageServerType.Node) {

src/client/activation/common/activatorBase.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { IWorkspaceService } from '../../common/application/types';
2828
import { traceDecorators } from '../../common/logger';
2929
import { IFileSystem } from '../../common/platform/types';
3030
import { IConfigurationService, Resource } from '../../common/types';
31-
import { PythonInterpreter } from '../../pythonEnvironments/info';
31+
import { PythonEnvironment } from '../../pythonEnvironments/info';
3232
import { ILanguageServerActivator, ILanguageServerManager } from '../types';
3333

3434
/**
@@ -49,7 +49,7 @@ export abstract class LanguageServerActivatorBase implements ILanguageServerActi
4949
) {}
5050

5151
@traceDecorators.error('Failed to activate language server')
52-
public async start(resource: Resource, interpreter?: PythonInterpreter): Promise<void> {
52+
public async start(resource: Resource, interpreter?: PythonEnvironment): Promise<void> {
5353
if (!resource) {
5454
resource = this.workspace.hasWorkspaceFolders ? this.workspace.workspaceFolders![0].uri : undefined;
5555
}

src/client/activation/common/analysisOptions.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { traceDecorators } from '../../common/logger';
99
import { IOutputChannel, Resource } from '../../common/types';
1010
import { debounceSync } from '../../common/utils/decorators';
1111
import { IEnvironmentVariablesProvider } from '../../common/variables/types';
12-
import { PythonInterpreter } from '../../pythonEnvironments/info';
12+
import { PythonEnvironment } from '../../pythonEnvironments/info';
1313
import { ILanguageServerAnalysisOptions, ILanguageServerOutputChannel } from '../types';
1414

1515
@injectable()
@@ -26,7 +26,7 @@ export abstract class LanguageServerAnalysisOptionsBase implements ILanguageServ
2626
this.output = lsOutputChannel.channel;
2727
}
2828

29-
public async initialize(_resource: Resource, _interpreter: PythonInterpreter | undefined) {
29+
public async initialize(_resource: Resource, _interpreter: PythonEnvironment | undefined) {
3030
const disposable = this.envVarsProvider.onDidEnvironmentVariablesChange(this.onEnvVarChange, this);
3131
this.disposables.push(disposable);
3232
}

src/client/activation/jedi.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import { PythonReferenceProvider } from '../providers/referenceProvider';
3939
import { PythonRenameProvider } from '../providers/renameProvider';
4040
import { PythonSignatureProvider } from '../providers/signatureProvider';
4141
import { JediSymbolProvider } from '../providers/symbolProvider';
42-
import { PythonInterpreter } from '../pythonEnvironments/info';
42+
import { PythonEnvironment } from '../pythonEnvironments/info';
4343
import { ITestManagementService } from '../testing/types';
4444
import { BlockFormatProviders } from '../typeFormatters/blockFormatProvider';
4545
import { OnTypeFormattingDispatcher } from '../typeFormatters/dispatcher';
@@ -69,7 +69,7 @@ export class JediExtensionActivator implements ILanguageServerActivator {
6969
this.documentSelector = PYTHON;
7070
}
7171

72-
public async start(_resource: Resource, interpreter: PythonInterpreter | undefined): Promise<void> {
72+
public async start(_resource: Resource, interpreter: PythonEnvironment | undefined): Promise<void> {
7373
if (this.jediFactory) {
7474
throw new Error('Jedi already started');
7575
}

src/client/activation/languageServer/activator.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { IWorkspaceService } from '../../common/application/types';
88
import { EXTENSION_ROOT_DIR, isTestExecution } from '../../common/constants';
99
import { IFileSystem } from '../../common/platform/types';
1010
import { BANNER_NAME_PROPOSE_LS, IConfigurationService, IPythonExtensionBanner, Resource } from '../../common/types';
11-
import { PythonInterpreter } from '../../pythonEnvironments/info';
11+
import { PythonEnvironment } from '../../pythonEnvironments/info';
1212
import { LanguageServerActivatorBase } from '../common/activatorBase';
1313
import { ILanguageServerDownloader, ILanguageServerFolderService, ILanguageServerManager } from '../types';
1414

@@ -37,7 +37,7 @@ export class DotNetLanguageServerActivator extends LanguageServerActivatorBase {
3737
super(manager, workspace, fs, configurationService);
3838
}
3939

40-
public async start(resource: Resource, interpreter?: PythonInterpreter): Promise<void> {
40+
public async start(resource: Resource, interpreter?: PythonEnvironment): Promise<void> {
4141
if (!isTestExecution()) {
4242
this.proposePylancePopup.showBanner().ignoreErrors();
4343
}

src/client/activation/languageServer/analysisOptions.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ import { traceDecorators, traceError } from '../../common/logger';
1010
import { IConfigurationService, IExtensionContext, IPathUtils, Resource } from '../../common/types';
1111
import { debounceSync } from '../../common/utils/decorators';
1212
import { IEnvironmentVariablesProvider } from '../../common/variables/types';
13-
import { PythonInterpreter } from '../../pythonEnvironments/info';
13+
import { PythonEnvironment } from '../../pythonEnvironments/info';
1414
import { LanguageServerAnalysisOptionsBase } from '../common/analysisOptions';
1515
import { ILanguageServerFolderService, ILanguageServerOutputChannel } from '../types';
1616

1717
@injectable()
1818
export class DotNetLanguageServerAnalysisOptions extends LanguageServerAnalysisOptionsBase {
1919
private resource: Resource;
20-
private interpreter: PythonInterpreter | undefined;
20+
private interpreter: PythonEnvironment | undefined;
2121
private languageServerFolder: string = '';
2222
private excludedFiles: string[] = [];
2323
private typeshedPaths: string[] = [];
@@ -34,7 +34,7 @@ export class DotNetLanguageServerAnalysisOptions extends LanguageServerAnalysisO
3434
super(envVarsProvider, lsOutputChannel);
3535
}
3636

37-
public async initialize(resource: Resource, interpreter: PythonInterpreter | undefined) {
37+
public async initialize(resource: Resource, interpreter: PythonEnvironment | undefined) {
3838
await super.initialize(resource, interpreter);
3939

4040
this.resource = resource;

src/client/activation/languageServer/languageClientFactory.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { EXTENSION_ROOT_DIR, PYTHON_LANGUAGE } from '../../common/constants';
99
import { IConfigurationService, Resource } from '../../common/types';
1010
import { IEnvironmentVariablesProvider } from '../../common/variables/types';
1111
import { IEnvironmentActivationService } from '../../interpreter/activation/types';
12-
import { PythonInterpreter } from '../../pythonEnvironments/info';
12+
import { PythonEnvironment } from '../../pythonEnvironments/info';
1313
import { ILanguageClientFactory, ILanguageServerFolderService, IPlatformData } from '../types';
1414

1515
// tslint:disable:no-require-imports no-require-imports no-var-requires max-classes-per-file
@@ -25,7 +25,7 @@ export class DotNetDownloadedLanguageClientFactory implements ILanguageClientFac
2525

2626
public async createLanguageClient(
2727
resource: Resource,
28-
_interpreter: PythonInterpreter | undefined,
28+
_interpreter: PythonEnvironment | undefined,
2929
clientOptions: LanguageClientOptions,
3030
env?: NodeJS.ProcessEnv
3131
): Promise<LanguageClient> {
@@ -58,7 +58,7 @@ export class DotNetSimpleLanguageClientFactory implements ILanguageClientFactory
5858

5959
public async createLanguageClient(
6060
resource: Resource,
61-
_interpreter: PythonInterpreter | undefined,
61+
_interpreter: PythonEnvironment | undefined,
6262
clientOptions: LanguageClientOptions,
6363
env?: NodeJS.ProcessEnv
6464
): Promise<LanguageClient> {
@@ -95,7 +95,7 @@ export class DotNetLanguageClientFactory implements ILanguageClientFactory {
9595

9696
public async createLanguageClient(
9797
resource: Resource,
98-
interpreter: PythonInterpreter | undefined,
98+
interpreter: PythonEnvironment | undefined,
9999
clientOptions: LanguageClientOptions
100100
): Promise<LanguageClient> {
101101
const settings = this.configurationService.getSettings(resource);
@@ -113,7 +113,7 @@ export class DotNetLanguageClientFactory implements ILanguageClientFactory {
113113

114114
private async getEnvVars(
115115
resource: Resource,
116-
interpreter: PythonInterpreter | undefined
116+
interpreter: PythonEnvironment | undefined
117117
): Promise<NodeJS.ProcessEnv> {
118118
const envVars = await this.environmentActivationService.getActivatedEnvironmentVariables(resource, interpreter);
119119
if (envVars && Object.keys(envVars).length > 0) {

src/client/activation/languageServer/languageServerProxy.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { createDeferred, Deferred, sleep } from '../../common/utils/async';
1111
import { swallowExceptions } from '../../common/utils/decorators';
1212
import { noop } from '../../common/utils/misc';
1313
import { LanguageServerSymbolProvider } from '../../providers/symbolProvider';
14-
import { PythonInterpreter } from '../../pythonEnvironments/info';
14+
import { PythonEnvironment } from '../../pythonEnvironments/info';
1515
import { captureTelemetry, sendTelemetryEvent } from '../../telemetry';
1616
import { EventName } from '../../telemetry/constants';
1717
import { ITestManagementService } from '../../testing/types';
@@ -55,7 +55,7 @@ export class DotNetLanguageServerProxy implements ILanguageServerProxy {
5555
@captureTelemetry(EventName.PYTHON_LANGUAGE_SERVER_ENABLED, undefined, true)
5656
public async start(
5757
resource: Resource,
58-
interpreter: PythonInterpreter | undefined,
58+
interpreter: PythonEnvironment | undefined,
5959
options: LanguageClientOptions
6060
): Promise<void> {
6161
if (!this.languageClient) {

src/client/activation/languageServer/manager.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { traceDecorators } from '../../common/logger';
99
import { IConfigurationService, IDisposable, IExperimentsManager, Resource } from '../../common/types';
1010
import { debounceSync } from '../../common/utils/decorators';
1111
import { IServiceContainer } from '../../ioc/types';
12-
import { PythonInterpreter } from '../../pythonEnvironments/info';
12+
import { PythonEnvironment } from '../../pythonEnvironments/info';
1313
import { captureTelemetry } from '../../telemetry';
1414
import { EventName } from '../../telemetry/constants';
1515
import { Commands } from '../commands';
@@ -27,7 +27,7 @@ import {
2727
export class DotNetLanguageServerManager implements ILanguageServerManager {
2828
private languageServerProxy?: ILanguageServerProxy;
2929
private resource!: Resource;
30-
private interpreter: PythonInterpreter | undefined;
30+
private interpreter: PythonEnvironment | undefined;
3131
private middleware: LanguageClientMiddleware | undefined;
3232
private disposables: IDisposable[] = [];
3333
private connected: boolean = false;
@@ -68,7 +68,7 @@ export class DotNetLanguageServerManager implements ILanguageServerManager {
6868
return this.languageServerProxy;
6969
}
7070
@traceDecorators.error('Failed to start language server')
71-
public async start(resource: Resource, interpreter: PythonInterpreter | undefined): Promise<void> {
71+
public async start(resource: Resource, interpreter: PythonEnvironment | undefined): Promise<void> {
7272
if (this.languageProxy) {
7373
throw new Error('Language server already started');
7474
}

src/client/activation/node/languageClientFactory.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { LanguageClient, LanguageClientOptions, ServerOptions, TransportKind } f
88
import { EXTENSION_ROOT_DIR, PYTHON_LANGUAGE } from '../../common/constants';
99
import { IFileSystem } from '../../common/platform/types';
1010
import { Resource } from '../../common/types';
11-
import { PythonInterpreter } from '../../pythonEnvironments/info';
11+
import { PythonEnvironment } from '../../pythonEnvironments/info';
1212
import { ILanguageClientFactory, ILanguageServerFolderService } from '../types';
1313
import { FileBasedCancellationStrategy } from './cancellationUtils';
1414

@@ -24,7 +24,7 @@ export class NodeLanguageClientFactory implements ILanguageClientFactory {
2424

2525
public async createLanguageClient(
2626
resource: Resource,
27-
_interpreter: PythonInterpreter | undefined,
27+
_interpreter: PythonEnvironment | undefined,
2828
clientOptions: LanguageClientOptions
2929
): Promise<LanguageClient> {
3030
// this must exist for node language client

src/client/activation/node/languageServerProxy.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { createDeferred, Deferred, sleep } from '../../common/utils/async';
1717
import { swallowExceptions } from '../../common/utils/decorators';
1818
import { noop } from '../../common/utils/misc';
1919
import { LanguageServerSymbolProvider } from '../../providers/symbolProvider';
20-
import { PythonInterpreter } from '../../pythonEnvironments/info';
20+
import { PythonEnvironment } from '../../pythonEnvironments/info';
2121
import { captureTelemetry, sendTelemetryEvent } from '../../telemetry';
2222
import { EventName } from '../../telemetry/constants';
2323
import { ITestManagementService } from '../../testing/types';
@@ -83,7 +83,7 @@ export class NodeLanguageServerProxy implements ILanguageServerProxy {
8383
)
8484
public async start(
8585
resource: Resource,
86-
interpreter: PythonInterpreter | undefined,
86+
interpreter: PythonEnvironment | undefined,
8787
options: LanguageClientOptions
8888
): Promise<void> {
8989
if (!this.languageClient) {

src/client/activation/node/manager.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { traceDecorators } from '../../common/logger';
99
import { IConfigurationService, IDisposable, IExperimentsManager, Resource } from '../../common/types';
1010
import { debounceSync } from '../../common/utils/decorators';
1111
import { IServiceContainer } from '../../ioc/types';
12-
import { PythonInterpreter } from '../../pythonEnvironments/info';
12+
import { PythonEnvironment } from '../../pythonEnvironments/info';
1313
import { captureTelemetry } from '../../telemetry';
1414
import { EventName } from '../../telemetry/constants';
1515
import { Commands } from '../commands';
@@ -26,7 +26,7 @@ import {
2626
export class NodeLanguageServerManager implements ILanguageServerManager {
2727
private languageServerProxy?: ILanguageServerProxy;
2828
private resource!: Resource;
29-
private interpreter: PythonInterpreter | undefined;
29+
private interpreter: PythonEnvironment | undefined;
3030
private middleware: LanguageClientMiddleware | undefined;
3131
private disposables: IDisposable[] = [];
3232
private connected: boolean = false;
@@ -68,7 +68,7 @@ export class NodeLanguageServerManager implements ILanguageServerManager {
6868
}
6969

7070
@traceDecorators.error('Failed to start language server')
71-
public async start(resource: Resource, interpreter: PythonInterpreter | undefined): Promise<void> {
71+
public async start(resource: Resource, interpreter: PythonEnvironment | undefined): Promise<void> {
7272
if (this.languageProxy) {
7373
throw new Error('Language server already started');
7474
}

src/client/activation/none/activator.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
} from 'vscode';
2323
import { isTestExecution } from '../../common/constants';
2424
import { BANNER_NAME_PROPOSE_LS, IPythonExtensionBanner, Resource } from '../../common/types';
25-
import { PythonInterpreter } from '../../pythonEnvironments/info';
25+
import { PythonEnvironment } from '../../pythonEnvironments/info';
2626
import { ILanguageServerActivator } from '../types';
2727

2828
/**
@@ -39,7 +39,7 @@ export class NoLanguageServerExtensionActivator implements ILanguageServerActiva
3939
@named(BANNER_NAME_PROPOSE_LS)
4040
private proposePylancePopup: IPythonExtensionBanner
4141
) {}
42-
public async start(_resource: Resource, _interpreter?: PythonInterpreter): Promise<void> {
42+
public async start(_resource: Resource, _interpreter?: PythonEnvironment): Promise<void> {
4343
if (!isTestExecution()) {
4444
this.proposePylancePopup.showBanner().ignoreErrors();
4545
}

src/client/activation/refCountedLanguageServer.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323

2424
import { Resource } from '../common/types';
2525
import { noop } from '../common/utils/misc';
26-
import { PythonInterpreter } from '../pythonEnvironments/info';
26+
import { PythonEnvironment } from '../pythonEnvironments/info';
2727
import { ILanguageServerActivator, LanguageServerType } from './types';
2828

2929
export class RefCountedLanguageServer implements ILanguageServerActivator {
@@ -49,7 +49,7 @@ export class RefCountedLanguageServer implements ILanguageServerActivator {
4949
}
5050
}
5151

52-
public start(_resource: Resource, _interpreter: PythonInterpreter | undefined): Promise<void> {
52+
public start(_resource: Resource, _interpreter: PythonEnvironment | undefined): Promise<void> {
5353
throw new Error('Server should have already been started. Do not start the wrapper.');
5454
}
5555

0 commit comments

Comments
 (0)