Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove IS_WINDOWS constant in favor of PlatformService #21157

Merged
merged 1 commit into from
May 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/client/common/configSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import { ITestingSettings } from '../testing/configuration/types';
import { IWorkspaceService } from './application/types';
import { WorkspaceService } from './application/workspace';
import { DEFAULT_INTERPRETER_SETTING, isTestExecution } from './constants';
import { IS_WINDOWS } from './platform/constants';
import {
IAutoCompleteSettings,
IDefaultLanguageServer,
Expand All @@ -41,6 +40,7 @@ import {
import { debounceSync } from './utils/decorators';
import { SystemVariables } from './variables/systemVariables';
import { getOSType, OSType } from './utils/platform';
import { isWindows } from './platform/platformService';

const untildify = require('untildify');

Expand Down Expand Up @@ -654,7 +654,7 @@ function getPythonExecutable(pythonPath: string): string {

for (let executableName of KnownPythonExecutables) {
// Suffix with 'python' for linux and 'osx', and 'python.exe' for 'windows'.
if (IS_WINDOWS) {
if (isWindows()) {
executableName = `${executableName}.exe`;
if (isValidPythonPath(path.join(pythonPath, executableName))) {
return path.join(pythonPath, executableName);
Expand Down
7 changes: 0 additions & 7 deletions src/client/common/platform/constants.ts

This file was deleted.

7 changes: 6 additions & 1 deletion src/client/common/platform/platformService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,9 @@ export class PlatformService implements IPlatformService {
}
}

// eslint-disable-next-line class-methods-use-this
public get isWindows(): boolean {
return this.osType === OSType.Windows;
return isWindows();
}

public get isMac(): boolean {
Expand All @@ -72,3 +73,7 @@ export class PlatformService implements IPlatformService {
return getArchitecture() === Architecture.x64;
}
}

export function isWindows(): boolean {
return getOSType() === OSType.Windows;
}
4 changes: 2 additions & 2 deletions src/client/common/serviceRegistry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ import { ProductInstaller } from './installer/productInstaller';
import { InterpreterPathService } from './interpreterPathService';
import { BrowserService } from './net/browser';
import { PersistentStateFactory } from './persistentState';
import { IS_WINDOWS } from './platform/constants';
import { PathUtils } from './platform/pathUtils';
import { CurrentProcess } from './process/currentProcess';
import { ProcessLogger } from './process/logger';
Expand Down Expand Up @@ -91,9 +90,10 @@ import { Random } from './utils/random';
import { ContextKeyManager } from './application/contextKeyManager';
import { CreatePythonFileCommandHandler } from './application/commands/createPythonFile';
import { RequireJupyterPrompt } from '../jupyter/requireJupyterPrompt';
import { isWindows } from './platform/platformService';

export function registerTypes(serviceManager: IServiceManager): void {
serviceManager.addSingletonInstance<boolean>(IsWindows, IS_WINDOWS);
serviceManager.addSingletonInstance<boolean>(IsWindows, isWindows());

serviceManager.addSingleton<IActiveResourceService>(IActiveResourceService, ActiveResourceService);
serviceManager.addSingleton<IInterpreterPathService>(IInterpreterPathService, InterpreterPathService);
Expand Down
4 changes: 2 additions & 2 deletions src/client/linters/pydocstyle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import '../common/extensions';
import { Product } from '../common/types';
import { IServiceContainer } from '../ioc/types';
import { traceError } from '../logging';
import { IS_WINDOWS } from '../common/platform/constants';
import { BaseLinter } from './baseLinter';
import { ILintMessage, LintMessageSeverity } from './types';
import { isWindows } from '../common/platform/platformService';

export class PyDocStyle extends BaseLinter {
constructor(serviceContainer: IServiceContainer) {
Expand Down Expand Up @@ -47,7 +47,7 @@ export class PyDocStyle extends BaseLinter {
.filter((value, index) => index < maxLines && value.indexOf(':') >= 0)
.map((line) => {
// Windows will have a : after the drive letter (e.g. c:\).
if (IS_WINDOWS) {
if (isWindows()) {
return line.substring(line.indexOf(`${baseFileName}:`) + baseFileName.length + 1).trim();
}
return line.substring(line.indexOf(':') + 1).trim();
Expand Down
4 changes: 2 additions & 2 deletions src/test/common/configSettings.test.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import * as assert from 'assert';
import * as path from 'path';
import * as vscode from 'vscode';
import { IS_WINDOWS } from '../../client/common/platform/constants';
import { SystemVariables } from '../../client/common/variables/systemVariables';
import { getExtensionSettings } from '../extensionSettings';
import { initialize } from './../initialize';
import { isWindows } from '../../client/common/platform/platformService';

const workspaceRoot = path.join(__dirname, '..', '..', '..', 'src', 'test');

Expand All @@ -27,7 +27,7 @@ suite('Configuration Settings', () => {
}

const pythonSettingValue = (pythonSettings as any)[key] as string;
if (key.endsWith('Path') && IS_WINDOWS) {
if (key.endsWith('Path') && isWindows()) {
assert.strictEqual(
settingValue.toUpperCase(),
pythonSettingValue.toUpperCase(),
Expand Down
5 changes: 2 additions & 3 deletions src/test/serviceRegistry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ import { Container } from 'inversify';
import { anything, instance, mock, when } from 'ts-mockito';
import * as TypeMoq from 'typemoq';
import { Disposable, Memento } from 'vscode';
import { IS_WINDOWS } from '../client/common/platform/constants';
import { FileSystem } from '../client/common/platform/fileSystem';
import { PathUtils } from '../client/common/platform/pathUtils';
import { PlatformService } from '../client/common/platform/platformService';
import { PlatformService, isWindows } from '../client/common/platform/platformService';
import { RegistryImplementation } from '../client/common/platform/registry';
import { registerTypes as platformRegisterTypes } from '../client/common/platform/serviceRegistry';
import { IFileSystem, IPlatformService, IRegistry } from '../client/common/platform/types';
Expand Down Expand Up @@ -195,7 +194,7 @@ export class IocContainer {
}

public registerMockProcess(): void {
this.serviceManager.addSingletonInstance<boolean>(IsWindows, IS_WINDOWS);
this.serviceManager.addSingletonInstance<boolean>(IsWindows, isWindows());

this.serviceManager.addSingleton<IPathUtils>(IPathUtils, PathUtils);
this.serviceManager.addSingleton<ICurrentProcess>(ICurrentProcess, MockProcess);
Expand Down